278 lines
15 KiB
Markdown
278 lines
15 KiB
Markdown
# Kaidi 财务项目基础系统
|
||
|
||
本仓库当前处于 R1 开发执行阶段，需求基线见下方唯一总方案。
|
||
|
||
唯一需求、开发、测试和交付基线：
|
||
|
||
- [财务项目基础系统开发交付总方案](docs/财务系统开发交付总方案.md)
|
||
|
||
## 本地开发
|
||
|
||
后端默认连接本机 MySQL `127.0.0.1:3307`，启动 Java 服务：
|
||
|
||
```bash
|
||
cd backend
|
||
./mvnw spring-boot:run
|
||
```
|
||
|
||
前端使用官方 TDesign Vue Next Starter，来源记录见 [`frontend/UPSTREAM.md`](frontend/UPSTREAM.md)。
|
||
|
||
```bash
|
||
cd frontend
|
||
HUSKY=0 npm ci
|
||
npm run dev:linux -- --host 0.0.0.0 --port 3002
|
||
```
|
||
|
||
访问：<http://localhost:3002/>
|
||
|
||
本地 `local` profile 会创建 `admin`、`project`、`finance`、`archive`、`demo` 演示账号，初始密码均为
|
||
`LocalOnly@123`；该固定密码只用于本机开发，生产安装会生成随机管理员密码。
|
||
|
||
正式构建：
|
||
|
||
```bash
|
||
cd frontend
|
||
npm run build
|
||
```
|
||
|
||
后端运行后更新唯一 OpenAPI 机器制品：
|
||
|
||
```bash
|
||
./scripts/export-openapi.sh http://127.0.0.1:18080
|
||
```
|
||
|
||
## R1 Preview 一键安装
|
||
|
||
代码仓库和 Release 已公开，Linux 服务器不需要 Gitea Token。安装器读取
|
||
`https://git.awaioi.com/api/v1/repos/ERP-Team/kaidi/releases/latest`，生产机不执行 `git pull` 或现场编译。
|
||
安装脚本内置固定的发布公钥指纹，下载的应用包、清单、SBOM 和更新脚本仍须通过 RSA 签名与 SHA-256 校验。
|
||
Gitea API 只用于确认 Release tag 和资产名称；下载地址由受信 API 域名、仓库路径和 tag 重新构造，不采用
|
||
Gitea 响应中可能错误指向内网地址的 `browser_download_url`。
|
||
本版只支持由运维人员预先准备的外部 MySQL 8.4.x；安装器不会安装 MySQL、创建数据库容器或修改现有
|
||
PostgreSQL 18。PostgreSQL 兼容开发已冻结，不属于本次 Preview 发布范围。
|
||
|
||
执行命令的机器需预装 `bash`、`sudo`、`curl`、`mktemp` 和 `sha256sum`，并能访问目标 Gitea；`jq` 和 Java
|
||
由安装器补齐；Java 17 优先使用服务器已有运行时，没有合适版本时才从官方 Azul 下载。数据库服务和数据库客户端均不会被安装。默认首次安装向导直接使用 JDBC 连接浏览器中填写的
|
||
外部数据库，不需要服务器安装 MySQL CLI。应用固定安装到 `/opt/kaidi`、`/var/lib/kaidi`、
|
||
`/var/lib/kaidi-update` 和 `/etc/kaidi`。安装器不安装、不启动也不修改 Nginx、Caddy、宝塔或其他反向代理。
|
||
|
||
### 直接 curl 安装
|
||
|
||
```bash
|
||
curl -fsSL https://git.awaioi.com/ERP-Team/kaidi/releases/download/v1.0.0-preview.19/install.sh | sudo bash
|
||
```
|
||
|
||
这条命令会提示填写 Java 应用端口，直接回车使用 `18080`；随后安装最新签名 Release，并默认进入 `/setup`
|
||
安装向导。Java 默认只监听 `127.0.0.1:所选端口`，前端页面、API 和健康检查均由同一端口提供。无人值守安装可直接指定：
|
||
|
||
```bash
|
||
curl -fsSL https://git.awaioi.com/ERP-Team/kaidi/releases/download/v1.0.0-preview.19/install.sh \
|
||
| sudo env KAIDI_APP_PORT=19090 bash
|
||
```
|
||
|
||
端口必须在 `1024-65535` 范围且未被其他程序监听；安装器会在安装前检查冲突。只有明确需要让其他主机直连 Java
|
||
时才设置 `KAIDI_SERVER_ADDRESS=0.0.0.0`，通常应保持默认回环绑定并由本机反向代理访问。需要在执行前独立校验安装脚本时使用：
|
||
|
||
```bash
|
||
curl -fsSL https://git.awaioi.com/ERP-Team/kaidi/releases/download/v1.0.0-preview.19/install.sh -o /tmp/kaidi-install.sh
|
||
printf '%s %s\n' bc9001197af843dc323907a98023064ccc4f184e000543d2086b8a6f8161dbc7 /tmp/kaidi-install.sh | sha256sum -c -
|
||
sudo bash /tmp/kaidi-install.sh
|
||
rm -f /tmp/kaidi-install.sh
|
||
```
|
||
|
||
### 从固定 Git tag 拉取后安装
|
||
|
||
需要保留源码快照时，可以拉取与 Release 对应的固定 tag，再运行仓库内包装器。公共仓库不要求凭据，
|
||
包装器会在 `sudo` 前校验 `deploy/install.sh` 的固定 SHA-256，再按同一公钥信任链安装最新签名 Release。
|
||
|
||
```bash
|
||
git clone --branch v1.0.0-preview.19 --depth 1 https://git.awaioi.com/ERP-Team/kaidi.git kaidi-preview
|
||
cd kaidi-preview
|
||
./deploy/install-from-git.sh
|
||
```
|
||
|
||
首次安装使用向导时不要传 `KAIDI_DB_URL`、`KAIDI_DB_USERNAME` 或 `KAIDI_DB_PASSWORD`；这些值在浏览器中填写。
|
||
只有已完成安装的修复性重装才从运行时配置读取数据库值，详见下文。
|
||
|
||
安装器会完成以下动作：
|
||
|
||
- 仅在 Linux + systemd 环境执行；首版 32 位支持基线为带 systemd 的 Debian/Ubuntu x86 32 位 Linux。
|
||
- 不安装或创建数据库；在 `/setup` 中连接运维人员预先准备的外部 MySQL 8.4.x。
|
||
- 识别 `x86_64`、`aarch64`、`armv7` 或 32 位 `i386/i486/i586/i686`；已有 Java 17 直接复用，否则校验 SHA-256 后下载对应的官方 Azul Java 17 JRE。
|
||
- 使用安装器内置的 SHA-256 指纹校验 Release 公钥，再用该公钥验证发布清单 RSA 签名。
|
||
- 首次安装默认启用 `/setup` 向导，不在命令行保存数据库密码；向导只接受 MySQL 8.4.x，并在提交前验证完整迁移权限。
|
||
- 安装签名 Release 到 `/opt/kaidi/releases/<version>`，以 `/opt/kaidi/current` 原子切换当前版本。
|
||
- 安装 `kaidi-finance.service`、更新监听服务和健康检查；Java 同时托管 TDesign 前端静态资源及 Vue 路由回退。
|
||
- 向导只初始化一个由操作者填写的 `SYSTEM_ADMIN` 管理员，不创建项目、财务、资料或演示账号。
|
||
- 安装器把一次性安装码写入仅 root 可读的 `/root/kaidi-first-login.txt`；完成向导后写入锁定标记并切换正式应用。
|
||
|
||
安装完成后先执行 `sudo cat /root/kaidi-first-login.txt`，其中会显示准确的反向代理目标和一次性安装码。配置反向代理后，
|
||
通过域名的 `/setup` 完成数据库和管理员配置，再访问域名根路径登录。Preview 使用 HTTP 时安装器默认设置
|
||
`SESSION_COOKIE_SECURE=false`；配置 HTTPS 反向代理后，应在 `/etc/kaidi/kaidi.env` 改为
|
||
`SESSION_COOKIE_SECURE=true` 并执行 `sudo systemctl restart kaidi-finance`。
|
||
|
||
以安装端口 `19090` 为例，Nginx 只需代理到 Java，不需要单独托管前端文件：
|
||
|
||
```nginx
|
||
location / {
|
||
proxy_pass http://127.0.0.1:19090;
|
||
proxy_http_version 1.1;
|
||
proxy_set_header Host $host;
|
||
proxy_set_header X-Real-IP $remote_addr;
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_set_header X-Forwarded-Proto $scheme;
|
||
proxy_connect_timeout 10s;
|
||
proxy_read_timeout 120s;
|
||
client_max_body_size 500m;
|
||
}
|
||
```
|
||
|
||
宝塔、Caddy 或云网关使用同一个上游地址 `http://127.0.0.1:所选端口`。安装后执行以下命令确认应用和首次登录信息：
|
||
|
||
```bash
|
||
curl -fsS http://127.0.0.1:19090/actuator/health | jq -e '.status == "UP"'
|
||
sudo systemctl --no-pager --full status kaidi-finance kaidi-update.path
|
||
sudo cat /root/kaidi-first-login.txt
|
||
```
|
||
|
||
### Linux 32 位
|
||
|
||
应用已按 Java 17 字节码构建，安装器会在 32 位 Linux 下载 `i686` JRE。MySQL 8.4 没有可用于该部署方式的
|
||
32 位服务端镜像，因此 32 位主机需要预先连接一台 MySQL 8.4 数据库，之后仍然只执行一个安装命令：
|
||
|
||
```bash
|
||
curl -fsSL https://git.awaioi.com/ERP-Team/kaidi/releases/download/v1.0.0-preview.19/install.sh | sudo bash
|
||
```
|
||
|
||
无论主机架构如何，安装器都不会安装 MySQL、数据库客户端或创建数据库容器。在打开向导前，需要预先创建 `kaidi_finance`，并授予安装账号该库的
|
||
完整迁移权限。向导会连接数据库、核验 MySQL 8.4.x 版本，并实际探测建表、改表、索引、外键、存储过程、
|
||
临时表及读写权限；专用数据库不是 `utf8mb4/utf8mb4_0900_ai_ci` 时，向导会在迁移前自动统一默认字符集和
|
||
排序规则，全部通过后 Flyway 才会建表。
|
||
数据库管理员可在 MySQL 8.4 中按实际应用服务器地址执行以下基线 SQL：
|
||
|
||
```sql
|
||
CREATE DATABASE kaidi_finance CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;
|
||
CREATE USER 'kaidi'@'KAIDI_SERVER_IP' IDENTIFIED BY 'DB_PASSWORD';
|
||
GRANT ALL PRIVILEGES ON kaidi_finance.* TO 'kaidi'@'KAIDI_SERVER_IP';
|
||
```
|
||
|
||
### 修复性重装
|
||
|
||
正常升级统一使用后台“在线更新”。只有安装文件损坏且后台更新不可用时，才在原服务器执行修复性重装；
|
||
安装器会优先读取向导完成后生成的 `/var/lib/kaidi/setup/application.env`，再回退到 `/etc/kaidi/kaidi.env`，保留数据库、字段加密密钥、
|
||
管理员数据和运维人员新增的环境变量：
|
||
|
||
```bash
|
||
curl -fsSL https://git.awaioi.com/ERP-Team/kaidi/releases/download/v1.0.0-preview.19/install.sh \
|
||
| sudo env KAIDI_REINSTALL=true KAIDI_SETUP_WIZARD=false bash
|
||
```
|
||
|
||
没有显式设置 `KAIDI_APP_PORT` 时，修复性重装会沿用 `/etc/kaidi/kaidi.env` 中的原端口。重装失败会恢复原应用链接、Java 运行时、环境文件和 systemd 单元；脚本会明确报告回滚不完整，
|
||
不会把恢复失败吞掉。
|
||
|
||
如果安装器已完成但向导尚未提交，可执行下面的命令重新生成一次性安装码；该恢复路径只接受仍处于向导模式且未锁定的安装，正式模式不会被覆盖。
|
||
|
||
```bash
|
||
curl -fsSL https://git.awaioi.com/ERP-Team/kaidi/releases/download/v1.0.0-preview.19/install.sh \
|
||
| sudo env KAIDI_REINSTALL=true bash
|
||
```
|
||
|
||
### 停用并移除程序
|
||
|
||
以下命令移除应用程序和服务，但保留 `/var/lib/kaidi`、`/var/lib/kaidi-update`、`/etc/kaidi` 以及数据库，
|
||
便于审计、备份或重新安装。确认数据备份前不要删除这些保留目录或外部 MySQL 数据。
|
||
反向代理由运维人员独立管理，停用程序不会修改其配置。
|
||
|
||
```bash
|
||
sudo systemctl disable --now kaidi-update.path kaidi-update.service kaidi-finance.service
|
||
sudo rm -f /etc/systemd/system/kaidi-finance.service /etc/systemd/system/kaidi-update.service /etc/systemd/system/kaidi-update.path
|
||
sudo systemctl daemon-reload
|
||
sudo rm -rf /opt/kaidi
|
||
```
|
||
|
||
## Release 与在线更新
|
||
|
||
首次建立发布仓库时生成一次签名密钥：
|
||
|
||
```bash
|
||
./scripts/generate-release-key.sh release-signing-private.pem
|
||
base64 < release-signing-private.pem | tr -d '\n'
|
||
```
|
||
|
||
将私钥的 Base64 内容保存为 Gitea Actions Secret `RELEASE_SIGNING_KEY_B64`，并将命令输出的公钥 SHA-256
|
||
保存为 Gitea Actions Variable `KAIDI_RELEASE_PUBLIC_KEY_SHA256`。Gitea 发布 Token 只用于该工作流创建
|
||
Release；生产服务器从公共 Release 下载，不保存 Token。私钥不得提交到 Git。`.gitea/workflows/release.yml` 要求
|
||
act_runner 提供 `ubuntu-24.04` 标签，并在 tag 发布时执行后端、前端、OpenAPI、Shell、安装/更新和浏览器门禁。
|
||
|
||
工作流先建立不可见草稿，再显式上传并核对 9 个资产的名称和大小，最后才发布为 `/releases/latest`。Gitea 的
|
||
`latest` 会排除 `prerelease=true`，因此即使 tag 名含 `preview`，发布记录的 `prerelease` 也固定为 `false`；
|
||
Preview 属性由 SemVer 版本名表达。之后推送 tag 即会构建、测试、签名并发布：
|
||
|
||
```bash
|
||
git tag v1.0.0-preview.19
|
||
git push origin v1.0.0-preview.19
|
||
```
|
||
|
||
在线更新使用独立的 TDesign 页面：隔离的系统管理员进入“系统治理 → 系统更新”。权限与配置页只管理用户、角色、数据范围、表单模板和参数版本，不配置系统名称或域名。
|
||
更新源由 root 在 `/etc/kaidi/update.env` 固定为公共 Gitea Latest Release API；页面和普通 API 不能提交
|
||
URL、Token、脚本或命令。更新流程固定为：
|
||
|
||
1. 点击“获取更新”，后端先读取 Release 元数据，再自动排队 `DOWNLOAD`；root 更新器从 Gitea 下载 manifest、签名和应用包，执行 RSA、
|
||
SHA-256、版本、文件名和压缩包路径校验后缓存到 `/var/lib/kaidi-update/cache/<version>`。业务服务不停机。
|
||
3. 页面显示 `READY/等待重启` 后才出现“立即重启”；管理员点击后提交安装。未缓存或版本不一致
|
||
的包不能进入安装。
|
||
4. 安装请求持久领取到 `/var/lib/kaidi-update/processing`；进程或主机中断后由 systemd 恢复未完成事务。
|
||
5. root 更新器重新验签和验哈希，确认 `mysqldump` 成功并生成权限为 `0600` 的备份，默认保留最近 5 份。安装器不安装
|
||
`mysqldump`；启用在线更新前，运维人员须自行在应用服务器预装与外部 MySQL 兼容的 `mysqldump`。
|
||
6. 校验更新脚本和 systemd 单元后，原子切换 updater、systemd 和应用版本，不修改反向代理。
|
||
7. 同时检查 Java 健康端点、更新 path unit 和 Java 托管的静态首页。全部通过后页面显示 10 秒倒计时并自动
|
||
刷新；刷新或短暂断线发生在安装中时，页面会恢复 3 秒轮询。任一检查失败则恢复并验证上一版本。
|
||
|
||
忙碌期间检查、下载和安装按钮保持禁用，防止重复请求；这就是更新执行冷却。10 秒只用于成功后的页面刷新，
|
||
不会延迟服务端切换。systemd 在 300 秒内连续失败 3 次后停止自动重试，避免失败任务空跑。
|
||
|
||
安装器会把公共 API 地址写入 root-only 的 `/etc/kaidi/kaidi.env` 与 `/etc/kaidi/update.env`，两者权限均为
|
||
`0600`：前者供 Java 后端“检查更新”读取，后者供 root 更新器下载资产。默认 Token 为空；如改接私有镜像，
|
||
可由运维人员在这两个文件中配置独立只读 Token，Token 不写入页面、状态 JSON、审计参数或更新日志。
|
||
|
||
数据库迁移必须保持至少一个版本的向后兼容。查看状态和日志：
|
||
|
||
```bash
|
||
sudo systemctl status kaidi-finance kaidi-update.path
|
||
sudo journalctl -u kaidi-update.service -n 100 --no-pager
|
||
cat /var/lib/kaidi-update/status.json
|
||
```
|
||
|
||
如果 `status.json` 显示 `FAILED` 且日志提示回滚未完成，不要删除
|
||
`/var/lib/kaidi-update/processing/request.json` 或活动事务目录。systemd 在 300 秒内连续失败 3 次后会停止自动重试，
|
||
修复日志所示的磁盘、权限或旧版本健康问题后执行：
|
||
|
||
```bash
|
||
sudo systemctl reset-failed kaidi-update.service kaidi-update.path
|
||
sudo systemctl start kaidi-update.service
|
||
sudo journalctl -u kaidi-update.service -n 100 --no-pager
|
||
cat /var/lib/kaidi-update/status.json
|
||
```
|
||
|
||
只有状态恢复为 `SUCCEEDED`、`CURRENT` 或确定性的终态 `FAILED`，且 `transactions/active` 已处理完成后，
|
||
才算本次恢复结束。后台会保留真实失败状态，不会把待恢复的 processing 请求误显示成普通排队。
|
||
|
||
## 手工生成 Release
|
||
|
||
```bash
|
||
KAIDI_RELEASE_SIGNING_KEY=/secure/release-signing-private.pem \
|
||
KAIDI_TRUSTED_RELEASE_PUBLIC_KEY_SHA256=807c6aec1dc3f7ce494db16aa9d763c66f292033c38f328afd0390d2715a8cd9 \
|
||
./scripts/package-release.sh 1.0.0-preview.19
|
||
KAIDI_TRUSTED_RELEASE_PUBLIC_KEY_SHA256=807c6aec1dc3f7ce494db16aa9d763c66f292033c38f328afd0390d2715a8cd9 \
|
||
./scripts/verify-release.sh dist/release
|
||
```
|
||
|
||
输出位于 `dist/release/`，包含安装脚本、签名清单、公钥、SHA-256 清单、前后端 CycloneDX SBOM、
|
||
首次安装指纹文件和完整应用压缩包。
|
||
打包脚本会把 Maven `revision` 与 npm 包版本临时绑定到 Release SemVer，构建结束后恢复工作区源文件；
|
||
JAR、两个 SBOM、签名清单或 tag 的版本只要有一项不一致，发布即失败。
|
||
签名清单同时绑定应用包、两份 SBOM、安装器、公钥、bootstrap 指纹和 Git 源码修订；本地脏工作区会明确记录
|
||
`source.dirty=true`，tag 工作流只接受干净 checkout 并记录 `source.dirty=false`。
|
||
发布命令同时在终端输出 `Trusted release public-key SHA-256` 与 `Installer SHA-256`；把这两个值写入
|
||
受控部署记录，再替换上述一键安装命令中的占位符。
|