一個基於SpringBoot封裝的基礎庫

介紹

yue-library 是一個基於 SpringBoot 封裝的基礎庫，內置豐富的 JDK 工具，並且自動裝配了一系列的基礎 Bean，不僅如此，還可以用於快速構建 SpringCloud 項目，讓微服務變得更簡單。

工程結構

. yue-library
├── yue-library 基礎庫
│ ├── yue-library-dependencies 父pom
│ ├── yue-library-base 基礎庫提供了豐富的Java工具包，同時也自動裝配了一系列基礎Bean等
│ ├── yue-library-data-jdbc 基於SpringJDBC進行二次封裝，擁有著強大性能的同時又不失簡單、靈活等
│ ├── yue-library-data-redis 基於SpringRedis進行二次封裝，更簡單靈活，提供全局token與登錄相關特性等
│ ├── yue-library-cloud-oss
│ ├── yue-library-cloud-sms
│ └── yue-library-pay
├── yue-library-samples 基礎庫示例
│ ├── yue-library-template
│ └── yue-library-demo
└── yue

快速使用

maven項目，在pom.xml文件中添加如下一段代碼，並將${version}替換為對應版本號：

 <parent>
 <groupId>ai.ylyue</groupId>
 <artifactId>yue-library-dependencies</artifactId>
 <version>${version}</version>
 </parent>

隨後引入所需要的模塊

 <dependencies>
 <dependency>
 <groupId>ai.ylyue</groupId>
 <artifactId>yue-library-base</artifactId>
 </dependency>
 ...
 </dependencies>

yue-library 的版本命名方式，採用 SpringCloud 版本名作為前綴，然後以 .SR1、.SR2、.SR3...這種形式，目的是為了方便區分基礎依賴版本。

同時所有模塊皆依賴於基礎庫，若需要引入除基礎庫之外的模塊（如：data-jdbc、data-redis），可以不用引入此模塊。

更多細節，請查看中文文檔

模塊說明

yue-library-base（必備）

yue-library-base提供了豐富的 Java 工具包，它能夠幫助我們簡化每一行代碼（集成 Hutool 工具包）。

同時也自動裝配了一系列基礎 Bean，可在 application.yml 文件中配置關閉，所有配置項皆是以yue.*開頭，如：yue.cors.allow=false代表不允許跨域。

• 豐富的 Java 基礎工具類，對文件、流、加密解密、轉碼、正則、線程、XML 等 JDK 方法進行封裝
• ResultHttp 最外層響應對象，更適應 Restful 風格 API
• 默認開啟熱加載、熱部署、支持跨域，一鍵解決聯調問題
• 基於validator擴展 IPO 增強校驗註解，更適合國內校驗場景。（如：手機號、身份證號碼）
• 全局統一異常處理基類，結合Result對象，定位異常更輕鬆，前端顯示更貼切（可以直接繼承使用）

更多詳細介紹，請查看中文文檔

yue-library-data-jdbc（強烈推薦）

data-jdbc 庫基於 SpringJDBC 進行二次封裝，擁有著強大性能的同時又不失簡單、靈活。特性如下：

• 比 SpringJDBC 更方便好用、比 SpringJPA 更簡單靈活
• 無侵入：data-jdbc 在 SpringJDBC 的基礎上進行擴展，只做增強不做改變，簡化CRUD操作
• 依賴管理：引入即可啟動項目，關聯 druid 實現 SQL 全監控
• 預防 Sql 注入：內置 Sql 注入剝離器，有效預防 Sql 注入攻擊
• 損耗小：原生級 CURD 操作，性能基本無損耗，直接面向對象操作，同時還有大量經過 SQL 優化處理的 CRUD方法
• 通用 CRUD 操作：內置通用 DAO，通過繼承方式即可實現單表大部分 CRUD 操作
• 更科學的分頁：分頁參數自動解析，寫分頁等同於寫基本 List 查詢。更有優化型分頁 SQL 檢查
• 內置性能分析插件：可輸出 Sql 語句以及其執行時間，建議開發測試時啟用該功能，能有效解決慢查詢
• 類型強化：支持原生級 SQL 查詢，並強化原生查詢結果，簡單便捷 + 可維護組合（支持全 JSON 或全 DO）
• 查詢校驗：CRUD 預期值判斷
• 全局異常處理：CRUD 操作相關異常統一處理，定位更精準，提示更優化，實現全局 Restful 風格

更多詳細介紹，請查看中文文檔

yue-library-data-redis（推薦）

data-redis 庫基於 SpringRedis 進行二次封裝，更簡單靈活，提供全局 token 與登錄等特性：

• 簡化使用並擁有 Redis 原生常用命令所對應的方法
• 保留 SpringRedis 所有常用特性：分佈式緩存
• 提供分佈式 token、分佈式鎖
• 封裝大量第三方登錄特性，使登錄更簡單易於維護
• 封裝常用的登錄判斷操作與 redis-token 解析

更多詳細介紹，請查看中文文檔

社區

在 Gitter 的社區裡可以找到 yue-library 的用戶和開發者團隊。

參與貢獻

歡迎各路好漢一起來參與完善 yue-library，我們期待你的 PR！

• 貢獻代碼：代碼地址 yue-library ，歡迎提交 Issue 或者 Pull Requests

• Fork 本倉庫並從master或某個版本創建你的分支
• 如果你添加的代碼需要測試，請添加測試，確保單元測試通過
• 如果你修改了 API，請更新文檔
• 確保代碼風格一致
• 提交代碼
• 新建 Pull Request
• 維護文檔：文檔地址 yue-library-doc ，歡迎參與翻譯和修訂

碼雲地址：https://gitee.com/yl-yue/yue-library

中文文檔：https://ylyue.cn/#/