AgileBoot 倉庫 後端地址:https://github.com/valarchie/AgileBoot-Back-End 技術棧:Springboot / Spring Security / MyBatis Plus JPA 無XML/ Druid / Redis / Hutool / J ...
AgileBoot
倉庫
後端地址:https://github.com/valarchie/AgileBoot-Back-End
技術棧:Springboot / Spring Security / MyBatis Plus JPA 無XML/ Druid / Redis / Hutool / JWT
前端地址:https://github.com/valarchie/AgileBoot-Front-End
技術棧:Vue3 + ElementUI plus + Vite
由來
AgileBoot這個項目的建立是因為閑暇時間想自己搗鼓一點小東西,於是當時網上找了很多快速開發腳手架。比如Ruoyi/Jeecg-boot/ElAdmin/renren等框架。
芋道也弄了一個Ruoyi-Pro的項目,但是功能一大堆,太重了,可能質量得不到保證。
最後選擇了Ruoyi框架作為自己開發一些小東西的腳手架。首先首先,非常感謝Ruoyi作者整理出這個項目。
但是當我把Ruoyi項目翻了一遍之後。發現項目的代碼水平和質量都..... emm... 有點不像一個專業後端人員開發出來的項目。
存在一些缺陷:
- 命名比較亂七八糟(很多很糟糕的命名,包括機翻英語亂用)
- 項目分包以及模塊比較亂
- 比較原始的Controller > Service > DAO的開發模式。過於面向過程。
- 一大堆自己造的輪子,並且沒有UT覆蓋。
- 大量邏輯嵌套在if else塊當中
- 值的前後不統一,比如有的地方1代表是,有的地方1代表否
- 很多很奇怪的代碼寫法(比如return result > 0 ? true:false.. 一言難盡)
於是乎我基於Ruoyi項目,整個進行了重構。
重構內容
設計:
- 將MyBatis遷移到Mybatis Plus(遷移工作非常耗時間)+ JPA的形式進行數據增刪改 + 無XML
- 遷移FastJson到Jackson(FastJson的坑就不多說了)
- 對資料庫的表進行重新優化設計
- 去除所謂的低代碼生成.....(這種級別的代碼生成其實意義不大,真正拿這個腳手架來開發的話,也用不上)
- 各個層的日誌進行切麵列印
- 前後端密碼加密傳輸
- 設計多級緩存體系 Map -> Guava > Redis. 不同場景使用不同級別的緩存。Redis緩存內嵌入本地緩存。
- 合理的分包: common(公共包) / infrastructure(基礎框架設施) / domain(業務邏輯) / orm(數據層) / admin(管理後臺) / api (外部API)
- Ruoyi的角色是多職位多角色的設計,但是作為小型快速開發腳手架,沒必要這樣設計,我改成單職位單角色。
- 統一註解攔截數據許可權
規範:
- 切分不同環境的啟動文件
- 統一設計異常類
- 統一設計錯誤碼並集中管理
- 統一系統內的變數並集中管理
- 統一返回模型
- 引入Google代碼格式化模板(Ruoyi的代碼格式很另類....)
- 後端代碼的命名基本都整改OK
- 前端代碼的命名也非常混亂,進行了整改
整改:
- 引入hutool包以及guava包去掉大量自己造的輪子(大量工作.....)
- 引入lombok去除大量getter setter代碼
- 調整日誌級別
- 字典類型數據完全用Enum進行代替
- 移除SQL註入的Filter,因為遷移到Mybatis Plus就不會有這個註入的問題
- XSS直接通過JSON攔截過濾。
- 替換掉很多Deprecated的類以及配置
優化:
- 優化非同步服務
- 優化Excel相關類的設計,採用hutool包成熟的輪子
- 許可權判斷使用緩存
- IP地址查詢引入離線包
- 引入多級緩存體系
還有很多整改的點一時想不起來了,很多細枝末節的改動,整改整個項目花了很多時間。基本上整個項目都重構了一遍。
項目的願景
想致力於打造一個真正能用在生產的小型開發腳手架,可用於外包或者公司內部的小項目。Ruoyi感覺有點像玩具項目。但是也很多人直接拿去用。
但是用著應該不是那麼省心。
本項目的主要目標是
- 安全性
- 代碼規範性
- 更面向對象(偽DDD)
- 小而美的理念(不會加一大堆功能...) 如果有非常常用的功能的話,可以討論加上
- 真正的生產型項目
項目操作手冊
前提:安裝好 MySQL / Redis / npm
後端項目:
- git clone https://github.com/valarchie/AgileBoot-Back-End
- IDEA引入項目
- 更改資料庫賬號
- 更改Redis賬號
- 更改IDEA啟動配置
- IDEA -> Run 即可
前端項目:
- git clone https://github.com/valarchie/AgileBoot-Front-End
- Vscode引入項目
- npm install
- npm run dev
訪問localhost即可
最後
本人水平一般能力有限。有錯誤或者代碼規範或者設計上的問題,懇請大家指出。歡迎大家提Issue, 提PR. 每周都會更新。
PS:前端方面是小白,有大佬來一起優化嗎~ 嘿嘿
交流群:1398880