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
轉載請註明出處,本文鏈接:https://www.uj5u.com/ruanti/513112.html
標籤:架構設計
下一篇:微服務架構 | 服務架構的演進
