spring boot api project seed

簡介

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模板。程式碼模板可根據實際專案的需求來擴展，由於每個公司業務都不太一樣，所以只提供了一些比較基礎、通用的模板，主要是提供一個思路來減少重複代碼的編寫，我在實際項目的使用中，其實是根據公司業務的抽象編寫了大量的模板。另外，使用模板也有助於保持團隊程式碼風格的統一
• 另有彩蛋，待你探索

快速開始

1. 克隆項目
2. 對test包內的程式碼產生器CodeGenerator進行配置，主要是JDBC，因為要根據表名來產生程式碼
3. 如果只是想根據上面的示範來親自試試的話可以使用test resources目錄下的demo-user.sql ，否則忽略該步
4. 輸入表名，運行CodeGenerator.main()方法，產生基礎程式碼（可能需要刷新專案目錄才會出來）
5. 根據業務在基礎程式碼上進行擴展
6. 對開發環境設定檔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（請參閱官方中文文件）
• MyBatisb通用Mapper外掛（查看官方中文文件）
• MyBatis PageHelper分頁外掛程式（請參閱官方中文文件）
• Druid Spring Boot Starter（查看官方中文文件）
• Fastjson（查看官方中文文件）
• 其他略

License

無，純粹開源分享，感謝大家Star & Fork 的支持。