diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..454659a --- /dev/null +++ b/.gitignore @@ -0,0 +1,46 @@ +framework/src/main/resources/static/assets/401-099a3a32.js +framework/src/main/resources/static/assets/401-fffd1e4b.css +framework/src/main/resources/static/assets/404-6dcbdda2.js +framework/src/main/resources/static/assets/404-51ac6f86.css +framework/src/main/resources/static/assets/BarChart-efd5cbe1.js +framework/src/main/resources/static/assets/editor-b13c93a6.js +framework/src/main/resources/static/assets/FunnelChart-79f3d5f7.js +framework/src/main/resources/static/assets/index-1a396a09.css +framework/src/main/resources/static/assets/index-01e2cfa9.js +framework/src/main/resources/static/assets/index-2b88764d.css +framework/src/main/resources/static/assets/index-04bb232d.js +framework/src/main/resources/static/assets/index-5a5afaa7.css +framework/src/main/resources/static/assets/index-6cf33161.js +framework/src/main/resources/static/assets/index-6ee17396.css +framework/src/main/resources/static/assets/index-9c04fca4.css +framework/src/main/resources/static/assets/index-63bba755.js +framework/src/main/resources/static/assets/index-70f67d2a.js +framework/src/main/resources/static/assets/index-98c36269.js +framework/src/main/resources/static/assets/index-362b32fa.css +framework/src/main/resources/static/assets/index-486d1d98.js +framework/src/main/resources/static/assets/index-2814df08.js +framework/src/main/resources/static/assets/index-5282e30f.js +framework/src/main/resources/static/assets/index-9057b190.js +framework/src/main/resources/static/assets/index-968257e1.css +framework/src/main/resources/static/assets/index-b25f0d08.js +framework/src/main/resources/static/assets/index-b98a9d85.js +framework/src/main/resources/static/assets/index-bca4e108.js +framework/src/main/resources/static/assets/index-c2e52e75.js +framework/src/main/resources/static/assets/index-c03bc2fe.js +framework/src/main/resources/static/assets/index-cdc0bc49.css +framework/src/main/resources/static/assets/index-ce8e85c4.js +framework/src/main/resources/static/assets/index-e5abaec0.js +framework/src/main/resources/static/assets/index-e051e64c.js +framework/src/main/resources/static/assets/index-f52936ec.js +framework/src/main/resources/static/assets/index1-5c7d9d99.js +framework/src/main/resources/static/assets/index2-26043b81.js +framework/src/main/resources/static/assets/lbcz_xg-6b0694a6.js +framework/src/main/resources/static/assets/page.vue_vue_type_script_setup_true_lang-7a09a11a.js +framework/src/main/resources/static/assets/personalCenter-a026f3ae.js +framework/src/main/resources/static/assets/PieChart-bffd7bcc.js +framework/src/main/resources/static/assets/RadarChart-e43ec971.js +framework/src/main/resources/static/assets/resize-24879ea2.js +framework/src/main/resources/static/assets/sortable.esm-616533ae.js +framework/src/main/resources/static/assets/tagsView-6df0ea3e.js +framework/src/main/resources/static/assets/uploader-0562c8e7.js +framework/src/main/resources/static/assets/uploader-4183de44.css diff --git a/framework/docs/Java框架项目技术文档.md b/framework/docs/Java框架项目技术文档.md new file mode 100644 index 0000000..8502e5a --- /dev/null +++ b/framework/docs/Java框架项目技术文档.md @@ -0,0 +1,139 @@ +# 项目技术文档（framework 模块） + +> 运行环境：Windows，Java 21（兼容 17+），Spring Boot 3.3.x + +## 概述 +- 平台型后端服务，采用 `Spring Boot 3.3.x`，区分 `dev` / `server` 两种运行配置。 +- 数据访问：`MyBatis-Plus 3.5.6` + `MyBatis 3.5.16`；连接池：`Druid`。 +- 任务调度：`Quartz 2.3.2`；API 文档：`springdoc-openapi`（Swagger UI）。 +- 缓存与基础设施：`Redis`、`WebSocket`、`Actuator`、验证码（`easy-captcha`）、加密（`jasypt`）、`ip2region`、`hutool` 等。 +- 打包方式：可执行 `JAR`（已启用 `spring-boot-maven-plugin` 的 `repackage`）。默认开发端口 `8093`（`server` 可使用 `8090`）。 + +## 目录结构 +- 仓库根（当前工作目录）：`D:\JavaProjectSpace\framework` +- 主要结构： +``` +framework/ +├── Dockerfile +├── frontend/ # 前端源码（Vite + TypeScript + Tailwind） +├── pom.xml # Maven 构建管理 +└── src/ + ├── main/ + │ ├── java/ # 业务代码（入口类在 com.yfd.platform.*） + │ └── resources/ # 配置与静态资源（static、配置 YAML、日志） + └── test/ + └── java/ # 测试代码 +``` + +## 快速开始 +- 前置要求： + - 安装 `JDK 21`（兼容 17+）、`Maven 3.9+`、`Git`、`Node.js 18+`（前端构建）。 + - Windows 终端建议执行 `chcp 65001`，确保 UTF-8 编码输出。 +- 构建后端： + - `mvn clean package -DskipTests` +- 本地运行（dev）： + - `java -jar target/platform-1.0.jar --spring.profiles.active=dev` +- 运行（server）： + - `java -jar target/platform-1.0.jar --spring.profiles.active=server` +- API 文档： + - 访问 `http://localhost:8093/swagger-ui/index.html`（以实际配置为准） + +## 前端集成 +- 自动构建：Maven 在 `generate-resources` 阶段调用 `npm install` 与 `npm run build:mvn`，产物输出到 `frontend/dist`。 +- 静态资源复制：可通过 `maven-resources-plugin` 将 `frontend/dist` 复制至 `src/main/resources/static`，如需开启请将 POM 中该插件的 `` 设置为 `false` 或按需配置 Profile。 +- 单独构建：在 `framework/frontend` 目录手动执行 `npm install && npm run build`，然后复制 `dist/` 到后端静态目录。 + +## 配置说明 +- Profile 切换：通过 `--spring.profiles.active=` 激活环境。 +- 关键属性： + - `file-space.system`：文件根路径，需在激活的 profile 中配置。 + - `spring.datasource.druid.*`：数据库连接与池化参数。 + - `server.port`：端口（`dev` 默认 8093，`server` 可使用 8090）。 +- 编码与 JVM 参数： + - 统一 JVM 编码：`-Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8`（POM 已配置）。 + - PowerShell 输出建议设为 UTF-8：`chcp 65001`。 + +## 依赖与版本 +- Spring：`spring-boot-starter-web`、`security`、`cache`、`websocket`、`actuator`。 +- 数据访问：`mybatis-spring-boot-starter`、`mybatis-plus-boot-starter`、`druid-spring-boot-starter`、`mysql-connector-j`、`sqlite-jdbc`。 +- 工具与增强：`hutool-all`、`poi` / `poi-ooxml`、`fastjson`、`freemarker`、`jsoup`、`jasypt`、`ip2region`、`easy-captcha`、`UserAgentUtils`、`nashorn-core`。 +- 文档：`springdoc-openapi-starter-webmvc-ui`（Swagger UI）。 +- 构建管控：`maven-enforcer-plugin`（JDK≥17、Maven≥3.6.3）。 + +## 数据库配置示例 +- MySQL 连接： +```yaml +spring: + datasource: + druid: + master: + url: jdbc:mysql://:3306/?useUnicode=true&characterEncoding=UTF8&rewriteBatchedStatements=true&useSSL=false&allowPublicKeyRetrieval=true + username: + password: +``` +- 授权建议： +```sql +CREATE USER 'appuser'@'%' IDENTIFIED BY 'StrongPassword!'; +GRANT ALL PRIVILEGES ON .* TO 'appuser'@'%'; +FLUSH PRIVILEGES; +``` +- Druid 健壮性： +```yaml +spring: + datasource: + druid: + initial-size: 0 + test-on-borrow: false + test-while-idle: true + validation-query: SELECT 1 +``` + +## 日志与监控 +- 日志：Logback（UTF-8 输出），推荐格式：`%d [%thread] %-5level %logger{50} - %msg%n`。 +- 监控：启用 Actuator，健康检查路径：`/actuator/health`。 +- 建议接入集中日志与指标采集（ELK / Vector），监控数据库与线程池（Druid / Quartz）。 + +## 定时任务 +- 默认 `RAMJobStore`（非集群、内存存储）。 +- 如需持久化与集群，改用 `JdbcJobStore` 并配置数据源与表结构。 + +## 安全与鉴权 +- 采用 JWT 进行鉴权（如 `jwtAuthenticationTokenFilter`，按实际代码启用）。 +- 敏感配置（`jwt.secret`、数据库密码）通过环境变量或外部密钥管理。 +- 生产环境建议启用 HTTPS 并使用强密钥。 + +## Docker 部署 +- 端口：默认暴露 `8093`（dev）；可在 `server` profile 使用 `8090`。 +- 基本流程： + - 构建镜像：`docker build -t projectframework-app:latest .` + - 运行（开发环境）：`docker run -d --name platform-app -p 8093:8093 -e SPRING_PROFILES_ACTIVE=dev projectframework-app:latest` + - 运行（服务器环境）：`docker run -d --name platform-app -p 8090:8090 -e SPRING_PROFILES_ACTIVE=server projectframework-app:latest` +- 文件空间挂载示例：`-v D:/data/file-space:/data/file-space -e FILE_SPACE_SYSTEM=/data/file-space` + +## Git 使用（框架分支） +- 远程仓库：根据实际仓库地址配置（示例：`http://121.37.111.42:3000/ThbTech/JavaProjectRepo.git`）。 +- 分支建议：`main-framework`（稳定分支）、`develop-framework`（开发分支）。 +- 常用命令：`git pull`、`git add .`、`git commit -m ""`、`git push`。 +- 提交署名：`git config user.name ""`，`git config user.email ""`。 + +## CI/CD 建议 +- CI 阶段：`mvn -B -DskipTests clean package`，配合单元测试与安全扫描（依赖检查、代码质量）。 +- CD 阶段：推送镜像到私有仓库，使用环境变量注入敏感信息。 + +## 常见问题 +- 中文乱码：执行 `chcp 65001`，确保 `logback-spring.xml` 使用 UTF-8。 +- `NoSuchMethodError`（MyBatis）：升级到 `MyBatis 3.5.16+` 并与 MP 版本匹配。 +- 数据库 `Access denied`：校验账户密码与远程授权；必要时新建业务账户并放开 `3306`。 +- 端口占用/启动失败：检查 `server.port` 与冲突端口；查看应用日志定位根因。 +- 前端构建问题：如遇 npm 依赖警告或复制冲突，可先独立构建并手动复制 `dist/`。 + +## 变更日志（模板） +- `feat:` 新增功能说明 +- `fix:` 缺陷修复说明 +- `docs:` 文档更新说明 +- `refactor:` 重构说明 +- `perf:` 性能优化说明 + +--- + +如需扩展专题文档（接口规范、部署拓扑、参数字典等），请在 `docs/` 目录继续维护并与版本管理同步。 \ No newline at end of file diff --git a/framework/docs/develop-framework分支Git操作指南.md b/framework/docs/develop-framework分支Git操作指南.md new file mode 100644 index 0000000..885e7f4 --- /dev/null +++ b/framework/docs/develop-framework分支Git操作指南.md @@ -0,0 +1,160 @@ +# develop-framework 分支 Git 操作指南（面向 main-framework 主分支） + +> 适用范围：`D:/JavaProjectSpace/framework` 项目（Spring Boot 3.3.x，可执行 JAR），远程仓库：`http://121.37.111.42:3000/ThbTech/JavaProjectRepo.git` +> 主分支：`main-framework`；开发分支：`develop-framework` + +## 分支策略与目标 +- `main-framework`：稳定发布分支，受保护（建议启用 PR 合并、代码审查、CI 通过）。 +- `develop-framework`：日常开发分支，合并至主分支前需完成构建与自测。 +- 推荐临时特性分支：`feature/` 从 `develop-framework` 拉出，完成后合并回 `develop-framework`。 + +## 初始仓库设置 +- 设置用户信息（确保提交署名一致）： +``` +git config user.name "zhengsl" +git config user.email "13910913995@163.com" +``` +- 关联远程（如已有请忽略）： +``` +git remote set-url origin http://121.37.111.42:3000/ThbTech/JavaProjectRepo.git +``` +- 拉取远程分支列表并跟踪： +``` +git fetch --all --prune +``` + +## 开发日常流程（在 develop-framework） +- 切换到开发分支并更新： +``` +git checkout develop-framework +git pull --ff-only +``` +- 提交更改（遵循约定式提交，示例）： +``` +git add . +git commit -m "feat: 支持可执行JAR打包并优化资源复制逻辑" +``` +- 推送到远程： +``` +git push -u origin develop-framework +``` + +## 合并到主分支（首选 PR 流程） +- 方式一：在 Gitea 发起 PR（推荐） + - 目标：`develop-framework` -> `main-framework` + - 检查 CI 构建通过、代码评审通过后合并。 + - 合并策略建议：`Squash` 或 `Rebase and merge` 保持主分支提交整洁。 + +- 方式二：命令行快速合并（仅在无保护、需要紧急修复时使用） +``` +# 确保主分支最新 +git checkout main-framework +git pull --ff-only + +# 将主分支变更应用到开发分支，减少合并冲突 +git checkout develop-framework +git rebase main-framework +# 解决冲突后： +# git add +# git rebase --continue + +# 回到主分支并合并（优先快进） +git checkout main-framework +git merge --ff-only develop-framework || git merge --no-ff develop-framework + +# 推送主分支 +git push origin main-framework +``` + +## 版本与标签（发布规范） +- 采用语义化版本：`vMAJOR.MINOR.PATCH`（示例：`v1.0.0`）。 +- 打标签并推送： +``` +# 核心检查：构建通过、基本功能自测 OK +mvn -B -DskipTests clean package + +# 标签与推送 +git tag -a v1.0.0 -m "release: framework v1.0.0 可执行JAR" +git push origin v1.0.0 +``` + +## 构建校验（必须） +- 本地快速验证： +``` +# 打包 +mvn -q -DskipTests package +# 启动（dev） +java -jar target/platform-1.0.jar --spring.profiles.active=dev +# 浏览器访问（默认端口） +http://localhost:8093/ +``` +- 如果使用前端集成： + - POM 已配置在 `generate-resources` 阶段执行 `npm install` 与 `npm run build:mvn`。 + - 静态资源复制（`frontend/dist` -> `src/main/resources/static`）可通过 `maven-resources-plugin` 控制；必要时启用/关闭 `` 或使用 Maven Profile 控制。 + +## 分支保护与权限（建议在 Gitea 设置） +- 保护 `main-framework`： + - 禁止直接 push 到主分支，仅允许通过 PR 合并。 + - 最少 1 人审核，CI 必须通过。 + - 禁止强制推送（force push）。 +- 标签权限：仅发布管理员可打 `release` 标签。 + +## 常见场景与命令速查 +- 同步远程状态（清理过期分支）： +``` +git fetch --all --prune +``` +- 创建特性分支： +``` +git checkout develop-framework +git pull --ff-only +git checkout -b feature/ +``` +- 将特性分支合并回开发分支： +``` +git checkout develop-framework +git merge --no-ff feature/ +git push origin develop-framework +``` +- 更新主分支并合并开发分支（CLI）： +``` +git checkout main-framework +git pull --ff-only +git merge --ff-only develop-framework || git merge --no-ff develop-framework +git push origin main-framework +``` +- 回滚错误提交： +``` +# 回滚指定提交（保留历史） +git revert +# 或回退到某版本（谨慎，可能重写历史） +git reset --hard +git push -f origin # 若分支受保护，需取消保护或走 PR revert +``` + +## 冲突处理指南 +- Rebase 阶段冲突： + - 编辑冲突文件，确保以 `main-framework` 为基线保留正确逻辑。 + - 逐个解决后：`git add `，继续：`git rebase --continue`。 +- Merge 阶段冲突： + - 优先在 `develop-framework` 解决，再合并到 `main-framework`，减少主分支污染。 + +## 提交规范建议（Conventional Commits） +- 前缀示例：`feat`、`fix`、`docs`、`refactor`、`perf`、`test`、`build`、`chore`。 +- 示例：`feat: 前端静态资源复制支持 Profile 开关`。 + +## CI/CD 建议 +- CI： + - `mvn -B -DskipTests clean package` + - 单元测试、依赖安全扫描、代码质量检查 +- CD： + - 根据标签构建镜像，注入敏感配置（环境变量/密钥管理）。 + +## 问题排查 +- 构建失败：检查 `pom.xml` 插件配置，先本地运行 `mvn -e package` 查看详细栈。 +- 端口冲突：调整 `server.port` 或释放占用端口。 +- npm 警告/冲突：在 `frontend/` 内单独 `npm install && npm run build`，再复制到后端静态目录。 + +--- + +如需将资源复制与文档生成改为按需开关（Maven Profile），可在 `pom.xml` 中添加 Profile 并通过 `-P ` 控制。需要我帮助你落地 Profile 与分支保护脚本，请告诉我你的偏好（例如是否必须走 PR）。 \ No newline at end of file diff --git a/framework/docs/前后端整合.md b/framework/docs/前后端整合.md deleted file mode 100644 index 4bab797..0000000 --- a/framework/docs/前后端整合.md +++ /dev/null @@ -1,52 +0,0 @@ -# 前后端一体化构建与打包说明 - -本文档说明如何在 Maven 构建流程中，先编译前端（pnpm），再编译后端（Java），并在 `package` 阶段将两者一起打包，使生成的可运行 `jar/war` 直接可以访问前端首页 `index.html`。 - -## 前置要求 -- 已安装 JDK（推荐 17+）和 Maven（3.6.3+）。 -- 已安装 Node.js（推荐 18+）与 pnpm（全局）：`npm i -g pnpm`。 -- 当前项目结构： - - 后端（Spring Boot）：`app/pom.xml`，源码在 `app/src/main/java` 与资源在 `app/src/main/resources`。 - - 前端（Vite/Vue）：位于 `app/frontend`，构建输出目录默认是 `app/frontend/dist`。 - -## 构建流程概览 -在 `pom.xml` 中集成了以下步骤： -1. `generate-resources` 阶段：进入 `frontend` 目录，执行 `pnpm install --frozen-lockfile` 与 `pnpm run build`。 -2. `process-resources` 阶段：将前端构建产物从 `frontend/dist` 复制到后端资源目录 `src/main/resources/static`。 -3. 随后执行后端 Java 编译与打包，最终产出可运行的 `jar/war`。 - -这样在运行后端时，Spring Boot 会从类路径的 `static` 目录自动提供 `index.html` 作为欢迎页入口（访问根路径 `/` 即可看到前端页面）。 - -## 关键 POM 配置（摘要） -已经在 `app/pom.xml` 的 `` 中加入： -- `exec-maven-plugin`：在 Java 编译前执行 pnpm 安装与构建。 -- `maven-resources-plugin`：复制前端构建产物到 `src/main/resources/static`。 - -无需手动改动目录，只需按下述命令执行即可。 - -## 常用命令 -- 开发运行（跳过测试）：`mvn -DskipTests spring-boot:run` - - 如需指定开发配置：`mvn -DskipTests -Dspring-boot.run.profiles=dev spring-boot:run` -- 构建打包（跳过测试）：`mvn -DskipTests package` - - 构建过程中会自动执行前端构建并拷贝到后端资源。 - -## 运行与访问 -- 运行可执行包（以 `war` 为例，`artifactId=platform`，`version=1.0`）： - - 默认运行：`java -jar target/platform-1.0.war` - - 指定 dev 配置：`java -Dspring.profiles.active=dev -jar target/platform-1.0.war` -- 访问： - - 若启用 `dev` 配置并端口为 `8093`：`http://localhost:8093/` - - 若使用默认端口（例如 `18080`）：`http://localhost:18080/` - -> 说明：Spring Boot 会自动将 `classpath:/static/index.html` 作为欢迎页，访问根路径即可进入前端入口页面。 - -## 注意事项 -- 请确保 `pnpm` 可在构建机/开发机的环境变量中直接调用。 -- 若前端构建输出目录（`dist`）有自定义，请同步更新 POM 中的复制路径。 -- 如前端使用路由的 `history` 模式并期望后端兜底到 `index.html`，可按需添加后端控制器或使用前端服务器侧配置（当前方案以静态欢迎页为主）。 - -## 故障排查 -- 构建失败（找不到 `pnpm`）：确认已安装并可在命令行执行 `pnpm -v`。 -- 页面乱码：已在 POM 配置统一 JVM 编码为 `UTF-8`；在 Windows PowerShell 终端也应设置为 `UTF-8`。 - -完成上述配置后，只需使用 Maven 的标准命令，即可实现前后端一体化构建和打包运行。 \ No newline at end of file diff --git a/framework/docs/技术文档.md b/framework/docs/技术文档.md deleted file mode 100644 index 57b8448..0000000 --- a/framework/docs/技术文档.md +++ /dev/null @@ -1,161 +0,0 @@ -# 项目技术文档 - -> 项目：ProjectFrameWork2025（模块：`app` / Java 后端） -> 运行环境：Windows，Java 21（兼容 17+），Spring Boot 3.x - -## 概述 -- 平台型后端服务，采用 `Spring Boot 3.x`，区分 `dev` / `server` 两种运行配置。 -- 数据访问使用 `MyBatis-Plus 3.5.6` 与 `MyBatis 3.5.16`，连接池为 `Druid`。 -- 任务调度使用 `Quartz 2.3.2`；API 文档采用 `springdoc-openapi` / Swagger UI。 -- 支持 WAR 包运行，亦可容器化部署；默认开发端口 `8093`（`server` 可使用 `8090`）。 - -## 目录结构 -- 仓库根（当前工作目录）：`D:\Trae_space\ProjectFrameWork2025\app` -- 主要结构： -``` -app/ -├── .gitignore -├── Dockerfile -├── frontend/ # 前端说明或资源 -│ └── readme.md -├── pom.xml # Maven 构建管理 -└── src/ - ├── main/ - │ ├── java/ # 业务代码（入口类在 com.yfd.platform.*） - │ └── resources/ # 配置与静态资源 - └── test/ - └── java/ # 测试代码 -``` - -## 快速开始 -- 前置要求： - - 安装 `JDK 21`（兼容 17+），`Maven 3.9+`，`Git`。 - - Windows 终端执行 `chcp 65001`，确保 UTF-8 编码输出。 -- 构建后端： - - `mvn clean package -DskipTests` -- 本地运行（dev）： - - `java -jar target/platform-1.0.war --spring.profiles.active=dev` -- 运行（server）： - - `java -jar target/platform-1.0.war --spring.profiles.active=server` -- API 文档： - - 默认访问 `http://localhost:8093/swagger-ui/index.html`（以实际配置为准） - -## 配置说明 -- Profile 切换： - - 通过 `--spring.profiles.active=` 激活环境。 -- 关键属性： - - `file-space.system`：文件根路径，需在激活的 profile 中配置。 - - `spring.datasource.druid.*`：数据库连接参数与池化配置。 - - `server.port`：端口（`dev` 默认 8093，`server` 可使用 8090）。 -- VS Code/终端编码建议： - - 启动参数加入 `-Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8`。 - - 终端执行 `chcp 65001`，PowerShell 输出设置为 UTF-8。 - -## 依赖与版本 -- `Spring Boot 3.x` -- `MyBatis-Plus 3.5.6`（依赖 `MyBatis 3.5.16+`，需有 `Configuration.parsePendingResultMaps(boolean)`） -- `Druid` 数据源 -- `Quartz 2.3.2` -- `springdoc-openapi` / Swagger UI -- 日志：`Logback`（UTF-8 输出，`logback-spring.xml`） - -## 数据库配置 -- MySQL 连接示例： -```yaml -spring: - datasource: - druid: - master: - url: jdbc:mysql://:3306/?useUnicode=true&characterEncoding=UTF8&rewriteBatchedStatements=true&useSSL=false&allowPublicKeyRetrieval=true - username: - password: -``` -- 远程授权建议： -```sql -CREATE USER 'appuser'@'%' IDENTIFIED BY 'StrongPassword!'; -GRANT ALL PRIVILEGES ON .* TO 'appuser'@'%'; -FLUSH PRIVILEGES; -``` -- Druid 健壮性： -```yaml -spring: - datasource: - druid: - initial-size: 0 - test-on-borrow: false - test-while-idle: true - validation-query: SELECT 1 -``` - -## 日志 -- 控制台与文件统一 UTF-8 输出： - - 控制台 `ConsoleAppender`，文件 `RollingFileAppender`（按日滚动，保留 30 天）。 - - 推荐日志格式：`%d [%thread] %-5level %logger{50} - %msg%n`。 - -## 定时任务 -- 默认 `RAMJobStore`（非集群、内存存储）。 -- 如需持久化与集群，改用 `JdbcJobStore` 并配置数据源与表结构。 - -## 安全与鉴权 -- 使用 `JWT` 过滤器进行鉴权（如 `jwtAuthenticationTokenFilter`）。 -- 敏感配置（`jwt.secret`、数据库密码）建议通过环境变量或外部密钥管理。 -- 生产环境必须启用 HTTPS 并使用强密钥。 - -## API 文档 -- 启用 `swagger-ui.enabled: true`。 -- 访问路径通常为 `http://:/swagger-ui/index.html`。 - -## Docker 部署 -- `Dockerfile` 已暴露端口 `8093`： - - 构建镜像：`docker build -t projectframework2025-app:latest .` - - 运行（开发环境）： - - `docker run -d --name platform-app -p 8093:8093 -e SPRING_PROFILES_ACTIVE=dev projectframework2025-app:latest` - - 运行（服务器环境）： - - `docker run -d --name platform-app -p 8090:8090 -e SPRING_PROFILES_ACTIVE=server projectframework2025-app:latest` -- 如需挂载文件空间： - - `-v D:/data/file-space:/data/file-space -e FILE_SPACE_SYSTEM=/data/file-space` - -## 前端 -- 前端说明见 `frontend/readme.md`。如需联调，请统一跨域与鉴权策略。 - -## Git 使用 -- 远程仓库：`http://121.37.111.42:3000/ThbTech/ProjectFrameWork2025.git` -- 主分支：`main` -- 常用命令： - - `git pull`、`git add .`、`git commit -m ""`、`git push` -- 提交署名： - - `git config user.name ""` - - `git config user.email ""` - -## 常见问题 -- 中文乱码： - - 执行 `chcp 65001`，确保 `logback-spring.xml` 使用 UTF-8。 -- `NoSuchMethodError`（MyBatis）： - - 升级 `MyBatis` 至 `3.5.16+` 并与 MP 版本匹配。 -- 数据库 `Access denied`： - - 校验账户密码与远程授权；必要时新建业务账户并放开 `3306`。 -- 端口占用/启动失败： - - 检查 `server.port` 与冲突端口；查看应用日志定位根因。 - -## 运维与监控 -- 建议接入 `Spring Boot Actuator`：`/actuator/health`。 -- 配合日志轮转与集中采集（ELK/Vector），区分环境日志路径。 -- 监控数据库与线程池指标（Druid/Quartz）。 - -## CI/CD 建议 -- 在 CI 阶段执行： - - `mvn -B -DskipTests clean package` - - 单元测试与安全扫描（依赖检查、代码质量） -- 在 CD 阶段： - - 推送镜像到私有仓库，环境变量注入敏感信息。 - -## 变更日志（示例模板） -- `feat:` 新增功能说明 -- `fix:` 缺陷修复说明 -- `docs:` 文档更新说明 -- `refactor:` 重构说明 -- `perf:` 性能优化说明 - ---- - -如需扩展专题文档（接口规范、部署拓扑、参数字典等），建议在 `docs/` 目录继续维护并与版本管理同步。 \ No newline at end of file diff --git a/framework/pom.xml b/framework/pom.xml index 2d2a70f..a416d3b 100644 --- a/framework/pom.xml +++ b/framework/pom.xml @@ -11,7 +11,7 @@ com.yfd platform 1.0 - war + jar platform springboot 项目基础框架3.0 @@ -111,12 +111,7 @@ ${guava.version} - - - org.springframework.boot - spring-boot-starter-tomcat - provided - + @@ -367,6 +362,9 @@ copy-resources + true + true + false ${project.basedir}/src/main/resources/static @@ -390,6 +388,7 @@ process-asciidoc + true html book @@ -411,6 +410,13 @@ + + + + repackage + + + @@ -439,26 +445,24 @@ + + + org.apache.maven.plugins + maven-jar-plugin + 3.3.0 + + + attach-jar + + jar + + + plain + + + + - - - - - org.apache.maven.plugins - maven-jar-plugin - 3.3.0 - - - attach-jar - - jar - - - - - - -