Skip to content

生成并运行业务项目 ​

Kaiwu 支持两种起步方式:方式一由产品先在独立前端仓做出可交互 Mock 再纳管生成配套后端;方式二在平台已启动时直接通过项目工厂生成前后端双仓。下文分别用设备预约(equipment-booking)和订单中心(order-center)举例,运行时请换成你自己的项目名称和编码。

方式一:产品先做前端,再纳管生成后端 ​

在 kaiwu-web-starter 根目录运行以下命令(需要 Git、Node 22、pnpm 10,无需先启动 Kaiwu 平台)。默认初始化空白项目;若要体验内置的双人设备预约演示,在首条命令末尾加上 --example booking:

bash
node scripts/kaiwu-init.mjs --code equipment-booking --name 设备预约
cd ../equipment-booking-web
pnpm install --frozen-lockfile
pnpm dev

打开终端打印的本地地址并访问 /__mock/ 选择演示身份,验证页面、规则与场景。产品在 product 分支验收并提交交接 MR 后,开发在已登录平台的入口仓执行纳管:

bash
./kaiwu login --client "project-development"
./kaiwu project adopt ../equipment-booking-web
./kaiwu project adopt ../equipment-booking-web --apply
  • 不带 --apply 只预览将登记的项目、前端清单与首次导入的角色,零写入;加上 --apply 后自动建项、同步清单与 roles.yml,并在同级目录生成配套后端 ../equipment-booking-service(在网页「项目工厂」显示为 ADOPT_FRONTEND /「沿用已有前端」)。
  • 日常清单变更使用 ./kaiwu project sync ../equipment-booking-web(保留平台人工调整过的角色,除非显式加 --with-access);单独启用 Workflow 服务的项目还可用 ./kaiwu workflow sync ../equipment-booking-web 预览流程导入。前端纳管决策

方式二:在平台直接开通并生成双仓 ​

前置条件是平台可登录,操作账号有开通项目的权限。在网页选「项目管理 → 开通项目」,填写名称和编码;在「项目工厂」等待成功后,可分别下载前后端 ZIP。也可在入口仓目录用 CLI 操作:

bash
./kaiwu login --client "project-development"
./kaiwu whoami
./kaiwu project new order-center --name "Order Center" --package com.example.ordercenter
./kaiwu project status order-center --wait
./kaiwu project pull order-center
./kaiwu project-up ../business/order-center-service ../business/order-center-web

登录时在浏览器核对客户端名称并确认设备授权。本机初始账号也支持 login --local;本人已改密或免点击授权失败时,按终端给出的设备链接操作。若 order-center 已生成,从查询状态继续。每个编码成功生成一次,下载制品可重复取用。

订单中心的生成任务和两个下载入口

v0.2.0 已知问题:取回的项目可能缺少打包资源,或因前端配置文件权限而反复重启。即使启动命令返回成功,也请从工作台打开业务页并验证一次请求。排查时查看业务容器的状态和日志。启动修复进展

交付检查 ​

  • ../business/order-center-service/pom.xml 和 ../business/order-center-web/package.json(或纳管后的 ../equipment-booking-service 与 ../equipment-booking-web)分别位于独立 Git 仓。
  • project-up 构建两个服务、接入本机路由。回工作台点击项目,从 /apps/<项目编码>/ 打开;业务 API 经 /<项目编码>-api/。
  • 只有项目成员看得到相应入口。无法进入时,先核对入口地址、成员状态和角色,再看 Gateway 日志。
  • 用 ./kaiwu project-down <项目编码> 停止这个业务栈。业务源码在两个仓库中继续维护。

开发第一个业务功能 · 项目工厂契约

开发时打开前端 ​

无论是起步仓初始化还是项目工厂生成的前端,均内置两套本地启动模式:

  • 本地 Mock 演示(pnpm dev):默认启用 Umi 内置 Mock 运行时,打开 /__mock/ 切换演示角色、执行内存 CRUD 与重置数据;未注册路径返回 501,Mock 代码不会打入生产构建产物。
  • 真实网关联调(pnpm dev:real):同时将 /api、/{code}-api 与 /{code}-svc 转发给 Gateway(默认 http://127.0.0.1:8088,可用 KAIWU_GATEWAY 覆盖)。使用真实 projectId,优先从同源平台工作台进入以经由会话桥传递短期令牌;独立调试时可在启动前引导内存令牌。两个业务仓各自管理分支、评审和发布。

Apache License 2.0