ContiNew/continew-starter
1
1
Fork 0
mirror of https://github.com/continew-org/continew-starter.git synced 2025-09-09 19:03:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 更新 README 文档中的模块结构内容

Browse Source
This commit is contained in:
Charles7c
2024-09-07 12:15:18 +08:00
parent 2388d32363
commit f3f57b8a5e
1 changed files with 47 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
README.md
View File

@@ -72,6 +72,11 @@ ContiNew Starter 就是将脚手架项目中的通用基础配置进行了封装
第一种方式：如您使用的是 Spring Boot Parent 的方式，则替换 Spring Boot Parent 为 ContiNew Starter 第一种方式：如您使用的是 Spring Boot Parent 的方式，则替换 Spring Boot Parent 为 ContiNew Starter
> 最新稳定版（latest-version）
<a href="https://central.sonatype.com/search?q=continew-starter" target="_blank" rel="noopener" style="display: inline-block;">
<img src="https://img.shields.io/maven-central/v/top.continew/continew-starter.svg?label=Maven%20Central&logo=sonatype&logoColor=FFF" alt="Release" />
</a>
```xml ```xml
<parent> <parent>
<groupId>top.continew</groupId> <groupId>top.continew</groupId>
@@ -137,100 +142,48 @@ continew-starter.web:
## 模块结构 ## 模块结构
### 核心模块 ```
continew-starter
| 模块名称 | 模块说明 | 依赖版本 | ├─ continew-starter-core（核心模块：包含线程池等自动配置）
| --------------------- | ------------------------------------ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ├─ continew-starter-json（JSON 模块）
| continew-starter-core | 核心模块：包含线程池、项目等自动配置 | <a href="https://spring.io/projects/spring-boot" target="_blank">Spring Boot</a>：3.1.11<br /><a href="https://www.hutool.cn/" target="_blank">Hutool</a>：5.8.29<br />mica-ip2region：3.2.6 | │ └─ continew-starter-json-jackson
├─ continew-starter-api-doc（接口文档模块：Spring Doc + Knife4j）
### JSON模块 ├─ continew-starter-web（Web 开发模块：包含跨域、全局异常+响应、链路追踪等自动配置）
├─ continew-starter-auth（认证模块）
| 模块名称 | 模块说明 | │ ├─ continew-starter-auth-satoken（国产轻量认证鉴权）
| ----------------------------- | -------------------- | │ └─ continew-starter-auth-justauth（第三方登录）
| continew-starter-json-jackson | Jackson 序列化等配置 | ├─ continew-starter-data（数据访问模块）
│ ├─ continew-starter-data-core（通用模块）
### 接口文档 │ ├─ continew-starter-data-mp（MyBatis Plus）
│ └─ continew-starter-data-mf（MyBatis Flex）
| 模块名称 | 模块说明 | ├─ continew-starter-cache（缓存模块）
| ------------------------ | ---------------- | │ ├─ continew-starter-cache-redisson（Redisson）
| continew-starter-api-doc | Knife4j 自动配置 | │ ├─ continew-starter-cache-jetcache（JetCache 多级缓存）
│ └─ continew-starter-cache-springcache（Spring 缓存）
### 安全模块 ├─ continew-starter-security（安全模块）
│ ├─ continew-starter-security-crypto（加密：字段加解密）
| 模块名称 | 模块说明 | │ ├─ continew-starter-security-mask（脱敏：JSON 数据脱敏）
| ---------------------------------- | ----------------- | │ ├─ continew-starter-security-limiter（限流）
| continew-starter-security-password | 密码编码器 | │ └─ continew-starter-security-password（密码编码器）
| continew-starter-security-mask | JSON 脱敏 | ├─ continew-starter-captcha（验证码模块）
| continew-starter-security-crypto | 数据库字段加/解密 | │ ├─ continew-starter-captcha-graphic（静态验证码）
| continew-starter-security-limiter | 限流器 | │ └─ continew-starter-captcha-behavior（动态验证码）
├─ continew-starter-messaging（消息模块）
### Web模块 │ ├─ continew-starter-messaging-mail（邮件）
│ └─ continew-starter-messaging-websocket（WebSocket）
| 模块名称 | 模块说明 | ├─ continew-starter-log（日志模块）
| -------------------- | ---------------------------------- | │ ├─ continew-starter-log-core（通用模块）
| continew-starter-web | 跨域、全局异常、错误处理等自动配置 | │ └─ continew-starter-log-interceptor（拦截器版（Spring Boot Actuator HttpTrace 增强版））
├─ continew-starter-file（文件处理模块）
### 日志模块 │ └─ continew-starter-file-excel（Easy Excel）
├─ continew-starter-storage（存储模块）
| 模块名称 | 模块说明 | │ └─ continew-starter-storage-local（本地存储）
|----------------------------------| ----------------------------------------- | └─ continew-starter-extension（扩展模块）
| continew-starter-log-core | 日志核心模块 | └─ continew-starter-extension-crud（CRUD 模块）
| continew-starter-log-interceptor | 拦截器版（Spring Boot Actuator HttpTrace 增强版） | ├─ continew-starter-extension-crud-core（通用模块）
├─ continew-starter-extension-crud-mp（MyBatis Plus）
### 存储模块 └─ continew-starter-extension-crud-mf（MyBatis Flex）
```
| 模块名称 | 模块说明 |
| ------------------------------ | -------- |
| continew-starter-storage-local | 本地存储 |
### 文件处理模块
| 模块名称 | 模块说明 |
| --------------------------- | -------------- |
| continew-starter-file-excel | Excel 相关配置 |
### 验证码模块
| 模块名称 | 模块说明 |
| --------------------------------- | ---------- |
| continew-starter-captcha-graphic | 图形验证码 |
| continew-starter-captcha-behavior | 行为验证码 |
### 缓存模块
| 模块名称 | 模块说明 |
| ---------------------------------- | --------------------- |
| continew-starter-cache-redisson | Redisson 自动配置 |
| continew-starter-cache-springcache | Spring Cache 自动配置 |
| continew-starter-cache-jetcache | JetCache 自动配置 |
### 数据访问模块
| 模块名称 | 模块说明 |
|----------------------------| --------------------- |
| continew-starter-data-core | 数据访问核心模块 |
| continew-starter-data-mp | MyBatis Plus 自动配置 |
| continew-starter-data-mf | MyBatis Flex 自动配置 |
### 认证模块
| 模块名称 | 模块说明 |
| ------------------------------ | ----------------- |
| continew-starter-auth-satoken | SaToken 自动配置 |
| continew-starter-auth-justauth | JustAuth 自动配置 |
### 消息模块
| 模块名称 | 模块说明 |
| ------------------------------------ | --------- |
| continew-starter-messaging-mail | 邮件 |
| continew-starter-messaging-websocket | WebSocket |
### 扩展模块
| 模块名称 | 模块说明 |
| ------------------------------- | --------------------------------------------- |
| continew-starter-extension-crud | 扩展模块：BaseController 自定义 CRUD API 封装 |
## 贡献代码 ## 贡献代码