/common-core

基于maven的spring4.3+mybatis3.4+swagger2.6的后台整合，用于快速构建后台接口项目

Primary LanguageJavaScriptMIT LicenseMIT

欢迎使用 Common-Core

基于maven的spring4.3+mybatis3.4+swagger2.6的后台整合，用于快速构建中小型API、RESTful API项目，该项目简单、快速、易扩展；使我们摆脱那些重复劳动，专注于业务代码的编写。

已完成功能

  • 增加权限统一拦截注解@Authentication
  • 增加方法性能统计注解@printRunTime
  • 增加简单的操作日志@OperationLog
  • 实现了用户登录日志
  • 实现了简单的权限系统
  • 生成entity类时自动提取数据库注释生成swagger文档
  • 实现了更漂亮的swagger-ui

快速开始

  • clone本项目，创建下面的数据库和表
  • 使用IDE导入本项目，使用maven方式导入项目
  • 配置jdbc.properties下面的数据库相关信息（如果你需要使用mybitis逆向插件，也需要配置generatorConfig.xml这个文件中的数据库信息）
  • 使用maven编译后，配置tomcat并部署
  • 启动tomcat,访问以下链接测试接口；
  • 访问http://localhost:8080/docs/index.html 查看swagger2生成的Api文档信息
  • 根据需求进行快速迭代开发

目前表单,详细信息在"/resources/archives"目录下

drop database common_core;

create database common_core;

use common_core;

create table user;

create table role;

create table permission;

create table role_permission_map;

create table user_role_map;
 
create table constant;

create table operation_log;

开发者建议

  • 表名，建议使用小写，多个单词使用下划线拼接
  • entity内成员变量建议与表字段数量对应,controller层使用application/json传参,参数可以考虑封装成DTO对象
  • 需要工具类的话建议先从common/utils中找，实在没有再造轮子或引入类库，尽量精简项目
  • 开发规范建议遵循阿里巴巴Java开发手册（最新版下载)
  • 建议在公司内部使用ShowDoc、Swagger2 、RAP等开源项目来编写、管理API文档
  • 页面常量信息建议放在constants表;如民族/地址/证件类型/性别等;
  • 所有项目文档放置在/resources/archives目录下
  • 建议所有DTO/BO放在相应service目录下/VO放在相应controller目录下

相关环境(推荐使用环境)

  • OS Microsoft Windows 10 Pro
  • Editor IntelliJ IDEA
  • Java 8
  • SpringMVC 4.3
  • Mybitis 3.4
  • Mysql 5.5.50
  • Maven 3.5.3
  • Git 2.14.1
  • Tomcat 7.0.85
  • Swagger 2.6.1
  • Restful interface

注意事项

  • 使用mybaitis-generator插件生成dao层时请先删除原来的文件,不然生的的内容会追加到源文件中,出现代码重复
  • 下载后如打不开swagger2文档，可能需要修改webapp/common-core-swagger-ui/config.js文件中得地址