DDD建模后写代码的正确姿势（Java、dotnet双平台）

news/2024/11/15 13:38:46/文章来源:https://www.cnblogs.com/xiaoweiyu/p/18372863

本文书接上回《一种很变态但有效的DDD建模沟通方式》，关注公众号（老肖想当外语大佬）获取信息：

  1. 最新文章更新；

  2. DDD框架源码（.NET、Java双平台）；

  3. 加群畅聊，建模分析、技术交流；

  4. 视频和直播在B站。

终于到了写代码的环节

如果你已经阅读过本系列前面的所有文章，我相信你对需求分析和建模设计有了更深刻的理解，那么就可以实现“需求-模型-代码”三者一致性的前半部分，如下图所示：

图片

那么接下来，我们来分析一下如何实现“模型-代码”的一致性，尝试通过一篇文章的篇幅，展示符合DDD价值判断的代码组织方式的关键部分，初步窥探一下DDD实践的代码样貌：

图片

领域模型与充血模型

现在假设我们通过需求分析，完成了对模型的设计，并推演确认模型满足提出的所有需求，既然模型满足需求，那么意味着我们设计的模型具备下面特征：

  1. 每个模型有自己明确的职责，这些职责分别对应这着不同的需求点；

  2. 每个模型都包含自己履行职责所需要的所有属性信息；

  3. 每个模型都包含履行职责行为能力，并可以发出对应行为产生的事件；

那么提炼下来，我们会发现模型必须是“充血模型”，即同时包含属性和行为，模型与代码的对应关系如下：

图片

我们可以类图来表达模型，即一个聚合根，也可以称之为一个领域，当然一个聚合根可以包含一些复杂类型属性或集合属性，下图示意了一个简单的用户聚合：

图片

下面展示了该模型的示例代码：

Java代码：

package com.yourcompany.domain.aggregates;import com.yourcompany.domain.aggregates.events.*;
import lombok.*;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.DynamicInsert;
import org.hibernate.annotations.DynamicUpdate;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
import org.hibernate.annotations.SQLDelete;
import org.hibernate.annotations.Where;
import org.netcorepal.cap4j.ddd.domain.event.annotation.DomainEvent;
import org.netcorepal.cap4j.ddd.domain.event.impl.DefaultDomainEventSupervisor;import javax.persistence.*;/*** 用户* <p>* 本文件由[cap4j-ddd-codegen-maven-plugin]生成* 警告：请勿手工修改该文件的字段声明，重新生成会覆盖字段声明*/
/* @AggregateRoot */
@Entity
@Table(name = "`user`")
@DynamicInsert
@DynamicUpdate@AllArgsConstructor
@NoArgsConstructor
@Builder
@Getter
public class User {// 【行为方法开始】public void init() {DefaultDomainEventSupervisor.instance.attach(UserCreatedDomainEvent.builder().user(this).build(), this);}public void changeEmail(String email) {this.email = email;DefaultDomainEventSupervisor.instance.attach(UserEmailChangedDomainEvent.builder().user(this).build(), this);}// 【行为方法结束】// 【字段映射开始】本段落由[cap4j-ddd-codegen-maven-plugin]维护，请不要手工改动@Id@GeneratedValue(generator = "org.netcorepal.cap4j.ddd.application.distributed.SnowflakeIdentifierGenerator")@GenericGenerator(name = "org.netcorepal.cap4j.ddd.application.distributed.SnowflakeIdentifierGenerator", strategy = "org.netcorepal.cap4j.ddd.application.distributed.SnowflakeIdentifierGenerator")@Column(name = "`id`")Long id;/*** varchar(100)*/@Column(name = "`name`")String name;/*** varchar(100)*/@Column(name = "`email`")String email;// 【字段映射结束】本段落由[cap4j-ddd-codegen-maven-plugin]维护，请不要手工改动
}

C#代码：

图片

领域事件的定义如下：

Java代码：

