QBasic快速开发框架

简介

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接口文档
  • 代码生成器,生成单表的增删改查全套代码

接入说明

  1. 后台管理站端口8000,管理员账号:admin/123456,测试账号:test/123456
  2. 后台管理站接口文档地址/docs,需要先登录
  3. 业务日志不需要写数据库的API,请在Controller方法上添加DbLogIgnore注解
  4. 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 系统异常,操作失败,需要客户端做容错处理
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 155,770评论 4 358
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,116评论 1 286
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,656评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,372评论 0 201
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,704评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,166评论 1 204
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,535评论 2 306
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,259评论 0 193
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,882评论 1 236
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,218评论 2 239
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,760评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,126评论 2 249
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,667评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,935评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,644评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,171评论 2 265
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,119评论 2 258

推荐阅读更多精彩内容

  • 以下文章转载自知乎,暗灭-京华九月秋近寒,浮沉半生影长单. 暗灭 京华九月秋近寒,浮沉半生影长单 10,850 人...
    ve追风_685b阅读 3,987评论 1 15
  • 转自:[http://blog.csdn.net/liu88010988/article/details/5154...
    hackywit阅读 5,921评论 0 26
  • 首先我要说明,下面的事是老人告诉我的,而且我也向一些当事人求证过,当然,如果你不相信,就当这是一个故事吧。 那天,...
    客子不穷阅读 331评论 2 2
  • 时间过得很快,2018年的第三个月结束了,总结一下吧!只有你不断总结,不断反省,你才有可能去改变。 一、工作方面:...
    G192王朝云阅读 223评论 0 1
  • 莫名,今天为朋友圈里大家为大学毕业十年聚会造势而莫名的感慨,十年前,我在干什么呢,在哪里呢。 十年前,我还在兰州,...
    小冻yy阅读 293评论 0 2