12 KiB
12 KiB
头程与海外仓后端项目指引
适用范围与定位
- 本文件适用于
baiyue-firstleg/Maven 多模块仓库,包含国内头程与海外区域服务;进入具体服务后继续读取该服务的AGENTS.md。 - 本层只负责:服务边界、跨服务契约、数据库部署总入口、阶段路由和通用验证。Controller、Service、DTO、SQL 细节以模块级指引为准。
- 普通任务先读本文件和目标模块指引;聚合构建/架构问题再读
README.md、pom.xml、docs/头程项目目录结构与服务说明.md。 - 平台/客户层级与权限公共语义见
../docs/平台客户层级与权限契约.md;国内/海外 Token、双区域 API 和跨区事件公共契约见../docs/跨区域认证与服务通信契约.md。本文件只保留后端执行所需摘要。
不可突破的产品与数据边界
- 当前产品只有“平台—客户”两级。
tenant_id=0是平台技术作用域;tenant_id>0是客户隔离键,不得新增租户切换、租户选择或租户级 RBAC。 - 公共仓库、往来单位、快递、托盘、库位统一归属
tenant_id=0;订单、文件、费用等客户数据按客户tenant_id>0隔离。不得跨库 Join 或信任客户端客户 ID。 - 国内订单交易状态归
order,头程履约/入库状态归firstleg,财务账期、账单、收款、成本与核销归finance,国内仓储资源归warehouse;海外尾程订单、入仓计划、库存业务与海外本土业务归lastleg-service,海外仓库/库位/托盘资源归warehouse-overseas-service,海外公网入口归gateway-overseas。文件对象归file,第三方适配归integration-service;跨服务通过内部客户端、DTO、事件和服务令牌协作。 - 普通业务成功/失败使用 HTTP 200 + body
code(成功为字符串"200");认证、基础设施和网关拒绝可使用真实 401/403/503。
服务路由(按关键词定位)
| 任务关键词 | 首选服务 | 先看入口 |
|---|---|---|
| 登录、Token、密码、注册 | auth/ |
auth/AGENTS.md |
| 客户档案、成员、审核、RBAC、授权快照 | iam/ |
iam/AGENTS.md |
| 消息中心、站内通知、消息模板、收件箱 | iam/ |
iam/AGENTS.md,再按 src/main/java/com/baiyue/iam/notification/ 定位;业务事件生产者回到所属服务 |
| 订单、货物、快照、状态、幂等、Outbox | order/ |
order/AGENTS.md |
| 履约分配、入库、测量、审核、FBA 计费 | firstleg/ |
firstleg/AGENTS.md |
| 分柜、柜次、智能排柜、预装/装柜清单、PDA | firstleg/ |
firstleg/AGENTS.md,再按 split/、loading/、outbound/ 定位 |
| 订舱、船期、拖车、报关 | firstleg/ |
oceanbooking/、portschedule/、outbound/dispatch/、customs/ |
| 客户账期、费用池、账单、收款、成本、核销 | finance/ |
finance/AGENTS.md;费用来源和柜次成本快照再联查 firstleg/AGENTS.md,凭证再联查 file/AGENTS.md |
| 入库/柜次应付、直接已付、付款流水与凭证 | firstleg/、finance/、file/ |
业务费用与付款快照见 firstleg/AGENTS.md 的 FeePaymentSnapshotValidator;/api/platform/finance/v1/vouchers 上传凭证,File 按 FINANCE_VOUCHER 和客户范围校验 |
| 仓库、往来单位、快递、托盘、库位 | warehouse/ |
warehouse/AGENTS.md |
| 供应商、国内整柜库存与出入库 | warehouse/ |
warehouse/AGENTS.md;OpenAPI warehouse/src/main/resources/openapi/supplier-v1.yaml、domestic-container-v1.yaml |
| 客户运营统计、在途柜量 | firstleg/ |
firstleg/AGENTS.md;OpenAPI firstleg/src/main/resources/openapi/customer-statistics-v1.yaml |
| 平台操作日志与审计查询 | audit-service/ |
audit-service/AGENTS.md;平台查询接口 /api/platform/v1/audit/logs |
| 资质、导出、测量图片、文件下载 | file/ |
file/AGENTS.md |
| 路由、CORS、JWT 入口、访问域 | gateway/ |
gateway/AGENTS.md |
| 百度/Amazon/OCR/第三方适配 | integration-service/ |
integration-service/AGENTS.md |
| 海外 API 路由、海外 Token、Audience/JWKS | gateway-overseas/ |
gateway-overseas/AGENTS.md |
| 尾程订单、海外入仓计划、换标、库存、采购、本土卡车 | lastleg-service/ |
lastleg-service/AGENTS.md,再按 inboundplan/、relabel/、inventory/、procurement/、trucking/ 定位 |
| 海外入仓分页、FBA 预约、PDA 卸柜照片 | lastleg-service/ |
inboundplan/controller/InboundPlanController.java、InboundPlanQueryMapper.java、InboundFbaAppointmentService.java、inboundplan/pda/ |
| 海外仓 PDA 到仓、卸柜、实收、上架、合托 | lastleg-service/、warehouse-overseas-service/ |
业务流程 lastleg-service/inboundplan/pda/;库位、托盘和资源锁归 warehouse-overseas-service/;设备端 ../apps/pda-overseas-uniapp/,公网入口 gateway-overseas/ |
| 海外仓库、海外库位、海外托盘、资源锁 | warehouse-overseas-service/ |
warehouse-overseas-service/AGENTS.md |
| PDF 标签、审计、跨区双向事件 | print/、audit-service/、event-bridge-service/ |
事件模型先读 common-event-contract/AGENTS.md;可靠投递与 CN/OVERSEAS 目标路由读 event-bridge-service/AGENTS.md |
公共模块快速索引
| 关键词 | 模块与入口 |
|---|---|
| 公共依赖版本 | platform-bom/pom.xml;统一管理公共组件版本,不放业务实现 |
| 通用响应、分页、异常、基础实体与导出契约 | common-core/;从 ApiResponse.java、PageResult.java、BizException.java、ExportContracts.java 定位 |
| Web 异常、请求关联 ID、Long ID 序列化 | common-web/;从 GlobalExceptionHandler.java、CorrelationIdFilter.java、LongIdJacksonConfiguration.java 定位 |
| JWT、JWKS、会话校验与认证用户 | common-security/;从 JwtAuthenticationFilter.java、JwtClaimsMapper.java、AccessTokenSessionValidator.java 定位 |
| Springdoc/OpenAPI 自动配置 | common-openapi/;从 BaiyueOpenApiAutoConfiguration.java、OpenApiProperties.java 定位 |
| 业务审计注解、脱敏、Outbox 与投递 | common-audit/;从 BusinessAudit.java、BusinessAuditAspect.java、SensitiveDataSanitizer.java、AuditOutboxPublisher.java 定位 |
| 跨区域事件信封、Payload 与哈希 | common-event-contract/;继续读该目录 AGENTS.md |
全量验收路由
- 当前一期、二期、三期及财务统一进入全量验收;按本次链路读取对应阶段/专题文档,不以历史阶段终点阻断跨服务联调或回归。
auth、iam、warehouse、order、firstleg、file、finance、integration-service及出仓相关能力按各自模块契约协作;状态、权限、数据库和 OpenAPI 以当前实现及已确认契约为准。
国内头程与海外仓协同
- 国内头程 Auth 是唯一用户账号和 Token 签发方;Admin/Client 共用一套前端和用户体系,海外仓不得另建登录或权限模型。
- 统一使用 RS256/JWKS。国内登录/刷新时由 Auth 同时签发国内 Token 和短时海外 Token;前端统一认证层按国内/海外 API Base 自动选择。国内服务叠加 Redis 会话校验,海外服务不得访问国内 Redis,只按限定 Audience 的海外 Token Claims 完成本地认证和授权;海外业务请求不得经国内 Gateway 中转。
- 头程装柜完成向海外建尾程单、海外 PDA 卸柜完成向国内回写货柜报空事实,以及后续费用来源和财务回传,统一走 MQ Outbox/Inbox 事件链;事件不携带用户 JWT,服务身份由 MQ TLS/ACL 或内部服务令牌负责。跨区事件契约、幂等和死信分别查
common-event-contract/、event-bridge-service/与目标消费者。 - 海外浏览器请求只进入
gateway-overseas/,由其路由到lastleg-service/、warehouse-overseas-service/及海外部署的公共服务;不得经国内gateway/中转。lastleg-service不读取头程数据库,warehouse-overseas-service不读取尾程订单库。
契约、数据库与验证入口
- 跨服务修改先检查调用方
client/、被调用方 Controller/DTO、src/main/resources/openapi/和双方契约测试;禁止共享领域 Entity。 - 修改 Java 方法、构造器、Controller、Client、DTO 或 Mapper 参数签名时,先用
rg定向查找符号及旧参数形态,并同步更新src/main/、src/test/、Mock、Fixture、契约测试和脚本中的全部调用点。新增可选参数也必须补齐旧测试调用,不能因生产调用已更新就视为完成。 - 平台后台存在正式列表页时,
*:list同时授权列表、详情及只读辅助接口;create、edit、delete、status、approve、review、export、upload、complete等操作保持独立。当前未上线,不兼容旧独立*:view,Controller 不得使用hasAnyAuthority(list, view),OpenAPI 和角色初始化只保留*:list。 - 供应商查询接口固定只使用
platform:supplier:list;IAM 中platform:supplier:list是正式菜单资源,platform:supplier:view必须停用/移除,不得重新提升或兼容。 - 权限语义变更必须同步 Controller
@PreAuthorize、OpenAPI、模块权限 SQL、IAM 菜单资源、统一增量脚本和契约测试。并行模块任务不得覆盖菜单与权限总控已写入共享 SQL 或权限契约的改动。 - 数据库只访问所属服务库。模块表结构位于
<module>/src/main/resources/db/;当前开发阶段直接更新最新模块基线和deploy/sql/头程数据库统一增量-MySQL8.sql,不为历史开发数据新增兼容迁移。已有名称含migration的脚本仅作现有结构来源和开发追溯,部署说明见deploy/sql/README.md。 - 通用配置在
config/nacos/{local,cn}/;服务日志、上传文件、target/、reports/不属于源码。 - Java 签名变更的最低编译门禁是
mvn -pl <module> -am test-compile,它必须在部署前完成并覆盖测试源码;有行为变化时继续运行mvn -pl <module> -am test。-DskipTests可跳过测试执行但仍须保留测试编译,-Dmaven.test.skip=true会跳过测试编译,不得作为签名变更的交付验证。全量验证仍使用mvn -DskipTests validate、mvn test;不要在本地启动 Java/Nacos/数据库,除非用户明确要求。 AGENTS.md索引维护完成后运行./scripts/agents-index-contract.ps1;脚本只读源码目录和指定指引,验证部署单元、模块覆盖、关键入口与排除目录,不访问 HTTP、数据库或部署环境。
全量 HTTP 验收脚本路由
- 全量验收唯一指向测试环境 HTTP:平台端执行
scripts/admin-test-env-acceptance.mjs,客户端执行scripts/client-test-env-acceptance.mjs;二期专项场景才单独执行scripts/client-phase2-test-env-acceptance.mjs,不替代客户端全量入口。 - Admin 总入口默认按模块列表覆盖平台全链路;需要定位单个业务时使用
--modules <name>,模块名称和静态合同先查scripts/admin-test-env-modules/README.md。 - 这些脚本会创建、更新或最终停用测试数据,必须在当前对话明确授权测试环境验收后执行,并保存 JSON 报告;未授权不得请求 Gateway。
- 后端 Maven、前端
pnpm test/typecheck、PDAnode --test和数据库 Dry-run 都是本地质量检查,不属于全量 HTTP 验收。 - HTTP 全量通过后,才进入 Admin/Client 真实页面调用、浏览器样式和 PDA 页面/设备验收;自动化 HTTP 通过不代表视觉验收完成。
阶段文档入口
- 一期:
../docs/一期/README.md、../docs/一期/一期头程订单闭环设计.md - 二期:
../docs/二期/README.md、../docs/二期/二期需求优化版-v2-测量计费入库主流程.md、需求确认清单及联调报告 - 三期:
../docs/三期/README.md、../docs/三期/三期开工门禁.md、../docs/三期/三期开发规划.md、../docs/三期/三期需求确认表.md、页面与原型清单 - 四期:
../docs/四期/README.md;海外入口gateway-overseas/,尾程与入仓库存lastleg-service/,海外仓储资源warehouse-overseas-service/ - 财务:
../docs/财务管理/README.md中已确认的范围、对象、状态和接口约束
全量验收任务再读取对应阶段进度表、验收报告和证据矩阵;普通代码定位只读取当前链路涉及的范围、契约、模块指引和代码。