优化文档
This commit is contained in:
@@ -87,12 +87,12 @@ graph TD
|
||||
|
||||
### 2.2 模块职责
|
||||
|
||||
| 模块 | 职责 |
|
||||
|-------------------------------|--------------------------------|
|
||||
| xtools-cloud | 父模块，管理子模块和公共属性配置 |
|
||||
| xtools-cloud-alibaba | Alibaba 微服务组件聚合模块 |
|
||||
| xtools-cloud-alibaba-nacos | Nacos 服务注册与发现、配置中心自动配置 |
|
||||
| xtools-cloud-alibaba-sentinel | Sentinel 流量控制与熔断降级自动配置 |
|
||||
| 模块 | 职责 |
|
||||
|-------------------------------|--------------------------------------------------------|
|
||||
| xtools-cloud | 父模块，管理子模块和公共属性配置 |
|
||||
| xtools-cloud-alibaba | Alibaba 微服务组件聚合模块 |
|
||||
| xtools-cloud-alibaba-nacos | Nacos 服务注册与发现、配置中心自动配置 |
|
||||
| xtools-cloud-alibaba-sentinel | Sentinel 流量控制与熔断降级自动配置 |
|
||||
| xtools-cloud-call | 微服务间 REST 调用封装，包含拦截器、日志追踪、负载均衡 |
|
||||
|
||||
### 2.3 包结构设计
|
||||
@@ -255,12 +255,12 @@ flowchart LR
|
||||
|
||||
**追踪字段说明**：
|
||||
|
||||
| 字段 | 说明 |
|
||||
|---------------|--------------------------|
|
||||
| 字段 | 说明 |
|
||||
|---------------|-----------------------------------------|
|
||||
| LOG_TRACK | Base64 编码的日志追踪信息，包含链路ID等 |
|
||||
| CLOUD | 标识当前请求为微服务间调用 |
|
||||
| UID | 用户ID（透传） |
|
||||
| AUTHORIZATION | 认证令牌（透传） |
|
||||
| CLOUD | 标识当前请求为微服务间调用 |
|
||||
| UID | 用户ID（透传） |
|
||||
| AUTHORIZATION | 认证令牌（透传） |
|
||||
|
||||
## 四、编码规范设计
|
||||
|
||||
@@ -339,44 +339,44 @@ flowchart LR
|
||||
|
||||
### 5.1 核心框架依赖
|
||||
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|---------------------------|------------|---------|
|
||||
| Spring Boot | 4.0.5 | 应用框架 |
|
||||
| Spring Framework | 7.0.6 | 核心框架 |
|
||||
| Spring Cloud | 2025.1.1 | 微服务框架 |
|
||||
| Spring Cloud Alibaba | 2025.1.0.0 | 微服务组件 |
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|---------------------------|------------|----------------|
|
||||
| Spring Boot | 4.0.5 | 应用框架 |
|
||||
| Spring Framework | 7.0.6 | 核心框架 |
|
||||
| Spring Cloud | 2025.1.1 | 微服务框架 |
|
||||
| Spring Cloud Alibaba | 2025.1.0.0 | 微服务组件 |
|
||||
| Spring Cloud LoadBalancer | 2025.1.1 | 客户端负载均衡 |
|
||||
|
||||
### 5.2 微服务组件依赖
|
||||
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|--------------|-------|--------------|
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|--------------|-------|--------------------------|
|
||||
| Nacos Client | 3.1.1 | 服务注册与发现、配置中心 |
|
||||
| Sentinel | 1.8.9 | 流量控制与熔断降级 |
|
||||
| Sentinel | 1.8.9 | 流量控制与熔断降级 |
|
||||
|
||||
### 5.3 xtools 内部框架依赖
|
||||
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|------------------|-------|---------------------------|
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|------------------|-------|------------------------------------|
|
||||
| xtools-boot-core | 5.0.0 | 核心工具模块（ModuleLoadUtils 等） |
|
||||
| xtools-boot-log | 5.0.0 | 日志模块（LogBus、LogTrack 等） |
|
||||
| xtools-core | 5.0.0 | 基础核心模块（枚举、常量等） |
|
||||
| xtools-boot-api | 5.0.0 | API 模块（Result、常量等） |
|
||||
| xtools-boot-log | 5.0.0 | 日志模块（LogBus、LogTrack 等） |
|
||||
| xtools-core | 5.0.0 | 基础核心模块（枚举、常量等） |
|
||||
| xtools-boot-api | 5.0.0 | API 模块（Result、常量等） |
|
||||
|
||||
### 5.4 工具库依赖（来自父POM管理）
|
||||
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|-----------|---------|-------------------------|
|
||||
| Lombok | 1.18.44 | 代码简化 |
|
||||
| MapStruct | 1.6.3 | 对象映射 |
|
||||
| FastJSON2 | 2.0.60 | JSON 处理 |
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|-----------|---------|-------------------------------|
|
||||
| Lombok | 1.18.44 | 代码简化 |
|
||||
| MapStruct | 1.6.3 | 对象映射 |
|
||||
| FastJSON2 | 2.0.60 | JSON 处理 |
|
||||
| Jackson | 2.21.2 | JSON 处理（Spring Boot 管理） |
|
||||
| JSpecify | - | 空值注解 |
|
||||
| JSpecify | - | 空值注解 |
|
||||
|
||||
### 5.5 Web 相关依赖
|
||||
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|---------------------|-------|----------------------|
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|---------------------|-------|--------------------------|
|
||||
| Jakarta Servlet API | 6.1.0 | Servlet 规范（provided） |
|
||||
|
||||
## 六、技术选型说明
|
||||
@@ -424,34 +424,30 @@ flowchart LR
|
||||
|
||||
### 6.6 其他重要依赖版本
|
||||
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|-----------------------------|------------------|-------------|
|
||||
| Spring Boot Admin | 4.0.3 | 应用监控 |
|
||||
| Druid | 1.2.28 | 数据库连接池 |
|
||||
| MyBatis Spring Boot Starter | 4.0.1 | MyBatis 集成 |
|
||||
| MyBatis-Plus | 3.5.16 | ORM 增强工具 |
|
||||
| Knife4j | 4.5.0 | API 文档增强 |
|
||||
| SpringDoc OpenAPI | 3.0.3 | OpenAPI 文档 |
|
||||
| Swagger Annotations | 2.2.48 | API 注解 |
|
||||
| XXL-Job | 3.4.0 | 分布式任务调度 |
|
||||
| Velocity | 2.4.1 | 模板引擎 |
|
||||
| Easy Captcha | 1.6.2 | 验证码生成 |
|
||||
| 依赖 | 版本 | 用途 |
|
||||
|-----------------------------|------------------|----------------|
|
||||
| Spring Boot Admin | 4.0.3 | 应用监控 |
|
||||
| Druid | 1.2.28 | 数据库连接池 |
|
||||
| MyBatis Spring Boot Starter | 4.0.1 | MyBatis 集成 |
|
||||
| MyBatis-Plus | 3.5.16 | ORM 增强工具 |
|
||||
| Knife4j | 4.5.0 | API 文档增强 |
|
||||
| SpringDoc OpenAPI | 3.0.3 | OpenAPI 文档 |
|
||||
| Swagger Annotations | 2.2.48 | API 注解 |
|
||||
| XXL-Job | 3.4.0 | 分布式任务调度 |
|
||||
| Velocity | 2.4.1 | 模板引擎 |
|
||||
| Easy Captcha | 1.6.2 | 验证码生成 |
|
||||
| BouncyCastle | 1.84 | 加密库 |
|
||||
| OSHI | 6.11.1 | 系统监控 |
|
||||
| Fesod Sheet | 2.0.1-incubating | Excel 处理 |
|
||||
| Caffeine | 3.2.3 | 本地缓存 |
|
||||
| Java JWT | 4.5.1 | JWT 令牌 |
|
||||
| OSHI | 6.11.1 | 系统监控 |
|
||||
| Fesod Sheet | 2.0.1-incubating | Excel 处理 |
|
||||
| Caffeine | 3.2.3 | 本地缓存 |
|
||||
| Java JWT | 4.5.1 | JWT 令牌 |
|
||||
| Elasticsearch Client | 9.2.6 | ES 客户端 |
|
||||
| Spring AMQP | 4.0.2 | RabbitMQ 集成 |
|
||||
| Netty | 4.2.12.Final | 网络框架 |
|
||||
| AspectJ | 1.9.25.1 | AOP 支持 |
|
||||
| Commons Lang3 | 3.19.0 | 通用工具 |
|
||||
| Spring AMQP | 4.0.2 | RabbitMQ 集成 |
|
||||
| Netty | 4.2.12.Final | 网络框架 |
|
||||
| AspectJ | 1.9.25.1 | AOP 支持 |
|
||||
| Commons Lang3 | 3.19.0 | 通用工具 |
|
||||
|
||||
---
|
||||
|
||||
**文档版本**：v1.0
|
||||
**编写日期**：2026-04-16
|
||||
**项目版本**：5.0.0
|
||||
**父POM版本**：xtools-parent-cloud:5.0.0
|
||||
**JDK版本**：25
|
||||
**文档版本**：v1.0 **编写日期**：2026-04-16 **项目版本**：5.0.0 **父POM版本**：xtools-parent-cloud:5.0.0 **JDK版本**：25
|
||||
**维护团队**：xujun.org
|
||||
|
||||
Reference in New Issue
Block a user