package com.yourcompany.domain.aggregates.events;import com.yourcompany.domain.aggregates.User;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.netcorepal.cap4j.ddd.domain.event.annotation.DomainEvent;/*** 用户创建事件*/
@DomainEvent
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class UserCreatedDomainEvent {User user;
}
package com.yourcompany.domain.aggregates.events;import com.yourcompany.domain.aggregates.User;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.netcorepal.cap4j.ddd.domain.event.annotation.DomainEvent;
/*** 用户邮箱变更事件*/
@DomainEvent
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class UserEmailChangedDomainEvent {User user;
}

C#代码：

//定义领域事件
using NetCorePal.Extensions.Domain;
namespace YourNamespace;public record UserCreatedDomainEvent(User user) : IDomainEvent;public record UserEmailChangedDomainEvent(User user) : IDomainEvent;

至此，我们的一个领域模型的代码就完成了。

领域模型之外的关键要素

让我们再回到“模型拟人化”的类比上，想象一下在企业里一个任务是怎么被完成的，下图展示了一个典型流程：

图片

如果我们将这个过程对应到软件系统，可以得到如下流程：

图片

根据上面的对应我可以知道除了领域模型之外，其他的关键要素：

  1. Controller

  2. Command与CommandHandler

  3. DomainEventHandler

接下来，我们分别对这些部分进行说明

Controller

有过web项目开发经验的开发者，对Controller并不陌生，它是web服务与前端交互的入口，在这里Controller的主要职责是：

  1. 接收外部输入

  2. 将请求输入及当前用户会话等信息组装成命令

  3. 发出/执行命令

  4. 响应命令执行结果

Java代码：

package com.yourcompany.adapter.portal.api;import com.yourcompany.adapter.portal.api._share.ResponseData;
import com.yourcompany.application.commands.CreateUserCommand;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.validation.Valid;/*** 用户控制器*/
@Tag(name = "用户")
@RestController
@RequestMapping(value = "/api/user")
@Slf4j
public class UserController {@AutowiredCreateUserCommand.Handler createUserCommandHandler;@PostMapping("/")public ResponseData<Long> createUserCommand(@RequestBody @Valid CreateUserCommand cmd) {Long result = createUserCommandHandler.exec(cmd);return ResponseData.success(result);}
}

C#代码：

[Route("api/[controller]")]
[ApiController]
public class UserController(IMediator mediator) : ControllerBase
{[HttpPost]public async Task<ResponseData<UserId>> Post([FromBody] CreateUserRequest request){var cmd = new CreateUserCommand(request.Name, request.Email);var id = await mediator.Send(cmd);return id.AsResponseData();}
}

===

===

Command与CommandHandler

基于前面的对应关系，Command对应任务，那么我们可以这样理解：

  1. Command是执行任务所需要的信息

  2. CommandHandler负责将命令信息传递给领域模型

  3. CommandHandler最后要将领域模型持久化

下面是一个简单的示例：

Java代码：

package com.yourcompany.application.commands;import com.yourcompany.domain.aggregates.User;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.netcorepal.cap4j.ddd.application.command.Command;
import org.netcorepal.cap4j.ddd.domain.repo.AggregateRepository;
import org.netcorepal.cap4j.ddd.domain.repo.UnitOfWork;
import org.springframework.stereotype.Service;/*** 创建用户命令*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class CreateUserCommand {String name;String email;@Service@RequiredArgsConstructor@Slf4jpublic static class Handler implements Command<CreateUserCommand, Long> {private final AggregateRepository<User, Long> repo;private final UnitOfWork unitOfWork;@Overridepublic Long exec(CreateUserCommand cmd) {User user = User.builder().name(cmd.name).email(cmd.email).build();user.init();unitOfWork.persist(user);unitOfWork.save();return user.getId();}}
}

C#代码：

public record CreateUserCommand(string Name, string Email) : ICommand<UserId>;public class CreateUserCommandHandler(IUserRepository userRepository) : ICommandHandler<CreateUserCommand, UserId>
{public async Task<UserId> Handle(CreateUserCommand request, CancellationToken cancellationToken){var user = new User(request.Name, request.Email);user = await userRepository.AddAsync(user, cancellationToken);return user.Id;}
}

===

===

DomainEventHandler

当我们的命令执行完成，领域模型会产生领域事件，那么关心领域事件，期望在领域事件发生时执行一些操作，就可以使用DomainEventHandler来完成：

  1. DomainEventHandler根据事件信息产生新的命令并发出

  2. 每个DomainEventHandler只做一件事，即只发出一个命令

Java代码：

package com.yourcompany.application.subscribers;import com.yourcompany.application.commands.DoSomethingCommand;
import com.yourcompany.domain.aggregates.events.UserCreatedDomainEvent;
import lombok.RequiredArgsConstructor;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Service;/*** 用户创建领域事件*/
@Service
@RequiredArgsConstructor
public class UserCreatedDomainEventHandler {private final DoSomethingCommand.Handler handler;@EventListener(UserCreatedDomainEvent.class)public void handle(UserCreatedDomainEvent event) {handler.exec(DoSomethingCommand.builder().param(event.getUser().getId()).build());}
}

