Spring Boot Template(项目模板)

template-api
├── template-generator -- 代码生成器
│   └── Generator.java -- 运行此java生成代码
└── template-main -- 业务模块
    ├── base包 -- 常用父类
    │   ├── BaseEntity.java -- 包含一个id，所有Entity的父类
    │   ├── BaseLogEntity.java -- 继承BaseEntity，包含createBy,createTime,updateBy.updateTime四个日志相关的field
    │   ├── BaseService.java -- 继承自mybatis plus，包含常用的增删改查方法，具体使用参考mybatis plus文档
    │   └── BaseSvo.java -- svo为search vo简写，用于接收前端传递查询条件，包含pageNum和pageSize
    ├── config包 -- 项目配置
    │   ├── @Auth.java -- 此注解用于实现权限验证，添加到@Auth("permission")到controller方法鉴权
    │   ├── @NoAuth.java -- 默认所有的controller方法需要登录，使用这个注解排除登录，例如登录注册接口
    │   ├── MybatisPlusConfig.java -- mybatis plus配置文件，分页在此配置
    │   ├── MyMetaObjectHandler.java -- mybatis plus自动填充功能，可以自动插入createBy,createTime,updateBy.updateTime值
    │   ├── AuthAspect.java -- aop实现鉴权，和访问日志
    │   ├── MvcConfig.java -- spring mvc常用配置，包含跨域，时间格式化等等
    │   ├── ProjectParam.java -- 此项目的配置文件映射，自动读取application.properties中的私有配置
    │   └── Swagger2.java -- Swagger2配置文件
    ├── controller包 -- 使用restfull风格api
    │   ├── AccountController.java -- 账户相关，登录、修改密码等
    │   ├── DeptController.java -- 部门，树形结构的参考此模块，自动转换为前端通用数据结构
    │   ├── DeviceController.java -- 增删改查示例模块
    │   ├── PermissionController.java -- 权限
    │   ├── RoleController.java -- 角色
    │   ├── UserController.java -- 用户
    │   └── 角色 权限 用户模块因为 多对多中间表 问题，写了好多sql，其他模块使用通用方法基本都能解决
    ├── entity包 -- 和数据库对应，继承BaseEntity.java或者BaseLogEntity.java
    ├── exception包 -- 异常类
    │   ├── MyException.java -- 常见的异常，例如参数校验，是否存在等抛出此异常，前端httpstatus自动为400
    │   ├── NoAuthException.java -- 未登录访问接口抛出此异常，前端httpstatus自动为401
    │   └── UnauthorizedException.java -- 登录但是无具体权限抛出此异常，前端httpstatus自动为403
    ├── mapper包 -- mybatis mapper
    ├── service包 -- 服务类，继承BaseService.java
    ├── svo包 -- svo为search vo简写，用于接收前端传递查询条件，继承BaseSvo.java
    ├── util包 -- 工具类，包含BCrypt密码加密、树形结构转换、jwt token生成，日期工具，获取当前用户工具，json工具等
    └── vo包 -- 相当于dto包，集成字entity，用于传递entity中不包含的参数给前端

#进入项目目录
cd template-api

#打包(可在本地打包，提交jar后，到服务器运行docker命令）
mvn install

#进入Dockerfile所在文件夹
cd template-main

#docker打包镜像
docker build -t template-api:latest .

#启动docker容器,可使用-e SPRING_PROFILES_ACTIVE=${env}指定环境，不指定则默认为dev
docker run -itd --name template-api -e SPRING_PROFILES_ACTIVE=dev template-api:latest

#进入项目目录
cd template-api

#打包
mvn install

#linux 在jar所在目录执行
nohup java -jar template-api.jar --spring.profiles.active=dev >log.txt &

#windows 在jar所在目录执行
java -jar template-api.jar --spring.profiles.active=dev

#本项目成功时返回结果如下
{
  "name": "姓名",
  "deptName": "部门名称"
}
#失败时
{
  "name": "姓名",
  "deptName": "部门名称"
}
#而不是
{
  "error": 0,
  "msg": "success",
  "data": {
    "name": "姓名",
    "deptName": "部门名称"
  }
}