# ChronicDiseaseApp — 项目概述

这是慢病管理应用（ChronicDiseaseApp）的文档目录说明，包含项目概要、技术栈、配置、运行/构建/测试指引以及开发和贡献规范的链接。

## 主要内容（概览）

- 项目名称：ChronicDiseaseApp
- 包名：`work.baiyun.chronicdiseaseapp`
- 框架：Spring Boot 3.x（Jakarta EE）
- Java 版本：17
- 构建工具：Maven

## 目录说明

- `src/main/java`：主代码，按模块组织（`common`, `config`, `controller`, `service`, `mapper`, `model`, `util`）
- `src/main/resources`：配置文件（`application.yml`、`logback-spring.xml`、`cert/` 等）
- `docs/DevRule`：项目开发规范集合（代码风格、API 设计、数据库规范、测试规范等）
- `logs/`：运行时日志输出目录（由 `logback-spring.xml` 指定）
- `target/`：Maven 构建输出目录（通常不纳入版本控制）

## 技术栈与依赖（概要）

- Spring Boot 3.0.13
- MyBatis-Plus 3.5.3
- PageHelper 1.4.2
- Knife4j（Jakarta 版本）4.4.0
- Lombok 1.18.24
- Hutool 5.8.22
- MySQL Connector/J 5.1.49

（完整依赖版本可见仓库根目录的 `pom.xml`）

## 关键配置说明

- 应用主端口：`8080`（见 `src/main/resources/application.yml`）
- 日志：配置在 `src/main/resources/logback-spring.xml`，默认写入 `./logs/app.log`，按日轮转保留 30 天
- 数据库：MySQL，连接配置在 `application.yml`（用户名/密码/URL 等）
- SSL 证书：放在 `classpath:cert/`（`fullchain.pem`，`privkey.pem`），项目支持 PEM 格式证书
- Token 认证：由 `AuthInterceptor` 与 `TokenService` 实现，支持 `Authorization: Bearer <token>`、`X-Token`、`token` header

## 常用命令（在项目根目录运行）

1. 编译并打包：

```powershell
mvn clean package -DskipTests
```

2. 运行（开发）：

```powershell
mvn spring-boot:run
```

3. 运行单元测试：

```powershell
mvn test
```

4. 生成代码或文档相关（若已配置）：请参考 `pom.xml` 中的插件配置和 `docs/DevRule` 中的 API 文档说明

## 文档与规范

项目的代码规范、API 设计、测试规范、依赖管理、日志与错误处理、数据库与安全规范等均收藏在：

```
docs/DevRule/
```

建议阅读顺序：

1. `01-代码风格指南.md`
2. `02-项目结构规范.md`
3. `03-API设计规范.md`
4. `04-测试规范.md`

## 开发与贡献指南

- 遵循 `docs/DevRule` 中的各项规范，保持代码风格一致。
- 新增依赖前先评估必要性并在 `pom.xml` 中统一管理版本。
- 提交代码前确保通过 `mvn test`，并尽可能添加/更新单元测试。
- 提交信息请使用简明的描述，若为修复或新特性请加上相关 issue/任务号。

## 注意事项

- 生产部署时请确保 `application.yml` 中的敏感配置（如数据库密码、微信 secret 等）已妥善管理，不要将明文凭据提交到公共仓库。
- 若需启用 HTTPS，请将证书文件放置在 `src/main/resources/cert/` 或指定的外部路径，并在 `application.yml` 中配置相应的 SSL 设置。

## 联系与支持

如需协助或报告问题，请在代码仓库中打开 issue，或联系项目维护者。

---

最后更新：自动生成于仓库（基于当前代码与 docs 内容）