Github url

spring-boot-api-project-seed

by lihengming

:seedling::rocket:一个基于Spring Boot & MyBatis的种子项目,用于快速构建中小型API、RESTful API项目~

8.0K Stars 3.4K Forks Last release: almost 3 years ago (V1.3) 108 Commits 4 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

LicenceGitHub Release

简介

Spring Boot API Project Seed 是一个基于Spring Boot & MyBatis的种子项目,用于快速构建中小型API、RESTful API项目,该种子项目已经有过多个真实项目的实践,稳定、简单、快速,使我们摆脱那些重复劳动,专注于业务代码的编写,减少加班。下面是一个简单的使用演示,看如何基于本项目在短短几十秒钟内实现一套简单的API,并运行提供服务。

请选择超清

特征&提供

  • 最佳实践的项目结构、配置文件、精简的POM(查看项目结构图
  • 统一响应结果封装及生成工具
  • 统一异常处理
  • 简单的接口签名认证
  • 常用基础方法抽象封装
  • 使用Druid Spring Boot Starter 集成Druid数据库连接池与监控
  • 使用FastJsonHttpMessageConverter,提高JSON序列化速度
  • 集成MyBatis、通用Mapper插件、PageHelper分页插件,实现单表业务零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开发手册(最新版下载)
  • 建议在公司内部使用ShowDocSpringFox-Swagger2RAP等开源项目来编写、管理API文档   ## 技术选型&文档
  • Spring Boot(查看Spring Boot学习&使用指南
  • MyBatis(查看官方中文文档
  • MyBatisb通用Mapper插件(查看官方中文文档
  • MyBatis PageHelper分页插件(查看官方中文文档
  • Druid Spring Boot Starter(查看官方中文文档
  • Fastjson(查看官方中文文档
  • 其他略

License

无,纯粹开源分享,感谢大家 Star & Fork 的支持。

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.