Spring Boot API Seed Project 是一个基于Spring Boot & MyBatis的种子项目,用于快速构建中小型API、RESTful API项目,该种子项目已经有过多个真实项目的实践,稳定、简单、快速,使我们摆脱那些重复劳动,专注于业务代码的编写,减少加班。下面是一个简单的使用演示,看如何基于本项目在短短几十秒钟内实现一套简单的API,并运行提供服务。
- 最佳实践的项目结构、配置文件、精简的POM(查看项目结构图)
- 统一响应结果封装及生成工具
- 统一异常处理
- 常用基础方法抽象封装
- 使用Druid Spring Boot Starter
- 使用FastJsonHttpMessageConverter,提高JSON序列化速度
- 集成MyBatis、PageHelper分页插件,实现单表业务零SQL
- 添加自定义mapper 生成方法
- 提供代码生成器根据表名生成对应的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!