此项目是在 https://github.com/tangzhimang/spring-boot-api-project-seed-master-self 以及 https://github.com/lihengming/spring-boot-api-project-seed 两位的基础上再次开发的
主要区别是此项目使用的是mybatis-plus
2019-04-29
1、简单整合spring-cloud使用eureka 项目目录:spring-cloud-learning-01
1、修改模板文件的包名问题,之后只在core包里ProjectConstant文件中的PROJECT_PATH与BASE_PACKAGE即可
Spring Boot API Project Seed 是一个基于Spring Boot & MyBatis-plus的种子项目,用于快速构建中小型API、RESTful API项目,该种子项目已经有过多个真实项目的实践,稳定、简单、快速,使我们摆脱那些重复劳动,专注于业务代码的编写,减少加班。下面是一个简单的使用演示,看如何基于本项目在短短几十秒钟内实现一套简单的API,并运行提供服务。
- 新: 更新项目所有依赖以及插件为最新版本
- 新: 集成Swagger2,同时自动生成简单的API测试说明,生成后访问地址为 http://localhost:8080/doc.html
- 统一响应结果封装及生成工具
- 统一异常处理
- 简单的接口签名认证
- 常用基础方法抽象封装
- 使用Druid Spring Boot Starter 集成Druid数据库连接池与监控
- 使用FastJsonHttpMessageConverter,提高JSON序列化速度
- 集成MyBatis-plus、分页插件,实现单表业务零SQL
- 提供代码生成器根据表名生成对应的Model、Mapper、MapperXML、Service、ServiceImpl、Controller等基础代码,其中Controller模板默认提供POST和RESTful两套,根据需求在
CodeGenerator.genController(tableName)
方法中自己选择,默认使用POST模板。代码模板可根据实际项目的需求来扩展,由于每个公司业务都不太一样,所以只提供了一些比较基础、通用的模板,主要是提供一个思路来减少重复代码的编写,我在实际项目的使用中,其实根据公司业务的抽象编写了大量的模板。另外,使用模板也有助于保持团队代码风格的统一 - 另有彩蛋,待你探索
- 克隆项目
- 对
test
包内的代码生成器CodeGenerator
进行配置,主要是JDBC,因为要根据表名来生成代码 - 如果只是想根据上面的演示来亲自试试的话可以使用
test/resources
目录下的demo-user.sql
,否则忽略该步 - 输入表名,运行
CodeGenerator.main()
方法,生成基础代码(可能需要刷新项目目录才会出来) - 根据业务在基础代码上进行扩展
- 对开发环境配置文件
application-dev.properties
进行配置,启动项目,Have Fun!
- 表名,建议使用小写,多个单词使用下划线拼接
- Model内成员变量建议与表字段数量对应,如需扩展成员变量(比如连表查询)建议创建DTO,否则需在扩展的成员变量上加
@Transient
注解,详情见通用Mapper插件文档说明 - 建议业务失败直接使用
ServiceException("message")
抛出,由统一异常处理器来封装业务失败的响应结果,比如throw new ServiceException("该手机号已被注册")
,会直接被封装为{"code":400,"message":"该手机号已被注册"}
返回,无需自己处理,尽情抛出 - 需要工具类的话建议先从
apache-commons-*
和guava
中找,实在没有再造轮子或引入类库,尽量精简项目 - 开发规范建议遵循阿里巴巴Java开发手册(最新版下载)
- 建议在公司内部使用ShowDoc、SpringFox-Swagger2 、RAP等开源项目来编写、管理API文档
- Spring Boot(查看Spring Boot学习&使用指南)
- MyBatis-plus(查看官方中文文档)
- Druid Spring Boot Starter(查看官方中文文档)
- swagger2 (查看官方文档)
- 其他略
无,纯粹开源分享。