Browse Source
add the complete project package readme document that includes system environment, module structure, third-party dependencies, database, cache, middleware, deployment and other configuration detailszhc
1 changed files with 311 additions and 0 deletions
@ -0,0 +1,311 @@ |
|||||
|
# 项目包版本与系统配置信息 |
||||
|
|
||||
|
> 项目名称: data-center-business (data-center-business) |
||||
|
> 最后更新: 2026-06-24 |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 1. 系统环境 (OS / Runtime) |
||||
|
|
||||
|
| 组件 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| Java | 17 | `.java-version` 指定 | |
||||
|
| Maven | 3.x (系统默认) | 多模块 Maven 项目 | |
||||
|
| Spring Boot | 3.5.13 | parent POM `spring-boot-starter-parent` | |
||||
|
| 打包方式 | pom / jar | 多模块聚合项目 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 2. 项目模块结构 |
||||
|
|
||||
|
| 模块 | 说明 | |
||||
|
|------|------| |
||||
|
| `data-center-business` (parent) | 父 POM，聚合所有子模块 | |
||||
|
| `data-center-business-util` | 工具模块 | |
||||
|
| `data-center-business-common` | 公共模块 | |
||||
|
| `data-center-business-model` | 数据模型模块 | |
||||
|
| `data-center-business-dao` | 数据访问层模块 | |
||||
|
| `data-center-business-service` | 业务逻辑层模块 | |
||||
|
| `data-center-business-controller` | Web 控制器层模块 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 3. 核心框架 (Framework) |
||||
|
|
||||
|
### 3.1 Spring 生态 |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| spring-boot-starter | 3.5.13 (managed) | Spring Boot 基础启动器 | |
||||
|
| spring-boot-starter-web | 3.5.13 (managed) | Web 支持（排除默认 Tomcat 和 Logging） | |
||||
|
| spring-boot-starter-websocket | 3.5.13 (managed) | WebSocket 支持 | |
||||
|
| spring-boot-starter-integration | 3.5.13 (managed) | Spring Integration 支持 | |
||||
|
| spring-boot-starter-data-redis | 3.5.13 (managed) | Redis 数据访问 | |
||||
|
| spring-boot-starter-security | 3.5.13 (managed) | Spring Security 支持 | |
||||
|
| spring-boot-starter-test | 3.5.13 (managed) | 测试支持 | |
||||
|
| spring-integration-mqtt | 6.5.3 | MQTT 集成 | |
||||
|
| spring-security-oauth2-authorization-server | 1.5.3 | OAuth2 授权服务器 | |
||||
|
|
||||
|
### 3.2 Tomcat (Web 容器) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| tomcat-embed-core | 10.1.54 | 嵌入式 Tomcat（排除默认后手动引入） | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 4. 数据库 & ORM (Database / Persistence) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| mysql-connector-j | 9.5.0 | MySQL JDBC 驱动 | |
||||
|
| mybatis-spring-boot-starter | 3.0.4 | MyBatis + Spring Boot 整合 | |
||||
|
| mybatis-generator-maven-plugin | 1.3.5 | MyBatis 代码生成器插件 | |
||||
|
| mybatis-generator-core | 1.3.5 | MyBatis 代码生成器核心 | |
||||
|
| pagehelper-spring-boot-starter | 1.4.7 | MyBatis 分页插件 | |
||||
|
| druid | 1.1.3 | Alibaba Druid 数据库连接池 | |
||||
|
| flyway-core | 11.4.1 | 数据库迁移 | |
||||
|
| flyway-mysql | 11.4.1 | Flyway MySQL 方言 | |
||||
|
|
||||
|
### 4.1 数据源配置 |
||||
|
|
||||
|
| 配置项 | 值 | |
||||
|
|--------|-----| |
||||
|
| 数据库类型 | MySQL (Aliyun RDS) | |
||||
|
| 默认数据库 | `data_center_aeon_admin` | |
||||
|
| 连接池 | Druid (type) / HikariCP (备用) | |
||||
|
| 驱动类 | `com.mysql.jdbc.Driver` / `com.mysql.cj.jdbc.Driver` | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 5. 缓存 (Cache) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| lettuce-core | 6.8.1.RELEASE | Redis 客户端 (Lettuce) | |
||||
|
| jedis | 5.0.2 | Redis 客户端 (Jedis，备用) | |
||||
|
| commons-pool2 | (Spring Boot managed) | 连接池 | |
||||
|
|
||||
|
### 5.1 Redis 配置 |
||||
|
|
||||
|
| 配置项 | 值 | |
||||
|
|--------|-----| |
||||
|
| 模式 | standalone (支持 cluster / sentinel) | |
||||
|
| 默认端口 | 6379 | |
||||
|
| 数据库索引 | 0 | |
||||
|
| 连接池最大连接数 | 8 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 6. 消息 & 集成 (Messaging / Integration) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| org.eclipse.paho.client.mqttv3 | 1.2.5 | MQTT 客户端 | |
||||
|
| spring-integration-mqtt | 6.5.3 | MQTT 集成 | |
||||
|
| okhttp | 4.12.0 | OkHttp HTTP 客户端 | |
||||
|
|
||||
|
### 6.1 EMQX 配置 |
||||
|
|
||||
|
| 配置项 | 值 | |
||||
|
|--------|-----| |
||||
|
| API Base URL | `http://49.235.129.192:18083` | |
||||
|
| 用途 | MQTT Broker 管理 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 7. 云服务 (Cloud Services - AWS) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| aws-java-sdk-dynamodb | 1.12.782 | DynamoDB SDK | |
||||
|
| aws-java-sdk-athena | 1.12.782 | Athena SDK | |
||||
|
| software.amazon.awssdk:s3 | 2.20.113 (BOM) | S3 SDK (v2) | |
||||
|
| AWS SDK BOM | 2.20.113 | AWS SDK 版本管理 | |
||||
|
|
||||
|
### 7.1 AWS 服务配置 |
||||
|
|
||||
|
| 服务 | 用途 | |
||||
|
|------|------| |
||||
|
| S3 | 文件存储 (bucket: `tokyo-build-databucket-...`) | |
||||
|
| Athena | 数据查询 (database: `tokyotatemoenergydb`) | |
||||
|
| DynamoDB | NoSQL 数据库 | |
||||
|
| ECR | Docker 镜像仓库 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 8. 序列化 & JSON |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| jackson-core | 2.21.2 | Jackson 核心 | |
||||
|
| jackson-databind | 2.21.2 | Jackson 数据绑定 | |
||||
|
| jackson-annotations | 2.21 | Jackson 注解 | |
||||
|
| fastjson | 2.0.7.graal | Alibaba FastJSON | |
||||
|
| gson | 2.9.0 | Google Gson | |
||||
|
| json-path | 2.9.0 | JSONPath 解析 | |
||||
|
| json-smart | 2.5.2 | JSON 解析（json-path 依赖） | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 9. 日志 (Logging) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| log4j-core | 2.25.4 | Log4j 核心 | |
||||
|
| log4j-api | 2.25.4 | Log4j API | |
||||
|
| logback-classic | 1.5.21 | Logback 实现 | |
||||
|
| logback-core | 1.5.21 | Logback 核心 | |
||||
|
|
||||
|
### 9.1 日志配置 |
||||
|
|
||||
|
| 配置项 | 值 | |
||||
|
|--------|-----| |
||||
|
| 日志框架 | Logback (配置: `logback-boot.xml`) | |
||||
|
| 日志级别 | DEBUG (可配置) | |
||||
|
| 最大历史 | 30 天 | |
||||
|
| 最大文件大小 | 100MB | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 10. Excel / 文档处理 (Office / Document) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| easyexcel | 4.0.3 | Alibaba EasyExcel | |
||||
|
| poi | 5.5.0 | Apache POI 核心 | |
||||
|
| poi-ooxml | 5.5.0 | Apache POI OOXML | |
||||
|
| poi-ooxml-lite | 5.5.0 | Apache POI OOXML Lite | |
||||
|
| xmlbeans | 5.2.0 | XML Beans (POI 依赖) | |
||||
|
| pdfbox | 2.0.24 | Apache PDFBox | |
||||
|
| fontbox | 2.0.24 | Apache FontBox | |
||||
|
| opencsv | 5.12.0 | CSV 解析 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 11. Apache Commons 工具库 |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| commons-lang3 | 3.20.0 | 语言增强工具 | |
||||
|
| commons-compress | 1.28.0 | 压缩工具 | |
||||
|
| commons-io | 2.18.0 | IO 工具 | |
||||
|
| commons-text | 1.13.0 | 文本处理工具 | |
||||
|
| commons-collections | 3.2.2 | 集合工具 | |
||||
|
| commons-pool2 | (Spring Boot managed) | 对象池 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 12. HTTP 客户端 |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| httpclient5 | 5.5.1 | Apache HttpClient 5 | |
||||
|
| httpcore5 | 5.3.6 | Apache HttpCore 5 | |
||||
|
| okhttp | 4.12.0 | Square OkHttp | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 13. 安全 & JWT (Security / Authentication) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| spring-boot-starter-security | 3.5.13 (managed) | Spring Security | |
||||
|
| spring-security-oauth2-authorization-server | 1.5.3 | OAuth2 授权服务器 | |
||||
|
| nimbus-jose-jwt | 10.6 | JWT 处理 | |
||||
|
| bcpkix-jdk18on | 1.80 | Bouncy Castle 加密库 | |
||||
|
| encoder | 1.3.1 | OWASP 编码器 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 14. API 文档 |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| springdoc-openapi-starter-webmvc-ui | 2.8.14 | SpringDoc OpenAPI 3 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 15. 验证 (Validation) |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| hibernate-validator | 6.1.0.Final | Hibernate Validator | |
||||
|
| hibernate-validator-cdi | 6.1.0.Final | Hibernate Validator CDI | |
||||
|
| jakarta.el-api | 6.0.1 | Jakarta EL API | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 16. 其他依赖 |
||||
|
|
||||
|
| 依赖 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| guava | 33.4.5-jre | Google Guava 工具库 | |
||||
|
| kotlin-stdlib | 2.2.21 | Kotlin 标准库 (OkHttp 依赖) | |
||||
|
| hutool-captcha | 5.8.41 | Hutool 验证码 | |
||||
|
| dom4j | 2.1.3 | XML 解析 | |
||||
|
| mail (javax.mail) | 1.5.0-b01 | JavaMail | |
||||
|
| lombok | (Spring Boot managed) | Lombok | |
||||
|
| netty-bom | 4.2.12.Final | Netty BOM 版本管理 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 17. 构建插件 (Build Plugins) |
||||
|
|
||||
|
| 插件 | 版本 | 说明 | |
||||
|
|------|------|------| |
||||
|
| maven-jar-plugin | (default) | JAR 打包 | |
||||
|
| maven-dependency-plugin | (default) | 依赖拷贝 (lib 分离) | |
||||
|
| maven-resources-plugin | (default) | 资源处理 | |
||||
|
| maven-assembly-plugin | (default) | ZIP 打包 | |
||||
|
| maven-surefire-plugin | (default) | 测试执行 | |
||||
|
| jib-maven-plugin | 3.4.5 | Docker 镜像构建 (Google Jib) | |
||||
|
| maven-antrun-plugin | 3.0.0 | Ant 任务 (AWS ECR 推送) | |
||||
|
| mybatis-generator-maven-plugin | 1.3.5 | MyBatis 代码生成 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 18. 中间件 & 外部服务 (Middleware / External Services) |
||||
|
|
||||
|
| 服务 | 版本 / 类型 | 用途 | |
||||
|
|------|-------------|------| |
||||
|
| MySQL | Aliyun RDS | 主数据库 | |
||||
|
| Redis | Aliyun Redis (standalone/cluster/sentinel) | 缓存 | |
||||
|
| EMQX | MQTT Broker | IoT 消息 | |
||||
|
| AWS S3 | 对象存储 | 文件存储 | |
||||
|
| AWS Athena | 查询服务 | 大数据查询 | |
||||
|
| AWS DynamoDB | NoSQL | 数据存储 | |
||||
|
| AWS ECR | 容器镜像仓库 | Docker 镜像 | |
||||
|
| Salesforce | CRM | 客户管理集成 | |
||||
|
| CloudDog API | 外部 API | 告警通知 (Slack) | |
||||
|
| OIDC / Cognito | 认证服务 | BIM Viewer 认证 | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 19. 网络配置 (Network) |
||||
|
|
||||
|
| 配置项 | 值 | |
||||
|
|--------|-----| |
||||
|
| 服务端口 | 20008 | |
||||
|
| 上下文路径 | `/api` | |
||||
|
| 文件上传大小 | 单个 200MB / 总 500MB | |
||||
|
| CORS | `*` (可配置) | |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## 20. 部署配置 (Deployment) |
||||
|
|
||||
|
| 环境 | Profile | 说明 | |
||||
|
|------|---------|------| |
||||
|
| 开发环境 | `development` | 默认激活 | |
||||
|
| 测试环境 | `test` | - | |
||||
|
| 正式环境 | `production` | - | |
||||
|
| Docker 测试 | `docker-test` | Jib 构建 + ECR 推送 | |
||||
|
| Docker 正式 | `docker-production` | Jib 构建 + ECR 推送 | |
||||
|
| 仅打包 | `only-package` | ZIP 打包 | |
||||
|
|
||||
|
### Docker 基础镜像 |
||||
|
|
||||
|
``` |
||||
|
registry.ap-northeast-1.aliyuncs.com/southwave/jdk17-template:latest |
||||
|
``` |
||||
Loading…
Reference in new issue