部署脚本

2026-04-28 17:27:24 +08:00
parent 592c58534a
commit cf91be838f
12 changed files with 2868 additions and 1 deletions
--- a/docs/reports/implementation/2026-04-27-nvmrc-configuration-implementation.md
+++ b/docs/reports/implementation/2026-04-27-nvmrc-configuration-implementation.md
@@ -0,0 +1,16 @@
+# nvmrc 配置实施记录
+
+## 修改内容
+
+- 在仓库根目录新增 `.nvmrc`，统一指定 Node 版本为 `14.21.3`。
+- 保留并对齐前端目录 `ruoyi-ui/.nvmrc` 的既有配置，确保在仓库根目录或前端目录执行 `nvm use` 时使用同一 Node 版本。
+
+## 影响范围
+
+- 仅影响本地前端开发、构建、调试命令的 Node 版本选择。
+- 不涉及后端代码、数据库结构、菜单权限或业务逻辑调整。
+
+## 验证情况
+
+- 已检查 `ruoyi-ui/.nvmrc` 当前内容为 `14.21.3`。
+- 已检查 `ruoyi-ui/package.json`，当前前端为 Vue 2 / Vue CLI 4 依赖栈，适合继续使用 Node `14.21.3`。
--- a/docs/reports/implementation/2026-04-28-prod-java-backend-start-script-implementation.md
+++ b/docs/reports/implementation/2026-04-28-prod-java-backend-start-script-implementation.md
@@ -0,0 +1,88 @@
+# 生产服务器 Java 后端启动脚本实施记录
+
+## 保存路径确认
+
+- 本次新增生产服务器后端启停脚本，实施记录保存到 `docs/reports/implementation/`，符合仓库实施文档目录规范。
+
+## 修改目标
+
+- 新写一个可在生产服务器上运行的 Java 后端启停脚本。
+- 脚本支持配置 Java Home，不依赖 Maven，不执行本地构建，只负责运行已上传到服务器的 `ruoyi-admin.jar`。
+
+## 修改内容
+
+- 新增 `deploy/start-java-backend-prod.sh`
+  - 在脚本顶部新增“生产配置区”，生产服务器上的 Java Home、Jar 目录、Profile、JVM 参数和额外应用参数均直接写在脚本文件中。
+  - 按生产服务器目录结构调整默认 Jar 路径：启动脚本位于外层目录，后端 Jar 位于 `backend/ruoyi-admin.jar`。
+  - 通过脚本内 `APP_HOME="${SCRIPT_DIR}/backend"` 指定生产服务器上的 Jar 所在目录。
+  - 通过脚本内 `BACKEND_JAVA_HOME` 指定脚本使用的 JDK，优先级高于系统 `JAVA_HOME`。
+  - 脚本内 `BACKEND_JAVA_HOME` 留空时读取系统 `JAVA_HOME`；两者都未配置时使用 `PATH` 中的 `java`。
+  - 支持 `start`、`stop`、`restart`、`status`、`logs` 操作。
+  - `start` 会先调用 `stop_backend`，通过 `ps -ef` 关闭旧后端进程，再启动新的 `backend/ruoyi-admin.jar`。
+  - `start` 和 `restart` 在后端启动成功后会自动持续输出 `backend/logs/backend-console.log`，按 `Ctrl+C` 仅退出日志查看，不停止后端进程。
+  - 支持 `stop` 单独停止后端进程。
+  - 使用 `APP_MARKER` 标记脚本启动的新进程，停止旧进程时统一通过 `ps -ef` 扫描进程列表，匹配当前 Jar 绝对路径或生产目录下的相对路径 `backend/ruoyi-admin.jar`。
+  - `stop` 可停止没有脚本标记但由同一 `backend/ruoyi-admin.jar` 启动的旧进程，用于覆盖生产服务器已有手工启动进程。
+  - 进程扫描会忽略 `<defunct>` 行，避免僵尸进程或历史残留干扰启停判断。
+  - 若 `ps -ef` 执行失败，脚本会明确报错并中止旧进程扫描，避免误判为“后端未运行”。
+  - 默认 Spring Profile 为 `uat`，可通过 `SPRING_PROFILES_ACTIVE` 覆盖。
+
+## 使用方式
+
+将 `deploy/start-java-backend-prod.sh` 放到生产服务器，并先修改脚本顶部“生产配置区”：
+
+```bash
+BACKEND_JAVA_HOME=""
+APP_HOME="${SCRIPT_DIR}/backend"
+JAR_NAME="ruoyi-admin.jar"
+SPRING_PROFILES_ACTIVE="uat"
+JAVA_OPTS="-Duser.timezone=Asia/Shanghai -Xms512m -Xmx1024m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError"
+APP_ARGS=""
+```
+
+配置完成后直接执行：
+
+常用命令：
+
+```bash
+./start-java-backend-prod.sh start
+./start-java-backend-prod.sh stop
+./start-java-backend-prod.sh restart
+./start-java-backend-prod.sh status
+./start-java-backend-prod.sh logs
+```
+
+## 验证记录
+
+- 执行 `bash -n deploy/start-java-backend-prod.sh`
+  - 结果：通过
+  - 说明：脚本 Bash 语法正确。
+- 执行 `bash deploy/start-java-backend-prod.sh help`
+  - 结果：通过
+  - 说明：帮助信息正常输出，并说明启动成功后会持续输出控制台日志。
+- 执行 `rg -n "start_backend|follow_logs" deploy/start-java-backend-prod.sh`
+  - 结果：通过
+  - 说明：已确认 `start` 与 `restart` 分支均使用 `start_action`，流程为先 `stop_backend`，再 `start_backend`，最后 `follow_logs`。
+- 执行 `bash deploy/start-java-backend-prod.sh status`
+  - 结果：通过
+  - 说明：在允许执行 `ps -ef` 后，无后端进程时可正常输出未运行状态。
+- 执行 `rg -n "pgrep" deploy/start-java-backend-prod.sh`
+  - 结果：无匹配
+  - 说明：已确认停止旧进程不再依赖 `pgrep`。
+- 执行 `rg -n "ps -ef" deploy/start-java-backend-prod.sh`
+  - 结果：通过
+  - 说明：已确认旧进程扫描逻辑使用 `ps -ef`。
+- 使用临时脚本副本和临时后端目录启动一个命令行包含 `-jar backend/ruoyi-admin.jar`、但不带脚本标记的模拟旧进程，再执行 `bash /tmp/start-java-backend-prod-test.sh stop`
+  - 结果：通过
+  - 说明：已验证 `stop` 可以停止同一 Jar 路径的旧进程，不要求旧进程必须由当前脚本启动。
+- 修改临时脚本副本，将脚本内 `BACKEND_JAVA_HOME` 设置为 `/not-exist` 后执行 `bash /tmp/start-java-backend-prod-test.sh start`
+  - 结果：按预期失败
+  - 说明：脚本能在启动前拦截无效 Java Home，并输出明确错误。
+- 执行 `bash deploy/start-java-backend-prod.sh start`
+  - 结果：按预期失败
+  - 说明：脚本能正确解析当前 Java 命令，并在当前本地未提供 `deploy/backend/ruoyi-admin.jar` 时中止启动。
+
+## 影响范围
+
+- 仅新增生产服务器后端启停脚本与本实施记录。
+- 不修改 Java 业务代码、数据库脚本、前端页面和现有发布包生成脚本。
--- a/docs/reports/implementation/2026-04-28-prod-release-deploy-script-implementation.md
+++ b/docs/reports/implementation/2026-04-28-prod-release-deploy-script-implementation.md
@@ -0,0 +1,68 @@
+# 生产上线部署脚本实施记录
+
+## 保存路径确认
+
+- 本次为生产上线部署脚本改动，实施记录保存到 `docs/reports/implementation/`，符合仓库实施文档目录规范。
+
+## 修改目标
+
+- 生成一个可放在上线环境执行的部署脚本。
+- 上线环境目录下已有 `backend/`、`frontend/` 和一个上线压缩包。
+- 上线压缩包根层包含 `ruoyi-admin.jar` 和 `dist.zip`。
+- 执行脚本后先备份 `backend/` 与 `frontend/` 旧文件，再解压上线包并部署到对应目录，最后调用 `start-java-backend-prod.sh` 重启后端并输出日志。
+
+## 修改内容
+
+- 新增 `deploy/deploy-release-prod.sh`
+  - 默认按脚本同级目录解析 `backend/`、`frontend/`、`start-java-backend-prod.sh` 和上线压缩包。
+  - 使用 `/bin/sh` 写法，避免依赖 Bash 进程替换等服务器环境不一定支持的语法。
+  - 支持显式传入上线压缩包路径：`./deploy-release-prod.sh /path/to/ccdi_YYYYMMDD.zip`。
+  - 未传入压缩包时，自动使用脚本同级目录下唯一的 `.zip` 文件，并排除 `dist.zip`。
+  - 部署前将 `backend/` 和 `frontend/` 当前内容备份到 `backups/YYYYMMDDHHMMSS/`。
+  - 解压上线包后校验根层必须存在 `ruoyi-admin.jar` 和 `dist.zip`。
+  - 解压 `dist.zip` 后校验必须存在 `dist/index.html`。
+  - 后端部署为覆盖 `backend/ruoyi-admin.jar`。
+  - 前端部署为清空 `frontend/` 后复制 `dist/` 内文件到 `frontend/`。
+  - 部署完成后执行 `bash start-java-backend-prod.sh restart`，由现有启动脚本完成后端重启并持续输出后端日志。
+
+## 使用方式
+
+生产环境目录结构：
+
+```text
+上线目录/
+├── deploy-release-prod.sh
+├── start-java-backend-prod.sh
+├── backend/
+├── frontend/
+└── ccdi_YYYYMMDD.zip
+```
+
+执行：
+
+```bash
+./deploy-release-prod.sh
+```
+
+或显式指定压缩包：
+
+```bash
+./deploy-release-prod.sh /path/to/ccdi_YYYYMMDD.zip
+```
+
+## 验证记录
+
+- 执行 `sh -n deploy/deploy-release-prod.sh`
+  - 结果：通过
+  - 说明：脚本 Shell 语法正确。
+- 执行 `sh deploy/deploy-release-prod.sh --help`
+  - 结果：通过
+  - 说明：帮助信息正常输出。
+- 使用 `/tmp` 构造最小上线目录、旧 `backend/`、旧 `frontend/`、上线压缩包和假的 `start-java-backend-prod.sh` 后执行部署脚本
+  - 结果：通过
+  - 说明：已验证旧文件备份、新 Jar 覆盖、前端 `dist/` 文件部署，以及最终调用启动脚本 `restart`。
+
+## 影响范围
+
+- 仅新增生产上线部署脚本与本实施记录。
+- 不修改 Java 业务代码、前端业务代码、数据库脚本和现有后端启动脚本。
--- a/docs/reports/implementation/2026-04-28-production-init-sql-implementation.md
+++ b/docs/reports/implementation/2026-04-28-production-init-sql-implementation.md
@@ -0,0 +1,78 @@
+# 生产上线初始化 SQL 生成实施记录
+
+## 保存路径确认
+
+- 生产初始化 SQL：`sql/ccdi_prod_init_20260428.sql`
+- 实施记录：`docs/reports/implementation/2026-04-28-production-init-sql-implementation.md`
+
+## 修改内容
+
+- 新增 `sql/ccdi_prod_init_20260428.sql`，用于生产空库初始化。
+- SQL 内容包含当前 `ccdi` 库最终态的 57 张表结构。
+- SQL 必要数据范围：
+  - 若依基础配置、部门、岗位、用户、角色、菜单、角色菜单、字典、定时任务、公告。
+  - CCDI 默认模型参数，仅包含 `ccdi_model_param.project_id = 0` 的系统默认参数。
+  - 流水打标规则 `ccdi_bank_tag_rule`。
+- SQL 不包含运行期业务数据：
+  - 项目、员工、流水、导入记录、风险结果、采购事项、实体库、中介库、操作日志、登录日志等数据均保持空表。
+- 将导出结构中的非规范排序规则统一修正为 `utf8mb4_general_ci`，未保留 `utf8mb4_0900_ai_ci`。
+- 针对生产执行时报错 `Specified key was too long; max key length is 767 bytes`，按生产要求删除旧库 767 bytes 限制下会超长的索引定义，保留字段长度、表结构和必要初始化数据不变。
+- 删除的超长索引范围：
+  - Quartz 表中的长字符复合主键和依赖这些长字符复合键的外键索引。
+  - `ccdi_account_info.idx_ccdi_account_info_account_no`。
+  - `ccdi_asset_info.idx_family_person`。
+  - `ccdi_bank_statement.uk_bank_statement_dedup`。
+  - `ccdi_bank_statement.idx_batch_id_account`。
+  - `ccdi_bank_statement.c4c_bank_statement_stg_batch_id_IDX`。
+  - `ccdi_bank_statement_tag_result.uk_ccdi_bank_tag_object_hit`。
+  - `ccdi_enterprise_base_info.idx_enterprise_name`。
+  - `ccdi_evidence.idx_ccdi_evidence_source`。
+  - `ccdi_model_param.uk_project_model_param`。
+  - `ccdi_project.idx_project_name`。
+
+## 验证情况
+
+- 使用本机临时 MySQL 实例导入 `sql/ccdi_prod_init_20260428.sql` 验证通过。
+- 导入后验证结果：
+  - 表数量：57。
+  - 非 `utf8mb4_general_ci` 表数量：0。
+  - 基础数据行数：
+    - `sys_config`：8。
+    - `sys_dept`：10。
+    - `sys_dict_type`：26。
+    - `sys_dict_data`：98。
+    - `sys_menu`：166。
+    - `sys_role`：2。
+    - `sys_role_menu`：134。
+    - `sys_user`：3。
+    - `sys_job`：3。
+    - `sys_notice`：2。
+    - `ccdi_bank_tag_rule`：35。
+    - `ccdi_model_param`：17，且全部为 `project_id = 0`。
+  - 业务数据抽查为空：
+    - `ccdi_project`：0。
+    - `ccdi_base_staff`：0。
+    - `ccdi_bank_statement`：0。
+    - `ccdi_file_upload_record`：0。
+    - `ccdi_purchase_transaction`：0。
+- 测试完成后已关闭本机临时 MySQL 实例。
+- 生产索引长度修复后，再次计算脚本内所有剩余索引长度，确认超过 767 bytes 的索引数量为 0。
+- 删除超长索引后，再次使用本机临时 MySQL 实例导入验证通过：
+  - 表数量：57。
+  - 非 `utf8mb4_general_ci` 表数量：0。
+  - `ccdi_model_param`：17。
+  - `ccdi_bank_tag_rule`：35。
+  - `sys_menu`：166。
+  - `ccdi_project`：0。
+  - `ccdi_bank_statement`：0。
+
+## 执行说明
+
+- 目标生产库需为空库。
+- 目标库字符集和排序规则建议使用：
+
+```sql
+CREATE DATABASE ccdi DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
+```
+
+- 导入时需使用 `utf8mb4` 会话字符集。
--- a/docs/reports/implementation/2026-04-28-release-package-script-implementation.md
+++ b/docs/reports/implementation/2026-04-28-release-package-script-implementation.md
@@ -0,0 +1,35 @@
+# CCDI 上线压缩包生成脚本实施记录
+
+## 修改内容
+
+- 新增根目录脚本 `build_release_ccdi.sh`。
+- 脚本执行后会重新构建后端 `ruoyi-admin.jar`，并进入 `ruoyi-ui` 通过 `nvm use` 切换前端 Node 版本后执行 `npm run build:prod`。
+- 脚本会在根目录生成 `ccdi_YYYYMMDD.zip`，压缩包根层仅包含 `ruoyi-admin.jar` 和 `dist.zip`，不再额外包裹 `deploy` 目录。
+- `.gitignore` 新增 `/ccdi_????????.zip`，避免生成的上线压缩包进入 Git。
+
+## 影响范围
+
+- 仅新增发布包生成脚本与忽略规则，不修改业务代码。
+- 临时打包目录使用 `.deploy/ccdi-release-package/`，该目录已作为本地部署产物被 Git 忽略。
+
+## 使用方式
+
+```bash
+./build_release_ccdi.sh
+```
+
+生成结果示例：
+
+```text
+ccdi_20260428.zip
+├── ruoyi-admin.jar
+└── dist.zip
+```
+
+## 验证情况
+
+- 已执行 `sh -n build_release_ccdi.sh`，脚本语法检查通过。
+- 已执行 `git diff --check`，未发现空白错误。
+- 已执行 `./build_release_ccdi.sh`，后端 Maven 打包成功，前端生产构建成功，并生成 `ccdi_20260428.zip`。
+- 已执行 `unzip -l ccdi_20260428.zip`，确认压缩包根层仅包含 `ruoyi-admin.jar` 与 `dist.zip` 两个文件。
+- 已执行 `git check-ignore -v ccdi_20260428.zip`，确认根目录上线压缩包会被 `.gitignore` 忽略。