Appearance
实施交付
实施顺序
- 准备数据库、Redis、文件存储目录和后端配置。
- 启动后端,让 Flyway 完成 baseline 与后续迁移。
- 初始化组织、角色、用户、菜单授权和必要业务基础数据。
- 如启用文档在线编辑,先部署 ONLYOFFICE,再联调 OARS 回调。
- 如涉及源码交付,确认产品基线、客户仓库或分支、客户二开补丁、数据库脚本、配置模板和发布说明。
- 最后用 Swagger、健康检查、前端入口和关键业务流程做验收。
关键前置条件
- 后端默认上下文为
/oars,端口默认8080。 - 开发配置使用 MySQL
localhost:3306/oars(MySQL 8.0+,Flyway 要求)、Redislocalhost:6379(dev 密码redis123)。 - 文件默认本地存储,路径为
./uploads。 - Flyway 迁移脚本使用版本化命名,扫描位置为
classpath:db/migration。 - 源码交付需要使用客户分支、私有 fork 或客户交付仓库固化版本,不使用未提交工作区作为交付依据。
- 客户二开必须保留 commit、变更说明、数据库脚本和升级影响判断,不能用覆盖源码的方式升级。
检查项
/oars/actuator/health返回健康状态。/oars/swagger-ui.html可打开接口文档。flyway_schema_history中 baseline 和后续迁移成功。- 管理员角色拥有文档中心、组织、角色、菜单等必要权限。
- Docker 部署场景下,前端、后端、MySQL、Redis 容器健康检查通过,数据卷和
.env已归档。 - 客户源码交付已打客户 tag,构建产物、数据库脚本、配置模板、发布说明和回滚方案已归档。
- 如包含源码插件,执行
plugin:delivery-check,确认 manifest、delivery descriptor、SQL 和生成文件完整。
配置参考
后端主配置位于 application.yml,开发配置在 application-dev.yml。生产环境需覆盖数据库连接、Redis、JWT 密钥等配置项。
生产环境的数据库、Redis、文件存储、域名、HTTPS、反向代理和备份策略需按客户实际环境配置。
相关文档
L2 详细说明(monorepo)
实施链路的权威专篇在 oars-java/,本站仅摘要:
| 主题 | L2 文档 | oars-docs 摘要 |
|---|---|---|
| 多环境配置 | CONFIG.md | 部署 |
| Redis | REDIS-SETUP-GUIDE.md | 部署 |
| 数据库 | DATABASE-GUIDE.md | 数据库运维 |
| Flyway | oars-migration/README.md | 迁移、Flyway 排障 |
| 认证 | AUTH-GUIDE.md | 后端约定 |
| 文件存储 | FILE-STORAGE-GUIDE.md | 后端约定 |
| 消息 / IM | MESSAGE-MODULE-DESIGN.md | 消息中心、即时通讯 |