C#代码：

public class UserCreatedDomainEventHandler(IMediator mediator) : IDomainEventHandler<UserCreatedDomainEvent>
{public Task Handle(UserCreatedDomainEvent notification, CancellationToken cancellationToken){return mediator.Send(new DoSomethingCommand(notification.User.Id), cancellationToken);}
}

===

===

模型的持久化

在前文，我们一直强调一个观点，“在设计模型时忘掉数据库”，那么当我们完成模型设计之后，如何将模型存储进数据库呢？通常我们会使用仓储模式在负责模型的“存取”操作，下面代码示意了一个仓储具备的基本能力以及仓储的定义，略微不同的是，我们实现了工作单元模式（UnitOfWork），以屏蔽数据库的“增删改查”语义，我们只需要从仓储中“取出模型”、“操作模型”、“保存模型”即可。

Java代码：

package com.yourcompany.adapter.domain.repositories;import com.yourcompany.domain.aggregates.User;/*** 本文件由[cap4j-ddd-codegen-maven-plugin]生成*/
public interface UserRepository extends org.netcorepal.cap4j.ddd.domain.repo.AggregateRepository<User, Long> {// 【自定义代码开始】本段落之外代码由[cap4j-ddd-codegen-maven-plugin]维护，请不要手工改动@org.springframework.stereotype.Componentpublic static class UserJpaRepositoryAdapter extends org.netcorepal.cap4j.ddd.domain.repo.AbstractJpaRepository<User, Long>
{public UserJpaRepositoryAdapter(org.springframework.data.jpa.repository.JpaSpecificationExecutor<User> jpaSpecificationExecutor, org.springframework.data.jpa.repository.JpaRepository<User, Long> jpaRepository) {super(jpaSpecificationExecutor, jpaRepository);}}// 【自定义代码结束】本段落之外代码由[cap4j-ddd-codegen-maven-plugin]维护，请不要手工改动
}

C#代码：

public interface IRepository<TEntity, TKey> : IRepository<TEntity>where TEntity : notnull, Entity<TKey>, IAggregateRootwhere TKey : notnull
{IUnitOfWork UnitOfWork { get; }TEntity Add(TEntity entity);Task<TEntity> AddAsync(TEntity entity, CancellationToken cancellationToken = default (CancellationToken));int DeleteById(TKey id);Task<int> DeleteByIdAsync(TKey id, CancellationToken cancellationToken = default (CancellationToken));TEntity? Get(TKey id);Task<TEntity?> GetAsync(TKey id, CancellationToken cancellationToken = default (CancellationToken));
}public interface IUserRepository : IRepository<User, UserId>
{
}public class UserRepository(ApplicationDbContext context) : RepositoryBase<User, UserId, ApplicationDbContext>(context), IUserRepository
{
}

===

===

查询的处理

下面展示了一个简单的查询的代码

Java代码：

