简介
QBasic快速开发框架，Q是Quick的缩写，QBasic就是快速基础之意。QBasic的开发初衷是为开发人员提供一款小而美，轻量而又灵活的项目脚手架。QBasic对目前主流的一些前后端框架做了整合，提供了一个软件项目必须要有的身份验证、权限校验、日志、缓存、全局异常处理、API接口文档等基础功能。来新项目了，开发人员不必再从头开发这些基础功能，直接从业务功能开始开发，减少了大量的重复性工作。
开发原则
- 编码规范
- 遵循阿里巴巴Java开发手册。
- 前后端职责分离
- 后端代码中没有任何HTML代码，视图层不包含任何后端业务逻辑代码。
- 前端视图层又做了职责分离，采用MVVM模式，将视图UI和业务逻辑分开。
- 轻量
- 数据库只有最基础的表和字段。
- 框架只实现了最基础的功能。
- 功能页面前端只引用了Vue，jQuery，Element UI框架。
- 代码简洁
- Controller层没有异常捕获，权限验证，请求参数检验，业务日志代码，统一交给Aop切面处理，Controller层只有业务逻辑代码。
- 使用Java8新特性lambda表达式，stream流。
- 性能优化
- 能在应用服务器做的事，不交给数据库做；能在客户端做的事，不交给应用服务器做。
- 热点数据做缓存，如用户身份信息，权限列表做了缓存。
- Bootstrap模板AdminLTE的CSS和JS代码做了深度精简，只保留了主页框架页面的部分，加快主页渲染速度。
技术选型
1、后端
- Java8：lambda表达式、stream流、optional可空类型等新特性。
- Spring Boot：内嵌式tomcat部署方便；约定大于配置，再不用繁琐的XML配置。
- Spring+Spring MVC+Mybatis：标准的web应用三件套。
- Apache Shiro：安全框架，处理身份认证，授权，会话管理等。
- Thymeleaf：Spring官方推荐的模板引擎。
- Druid：阿里巴巴开源的高性能数据库连接池。
- Ehcache：缓存框架。
- slf4j+logback：日志框架。
- Apache Commons Lang：常用工具包。
- fastJSON：JSON处理工具包。
- Joda-Time：日期处理工具包。
- Swagger：API接口文档自动生成。
2、前端
- Vue+jQuery：基础JS框架。
- Element UI：饿了吗前端团队开源的Vue组件库，CSS苦手的福音。
- Bootstrap：UI框架。
- AdminLTE：Bootstrap模板。
- Font Awesome：图标字体。
- CKEditor4：功能强大的富文本编辑器。
- moment：前端日期处理工具包。
后台管理功能概述
- 用户登录/登出
- 权限校验
- 用户权限控制到按钮级别
- 系统管理
- 用户管理
- 角色管理
- 资源管理
- 机构管理
- 数据字典
- 系统配置
- 定时任务
- 数据集管理
- 运维工具
- 数据查询
- 业务日志
- 错误日志
- 应用监控
- 内容发布
- 内容管理
- 栏目管理
- 多级审核
- 全文检索
- 文件存储服务
- 本地磁盘
- 阿里云OSS服务
- 工作流引擎
- 流程分类
- 流程定义
- 流程配置
- 示例代码库
- 导出Word文档
- 导出Excel文档
- 全局异常处理
- 全局日志记录
- 缓存
- 用户身份信息
- 用户权限信息
- Controller层用户请求、响应参数封装
- 用户请求参数校验
- 前端、后端请求参数Double Check
- 主页框架页
- 菜单树
- 收缩侧边栏
- 面包屑导航
- 内容页高度自适应
- 错误页面
- 400页面
- 401页面
- 404页面
- 500页面
- 检查当前用户会话是否过期
- 避免出现点击菜单链接内容页嵌套登录页的情况
- 公共HTML模板页
- API接口文档
- 代码生成器，生成单表的增删改查全套代码
接入说明
- 后台管理站端口8000，管理员账号：admin/123456，测试账号：test/123456
- 后台管理站接口文档地址/docs，需要先登录
- 业务日志不需要写数据库的API，请在Controller方法上添加DbLogIgnore注解
- RESTFUL API接口规范
请求参数示例
@ApiModel
public class EditParamReq extends BaseRequest {
@NotNull(message = "pId不能为空")
@Min(value = 1, message = "pId必须大于0")
private Integer pId;
@ApiModelProperty("字典类型")
@NotEmpty(message = "字典类型不能为空")
@Length(max = 50, message = "字典类型不能超过50个字符")
private String pType;
@ApiModelProperty("字典key")
@NotEmpty(message = "字典key不能为空")
@Length(max = 50, message = "字典key不能超过50个字符")
private String pKey;
@ApiModelProperty("字典value")
@NotEmpty(message = "字典value不能为空")
@Length(max = 50, message = "字典value不能超过50个字符")
private String pValue;
@ApiModelProperty("字典排序")
@NotNull(message = "字典排序不能为空")
@Range(min = 0, message = "字典排序不能小于0")
private Integer sort;
@ApiModelProperty("备注")
private String remark;
public Integer getpId() {
return pId;
}
public void setpId(Integer pId) {
this.pId = pId;
}
public String getpType() {
return pType;
}
public void setpType(String pType) {
this.pType = pType;
}
public String getpKey() {
return pKey;
}
public void setpKey(String pKey) {
this.pKey = pKey;
}
public String getpValue() {
return pValue;
}
public void setpValue(String pValue) {
this.pValue = pValue;
}
public Integer getSort() {
return sort;
}
public void setSort(Integer sort) {
this.sort = sort;
}
public String getRemark() {
return remark;
}
public void setRemark(String remark) {
this.remark = remark;
}
}
返回示例
{
"status": 200,
"msg":"成功",
"result": {
...
}
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| status | int | 响应状态码 |
| msg | String | 响应提示信息 |
| result | Object | 响应结果 |
status响应状态码说明
| 状态码 | 说明 |
|---|---|
| 200 | 请求成功 |
| 400 | 接口请求参数不合法，比如手机号不合法 |
| 401 | 身份校验失败 |
| 404 | 服务器找不到请求的API |
| 500 | 系统异常，操作失败，需要客户端做容错处理 |
网友评论