前言
最近在看 coze studio 的源码,在它的开发规范里,写着 coze studio 基于领域驱动设计(DDD)原则架构实现的,DDD是个啥?我结合2021年我在内部多次分享后的总结再结合coze的源码详解下。之前的分享链接DDD应用架构内部分享 (之前是基于java的应用实践)
想要二开coze studio,最好了解下其架构模式,以及使用方法,和传统开发的区别还是比较大的。
从代码结构上看,coze studio 严格按照 DDD 的分层架构进行组织:
├── backend/ # 后端服务│ ├── api/ # API 处理器和路由│ ├── application/ # 应用层,组合领域对象和基础设施实现│ ├── domain/ # 领域层,包含核心业务逻辑│ ├── infra/ # 基础设施实现层│ ├── crossdomain/ # 跨领域防腐层│ ├── pkg/ # 无外部依赖的工具方法│ └── types/ # 类型定义
想要了解DDD,让我们从传统开发的弊病说起。
传统开发的弊病
在分析 coze studio 的 DDD 实践之前,先看看传统开发模式的问题:
1. 事务脚本模式的局限
传统开发往往采用面向过程的事务脚本模式,按照请求流程组织代码:
// 传统的事务脚本模式func CreateUser(req *CreateUserRequest) (*CreateUserResponse, error) { // 1. 参数校验 if req.Name == "" { returnnil, errors.New("name is required") } // 2. 查询数据库 user, err := userDAO.GetByName(req.Name) if err != nil { returnnil, err } // 3. 业务逻辑处理 if user != nil { returnnil, errors.New("user already exists") } // 4. 数据入库 newUser := &User{ Name: req.Name, CreateTime: time.Now(), } err = userDAO.Create(newUser) return &CreateUserResponse{UserID: newUser.ID}, err}
这种模式虽然简单直接,但随着业务复杂度增长,会出现严重问题:
- • 业务逻辑散落各处:同样的业务规则在多个地方重复实现
- • 代码变成"大泥球":各种逻辑混杂在一起,难以维护
- • 技术和业务耦合:一个场景一个服务,代码像流水线
- • 缺乏业务语言:技术人员和产品人员无法对齐
2. 以数据库为中心的设计
传统开发过于重视数据库,围绕数据库和数据模型进行建模:
// 传统的数据驱动设计type User struct { ID int64 `gorm:"primary_key"` Name string `gorm:"column:name"` Email string `gorm:"column:email"` CreateTime time.Time `gorm:"column:create_time"` UpdateTime time.Time `gorm:"column:update_time"`}func (u *User) CreateUser() error { return db.Create(u).Error}
这种设计的问题:
- • 贫血模型:对象只有数据,没有行为
- • 业务逻辑外泄:核心业务逻辑散落在 Service 层
- • 难以测试:业务逻辑与数据库紧耦合
DDD 是个啥
解决了什么
DDD (Domain-Driven Design) 领域驱动设计是对面向对象设计的改进,专门用于开发复杂业务逻辑的一种方式。它主要解决:
-
- 通用语言问题:让开发和业务在语言上统一
-
- 边界划分问题:通过限界上下文来划分,在不同的情景下域的作用是不同
-
- 领域模型问题:业务模型独立且模型具备可测试性
-
- 技术独立性:技术实现独立,可以随着业务的发展不断地更迭
战略设计 vs 战术设计
DDD 分为两个层面的设计方法: 战略设计 (Strategic Design):关注业务架构和领域边界
- • 限界上下文:定义领域模型的边界,在边界内保持模型的一致性
- • 领域划分:区分核心域、子域、支撑域的重要性
- • 上下文映射:定义不同限界上下文之间的关系
战术设计 (Tactical Design):关注领域内部的实现细节
- • 实体、值对象、聚合根:领域模型的基本构建块
- • 领域服务、仓储、工厂:领域逻辑的组织方式
- • 领域事件:领域间的解耦通信
在 coze studio 中:
- • 战略设计体现:按业务能力划分的 8 个领域 (Agent、app、knowledge 等)
- • 战术设计体现:每个领域内部的实体、服务、仓储实现
在coze studio中的应用
让我们看看 coze studio 是如何用DDD解决问题的
1. 业务和技术能够通过领域模型建立通用语言
在 coze studio 中,每个领域都有清晰的业务术语:
// backend/domain/knowledge/entity/knowledge.gotype Knowledge struct { *knowledge.Knowledge}// backend/domain/workflow/entity/workflow.gotype Workflow struct { ID int64 CommitID string *vo.Meta *vo.CanvasInfo *vo.DraftMeta *vo.VersionMeta}// backend/domain/app/entity/app.gotype APP struct { ID int64 SpaceID int64 Name *string Desc *string // ...业务属性}
这些实体名称直接对应业务概念,产品和技术可以用同样的语言交流。
2. 业务边界清晰
coze studio 按照业务领域划分了清晰的模块:
domain/├── agent/ # 智能体领域├── app/ # 应用领域 ├── knowledge/ # 知识库领域├── workflow/ # 工作流领域├── plugin/ # 插件领域├── memory/ # 记忆领域├── user/ # 用户领域└── conversation/ # 对话领域
每个领域都有独立的实体、服务和仓储,边界清晰。
3. 业务模型独立且具备可测试性
以 knowledge 领域为例,业务逻辑封装在领域服务中:
// backend/domain/knowledge/service/knowledge.gofunc (k *knowledgeSVC) CreateKnowledge(ctx context.Context, request *CreateKnowledgeRequest) (response *CreateKnowledgeResponse, err error) { // 业务规则验证 iflen(request.Name) == 0 { returnnil, errorx.New(errno.ErrKnowledgeInvalidParamCode, errorx.KV("msg", "knowledge name is empty")) } if request.CreatorID == 0 { returnnil, errorx.New(errno.ErrKnowledgeInvalidParamCode, errorx.KV("msg", "knowledge creator id is empty")) } // 生成业务ID id, err := k.idgen.GenID(ctx) if err != nil { returnnil, errorx.New(errno.ErrKnowledgeIDGenCode) } // 创建领域对象 if err = k.knowledgeRepo.Create(ctx, &model.Knowledge{ ID: id, Name: request.Name, CreatorID: request.CreatorID, // ... 其他业务属性 }); err != nil { returnnil, errorx.New(errno.ErrKnowledgeDBCode, errorx.KV("msg", err.Error())) } return &CreateKnowledgeResponse{ KnowledgeID: id, CreatedAtMs: now, }, nil}
这个服务可以独立测试,不依赖具体的技术手段实现(就是一段逻辑,因为是在go中所以是用go代码实现,但是不管哪个语言,逻辑是不变的)。
名词概念解析
事务脚本 vs 领域模型
事务脚本:根据接口请求,将业务逻辑通过面向过程组织为解决方案的过程。
-
• 特点:简单、快速、但扩展性差,业务复杂后代码容易变成"大泥球" 领域模型:通过面向对象的设计,将业务实现模型化(将类的状态和行为分离)。
-
• 特点:还原现实世界、责任清晰、边界清晰、扩展性强、测试性强
四种领域模型
失血模型:领域对象只包含 getter/setter 方法,业务逻辑放到 service
// 失血模型 - 只有数据,没有行为type User struct { ID int64 `json:"id"` Name string `json:"name"`}func (u *User) GetID() int64 { return u.ID }func (u *User) SetName(name string) { u.Name = name }
贫血模型:包含属性的 getter/setter 和部分业务逻辑,但核心逻辑在 service 层
// 贫血模型 - 有基本验证,核心逻辑外泄type User struct { ID int64 Name string}func (u *User) IsValid() bool { return u.Name != "" // 简单验证}// 核心业务逻辑在 UserService 中
充血模型:包含属性的 getter/setter 和所有业务逻辑,这是 DDD 提倡的模型
// 充血模型 - coze studio 的实践type Workflow struct { ID int64 CommitID string *vo.Meta *vo.CanvasInfo}func (w *Workflow) GetBasic() *WorkflowBasic { // 业务逻辑封装在实体内部 var version string if w.VersionMeta != nil { version = w.VersionMeta.Version } return &WorkflowBasic{ ID: w.ID, Version: version, CommitID: w.CommitID, }}
胀血模型:删除 Service 层,所有逻辑都放到模型中,模型直接对接 web 层(不推荐)
实体 (Entity)
具有持久化 ID 的对象,能唯一标识一个记录。在 coze studio 中:
// backend/domain/user/entity/user.gotype User struct { UserID int64 // 唯一标识 Name string // 业务属性 UniqueName string Email string // ... 其他属性 CreatedAt int64 // 生命周期属性 UpdatedAt int64}
特点:
- • 标识唯一不可变:UserID 贯穿整个生命周期
- • 连续性:可以追踪整个生命周期
- • 包含行为:不仅仅是数据,还有业务方法
值对象 (Value Object)
用于描述状态的属性,脱离了主体对象就没有任何意义。在 coze studio 中:
// backend/domain/memory/variables/entity/variable_meta.gotype VariableMeta struct { Keyword string DefaultValue string VariableType project_memory.VariableType Channel project_memory.VariableChannel Description string Enable bool // ...}func (v *VariableMeta) ToProjectVariable() *project_memory.Variable { // 值对象的转换方法}
值对象特点:
- • 不可变性:一旦创建不可修改
- • 无标识:通过属性值判断相等性
- • 描述性:描述实体的某个方面
聚合根 (Aggregate Root)
把一组有相同生命周期、在业务上不可分离的实体和值对象放在一起。在 coze studio 中:
// backend/domain/workflow/entity/workflow.gotype Workflow struct { ID int64 // 聚合根标识 CommitID string *vo.Meta // 值对象:元数据 *vo.CanvasInfo // 值对象:画布信息 *vo.DraftMeta // 值对象:草稿元数据 *vo.Vers…