package com.yourcompany.application.queries;import com.yourcompany._share.exception.KnownException;
import com.yourcompany.domain.aggregates.User;
import com.yourcompany.domain.aggregates.schemas.UserSchema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.netcorepal.cap4j.ddd.application.query.Query;
import org.netcorepal.cap4j.ddd.domain.repo.AggregateRepository;
import org.springframework.stereotype.Service;/*** 查询用户*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class UserQuery {private Long id;@Service@RequiredArgsConstructor@Slf4jpublic static class Handler implements Query<UserQuery, UserQueryDto> {private final AggregateRepository<User, Long> repo;@Overridepublic UserQueryDto exec(UserQuery param) {User entity = repo.findOne(UserSchema.specify(root -> root.id().eq(param.id))).orElseThrow(() -> new KnownException("不存在"));return UserQueryDto.builder().id(entity.getId()).name(entity.getName()).email(entity.getEmail()).build();}}@Data@AllArgsConstructor@NoArgsConstructor@Builderpublic static class UserQueryDto {private Long id;private String name;private String email;}
}

C#代码：

public class UserQuery(ApplicationDbContext applicationDbContext)
{public async Task<UserDto?> QueryOrder(UserId userId, CancellationToken cancellationToken){return await applicationDbContext.Users.Where(p => p.Id == userId).Select(p => new UserDto(p.Id, p.Name)).SingleOrDefault();}
}

===

===

CQRS似乎是唯一正解

我们在实际的软件系统中，查询往往是场景复杂的，不同的查询需求，可能打破模型的整体性，显然使用领域模型本身来满足这些需求是不现实的，那么就需要针对需求场景，组织对应的数据结构作为输出结果，这就与“CQRS”模式不谋而合，或者说“CQRS”就是为了解决这个问题而被提出的，并且这个模式与“命令-事件”的思维浑然一体，前面的代码示例也印证了这一点，因此我们认为DDD的实践落地，需要借助CQRS的模式。

图片

源码资料

本文示例分别使用了cap4j（Java）和netcorepal-cloud-framework（dotnet），欢迎参与项目讨论和贡献，项目地址如下：

https://github.com/netcorepal/cap4j

https://github.com/netcorepal/netcorepal-cloud-framework

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/785217.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

JetBrains RustRover 2024.2 (macOS, Linux, Windows) - 面向 Rust 开发者的强大 IDE

JetBrains RustRover 2024.2 (macOS, Linux, Windows) - 面向 Rust 开发者的强大 IDE

JetBrains RustRover 2024.2 (macOS, Linux, Windows) - 面向 Rust 开发者的强大 IDEJetBrains RustRover 2024.2 (macOS, Linux, Windows) - 面向 Rust 开发者的强大 IDE JetBrains 跨平台开发者工具 请访问原文链接：https://sysin.org/blog/jetbrains-rustrover/，查看最新版…
阅读更多...
JetBrains RubyMine 2024.2 (macOS, Linux, Windows) - 最智能的 Ruby 与 Rails IDE

JetBrains RubyMine 2024.2 (macOS, Linux, Windows) - 最智能的 Ruby 与 Rails IDE

JetBrains RubyMine 2024.2 (macOS, Linux, Windows) - 最智能的 Ruby 与 Rails IDEJetBrains RubyMine 2024.2 (macOS, Linux, Windows) - 最智能的 Ruby 与 Rails IDE JetBrains 跨平台开发者工具 请访问原文链接：https://sysin.org/blog/jetbrains-rubymine/，查看最新版。…
阅读更多...
使用分布式锁解决IM聊天数据重复插入的问题

使用分布式锁解决IM聊天数据重复插入的问题

导航业务背景 问题分析与定位 探索可行的解决方案数据库层面处理——唯一索引 应用程序层面处理——分布式锁分布式锁概述分布式锁需要具备哪些特性？ 分布式锁有哪些实现方式？基于数据库的实现方式 基于Redisson实现方式Redission介绍概述 可重入锁基于Redisson解决方案方案梳…
阅读更多...
IEC104初学者教程，第十章：APDU 序列号

IEC104初学者教程，第十章：APDU 序列号

第十章：APDU 序列号平时学习规约或调试IEC104或IEC101设备，需要IEC104/101模拟器，推荐一款： 主站下载地址：IEC104主站模拟器 从站下载地址：IEC104从站模拟器未受干扰的编号 I 格式 APDU 序列V(S) = 发送状态变量（发送序列号） V(R) = 接收状态变量（接收序列号） Ac…
阅读更多...
读软件开发安全之道：概念、设计与实施05模式（上）

读软件开发安全之道：概念、设计与实施05模式（上）

模式1. 模式 1.1. 模式分类1.1.1. 设计属性1.1.2. 暴露最少信息1.1.3. 冗余1.1.4. 强力执行1.1.5. 信任与责任1.1.6. 反模式1.2. 模式可以缓解或者避免很多种类的风险，它们可以形成一个重要的工具箱，帮我们解决潜在的安全威胁 1.3. 不需要为了解决一个问题就把所有设计模式全…
阅读更多...
Dapr v1.14 版本已发布

Dapr v1.14 版本已发布

Dapr是一套开源、可移植的事件驱动型运行时，允许开发人员轻松立足云端与边缘位置运行弹性、微服务、无状态以及有状态等应用程序类型。Dapr能够确保开发人员专注于编写业务逻辑，而不必分神于解决分布式系统难题，由此显著提高生产力并缩短开发时长。Dapr 是用于构建云原生应用…
阅读更多...
k线训练营排名

k线训练营排名

玩了1天时间，就能排到前30 量学真的好，别的不多说了
阅读更多...
tar命令打包指定目录及其文件，而不包括其上级目录

tar命令打包指定目录及其文件，而不包括其上级目录

想指定将/var目录下的log目录及其文件打包到当前目录，在压缩包解压时不包括/var目录，可使用如下方式： tar -zcvf log_bak.tar.gz -C /var/ log　　　　# 注意log前面有空格，不是/var/log解压到data目录里查看 tar -zxvf log_bak.tar.gz -C data/可见，将打包的文件解压到da…
阅读更多...
【第3期】2024 搜索客 Meetup | Elasticsearch 的代码结构和写入查询流程的解读 - 下篇

【第3期】2024 搜索客 Meetup | Elasticsearch 的代码结构和写入查询流程的解读 - 下篇

本次活动由 搜索客社区、极限科技（INFINI Labs）联合举办，活动主题将深入探讨 Elasticsearch 的两个核心方面：代码结构以及写入和查询的关键流程。本次活动将为 Elasticsearch 初学者和有经验的用户提供宝贵的见解，欢迎大家报名参加、交流学习。 活动主题：Elasticsearch 的…
阅读更多...
后台设计产品经理指南：用AxureRP设计功能强大的后台系统仪表盘

后台设计产品经理指南：用AxureRP设计功能强大的后台系统仪表盘

在现代化的后台管理系统中，仪表盘（Dashboard）作为核心界面，提供了关键数据的实时可视化展示。它不仅能帮助管理者迅速了解当前业务状况，还能发现潜在问题并及时作出调整。仪表盘的重要性在于其能够整合各类复杂信息，以直观的图表、数字等形式呈现，极大地提升了数据的易读…
阅读更多...
网络资产安全防护系统设计与应用（产品经理视角下使用AxureRP的设计方案）

网络资产安全防护系统设计与应用（产品经理视角下使用AxureRP的设计方案）

在当今高度数字化的世界中，网络资产的安全防护已成为企业生存与发展的关键要素。网络资产安全防护后台系统作为保障企业信息安全的核心工具，能够实时监控、分析和管理网络中的各类资产，防止潜在的安全威胁。这类系统的重要性在于其可以识别并应对多种安全风险，提供全面的漏…
阅读更多...
【内网渗透】域信任关系

【内网渗透】域信任关系

https://mp.weixin.qq.com/s/124rVk7mws5jfvIYS1rAaA 一、介绍 信任关系就是可以让一个域内的用户访问另一个域内的资源。 二、传递 2.1 可传递： 什么是信任关系可传递，如下图：A域和B域之间的信任关系是可传递的，B域和C域之间的信任关系也是可传递的，那么A域和C域之间就会…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023