Skip to content
bitzorcas
中EN

Guide

业务模块开发与扩展指南

深入解析 BitzOrcas.Modern 业务模块架构规范、ADR 0203 物理隔离准则、ADR 0205 平台扩展模式与 Sandbox 黄金样例。

Last updated

业务模块开发与扩展指南 (Business Modules Guide)

在基于 BitzOrcas.Modern 构建企业级业务系统(如律所管理、诉讼协同、金融风控或电商中台)时,业务模块(Business Modules) 是所有定制业务逻辑、专有聚合根与行业用例的唯一合法落地点。

依据 ADR 0203(物理目录结构)与 ADR 0205(商业包交付与客户扩展模型),业务系统严禁直接修改或侵入框架底座(src/Framework)与模板平台能力(src/Platform)源码,所有业务特性均需在 src/Modules/** 独立物理目录下构建。


1. 物理目录结构与防腐隔离 (ADR 0203)

src/Modules/ 业务模块规划示例源码顶级物理分层仅依赖 Contracts / 扩展端口基于核心管线

src/Framework/ (纯技术底座,零业务依赖)

src/Platform/ (36 个平台能力子系统,商业包交付)

src/Modules/ (客户业务专属模块空间)

src/Modules/Litigation/ (诉讼案件域)

src/Modules/Contracts/ (合同审查域)

src/Modules/Evidence/ (电子存证域)

src/Modules/Sandbox/ (模板内置黄金样例)

1.1 模块目录命名规范

  • 业务分组路径:src/Modules/<DomainCategory>/<ModuleName>/
  • 四层物理工程推荐结构:
    1. BitzOrcas.Modules.<ModuleName>.Contracts:对外发布的 DTO、接口与集成事件;
    2. BitzOrcas.Modules.<ModuleName>.Domain:聚合根、实体、值对象与领域事件;
    3. BitzOrcas.Modules.<ModuleName>.Application:CQRS Command/Query、Mediator Handler、IRequestRule<T> 校验规则;
    4. BitzOrcas.Modules.<ModuleName>.Infrastructure:SqlSugar / EF Core 双 ORM 仓储适配器、持久化模型与 Outbox 发布器。

2. 平台能力消费与扩展范式 (ADR 0205)

业务模块与平台能力之间遵循严格的深模块(Deep Module)单向依赖原则:

Platform 内核 (已签名商业包)CAP Outbox (RabbitMQ)Platform Contracts业务用例 (Modules.Litigation)Platform 内核 (已签名商业包)CAP Outbox (RabbitMQ)Platform Contracts业务用例 (Modules.Litigation)1. 同步契约调用 (仅依赖公开 Contracts)2. 异步事实解耦 (通过版本化集成事件)引用 IAIConversationPort / IFileStoragePort1发起 Mediator 命令或端点调用2返回强类型 Result<T> (严禁暴露内部实体)3发布 UserCreatedIntegrationEvent4消费事件并初始化律师办案空间5
扩展方式适用场景架构原则
Contracts 引用业务模块需要调用身份、文件、通知等平台能力仅允许 ProjectReference 或 PackageReference 引用 *.Contracts,架构测试静态拦截对 .Application / .Infrastructure 的引用
集成事件驱动 (CAP Outbox)跨模块状态同步与流程联动遵循 ADR 0304,使用 RabbitMQ + CAP Outbox 传递版本化集成事件,保证分布式最终一致性
动态验证策略 (Strategy)租户级定制业务规则或特殊准入逻辑注册 ITenantValidationStrategy<TRequest>,在 Pipeline 中实现热配置多租户合规拦截(ADR 0403)
Store 端口替换业务专有数据持久化与复杂报表读模型实现模块特定的 Store 接口,在 Host 组合根中无缝覆盖默认 Adapter

3. 业务模块扩展核心专栏导航

为指导工程团队从零搭建生产级业务域,本专题包含以下核心实践篇章:

  1. Sandbox 黄金样例全景拆解:三层物理工程划分、CQRS 读写分离、聚合根实体与不可篡改错误字典;
  2. 模块生命周期与 Modularity 引擎:拓扑排序依赖解析、依赖注入自动接线与中间件挂载;
  3. Profiles 多租户定制与元包发行机制:按客户版本、部署规模与场景按需装配业务模块的元包架构。

4. 平台内置能力一览

开发业务模块时,请优先复用平台已有的 36 项成熟基础设施与领域能力,避免重复造轮子:

前往平台能力中心浏览 36 个平台模块详情

包括:

100%

滚轮或按钮缩放 · 放大后拖动画面 · 双击切换 100% / 200%