做者|殷浩
出品|阿里巴巴新零售淘系技术部数据库
架构这个词源于英文里的“Architecture“,源头是土木工程里的“建筑”和“结构”,而架构里的”架“同时又包含了”架子“(scaffolding)的含义,意指能快速搭建起来的固定结构。而今天的应用架构,意指软件系统中固定不变的代码结构、设计模式、规范和组件间的通讯方式。在应用开发中架构之因此是最重要的第一步,由于一个好的架构能让系统安全、稳定、快速迭代。在一个团队内经过规定一个固定的架构设计,可让团队内能力良莠不齐的同窗们都能有一个统一的开发规范,下降沟通成本,提高效率和代码质量。编程
在作架构设计时,一个好的架构应该须要实现如下几个目标:设计模式
这就好像是建筑中的楼宇,一个好的楼宇,不管内部承载了什么人、有什么样的活动、仍是外部有什么风雨,一栋楼都应该屹立不倒,并且能够确保它不会倒。可是今天咱们在作业务研发时,更多的会去关注一些宏观的架构,好比SOA架构、微服务架构,而忽略了应用内部的架构设计,很容易致使代码逻辑混乱,很难维护,容易产生bug并且很难发现。今天,我但愿可以经过案例的分析和重构,来推演出一套高质量的DDD架构。跨域
咱们先看一个简单的案例需求以下:缓存
用户能够经过银行网页转帐给另外一个帐号,支持跨币种转帐。安全
同时由于监管和对帐需求,须要记录本次转帐活动。网络
拿到这个需求以后,一个开发可能会经历一些技术选型,最终可能拆解需求以下:session
一、从MySql数据库中找到转出和转入的帐户,选择用 MyBatis 的 mapper 实现 DAO;二、从 Yahoo(或其余渠道)提供的汇率服务获取转帐的汇率信息(底层是 http 开放接口);数据结构
三、计算须要转出的金额,确保帐户有足够余额,而且没超出每日转帐上限;架构
四、实现转入和转出操做,扣除手续费,保存数据库;
五、发送 Kafka 审计消息,以便审计和对帐用;
而一个简单的代码实现以下:
public class TransferController { private TransferService transferService; public Result<Boolean> transfer(String targetAccountNumber, BigDecimal amount, HttpSession session) { Long userId = (Long) session.getAttribute("userId"); return transferService.transfer(userId, targetAccountNumber, amount, "CNY"); } } public class TransferServiceImpl implements TransferService { private static final String TOPIC_AUDIT_LOG = "TOPIC_AUDIT_LOG"; private AccountMapper accountDAO; private KafkaTemplate<String, String> kafkaTemplate; private YahooForexService yahooForex; @Override public Result<Boolean> transfer(Long sourceUserId, String targetAccountNumber, BigDecimal targetAmount, String targetCurrency) { // 1. 从数据库读取数据,忽略全部校验逻辑如帐号是否存在等 AccountDO sourceAccountDO = accountDAO.selectByUserId(sourceUserId); AccountDO targetAccountDO = accountDAO.selectByAccountNumber(targetAccountNumber); // 2. 业务参数校验 if (!targetAccountDO.getCurrency().equals(targetCurrency)) { throw new InvalidCurrencyException(); } // 3. 获取外部数据,而且包含必定的业务逻辑 // exchange rate = 1 source currency = X target currency BigDecimal exchangeRate = BigDecimal.ONE; if (sourceAccountDO.getCurrency().equals(targetCurrency)) { exchangeRate = yahooForex.getExchangeRate(sourceAccountDO.getCurrency(), targetCurrency); } BigDecimal sourceAmount = targetAmount.divide(exchangeRate, RoundingMode.DOWN); // 4. 业务参数校验 if (sourceAccountDO.getAvailable().compareTo(sourceAmount) < 0) { throw new InsufficientFundsException(); } if (sourceAccountDO.getDailyLimit().compareTo(sourceAmount) < 0) { throw new DailyLimitExceededException(); } // 5. 计算新值,而且更新字段 BigDecimal newSource = sourceAccountDO.getAvailable().subtract(sourceAmount); BigDecimal newTarget = targetAccountDO.getAvailable().add(targetAmount); sourceAccountDO.setAvailable(newSource); targetAccountDO.setAvailable(newTarget); // 6. 更新到数据库 accountDAO.update(sourceAccountDO); accountDAO.update(targetAccountDO); // 7. 发送审计消息 String message = sourceUserId + "," + targetAccountNumber + "," + targetAmount + "," + targetCurrency; kafkaTemplate.send(TOPIC_AUDIT_LOG, message); return Result.success(true); } }
咱们能够看到,一段业务代码里常常包含了参数校验、数据读取存储、业务计算、调用外部服务、发送消息等多种逻辑。在这个案例里虽然是写在了同一个方法里,在真实代码中常常会被拆分红多个子方法,但实际效果是同样的,而在咱们平常的工做中,绝大部分代码都或多或少的接近于此类结构。在Martin Fowler的 P of EAA书中,这种很常见的代码样式被叫作Transaction Script(事务脚本)。虽然这种相似于脚本的写法在功能上没有什么问题,可是长久来看,他有如下几个很大的问题:可维护性差、可扩展性差、可测试性差。
问题1-可维护性能差
一个应用最大的成本通常都不是来自于开发阶段,而是应用整个生命周期的总维护成本,因此代码的可维护性表明了最终成本。
**可维护性 = 当依赖变化时,有多少代码须要随之改变
**
参考以上的案例代码,事务脚本类的代码很难维护由于如下几点:
咱们发现案例里的代码对于任何外部依赖的改变都会有比较大的影响。若是你的应用里有大量的此类代码,你每一天的时间基本上会被各类库升级、依赖服务升级、中间件升级、jar包冲突占满,最终这个应用变成了一个不敢升级、不敢部署、不敢写新功能、而且随时会爆发的炸弹,终有一天会给你带来惊喜。
问题2-可拓展性差
事务脚本式代码的第二大缺陷是:虽然写单个用例的代码很是高效简单,可是当用例多起来时,其扩展性会变得愈来愈差。
可扩展性 = 作新需求或改逻辑时,须要新增/修改多少代码
参考以上的代码,若是今天须要增长一个跨行转帐的能力,你会发现基本上须要从新开发,基本上没有任何的可复用性:
在事务脚本式的架构下,通常作第一个需求都很是的快,可是作第N个需求时须要的时间颇有多是呈指数级上升的,绝大部分时间花费在老功能的重构和兼容上,最终你的创新速度会跌为0,促使老应用被推翻重构。
问题3-可测试性能差
除了部分工具类、框架类和中间件类的代码有比较高的测试覆盖以外,咱们在平常工做中很难看到业务代码有比较好的测试覆盖,而绝大部分的上线前的测试属于人肉的“集成测试”。低测试率致使咱们对代码质量很难有把控,容易错过边界条件,异常case只有线上爆发了才被动发现。而低测试覆盖率的主要缘由是业务代码的可测试性比较差。
可测试性 = 运行每一个测试用例所花费的时间 * 每一个需求所须要增长的测试用例数量
参考以上的一段代码,这种代码有极低的可测试性:
在事务脚本模式下,当测试用例复杂度远大于真实代码复杂度,当运行测试用例的耗时超出人肉测试时,绝大部分人会选择不写完整的测试覆盖,而这种状况一般就是bug很难被早点发现的缘由。
总结分析
咱们从新来分析一下为何以上的问题会出现?由于以上的代码违背了至少如下几个软件设计的原则:
咱们须要对代码重构才能解决这些问题。
在重构以前,咱们先画一张流程图,描述当前代码在作的每一个步骤:
这是一个传统的三层分层结构:UI层、业务层、和基础设施层。上层对于下层有直接的依赖关系,致使耦合度太高。在业务层中对于下层的基础设施有强依赖,耦合度高。咱们须要对这张图上的每一个节点作抽象和整理,来下降对外部依赖的耦合度。
2.1 - 抽象数据存储层
第一步常见的操做是将Data Access层作抽象,下降系统对数据库的直接依赖。具体的方法以下:
具体的简单代码实现以下:
Account实体类:
@Data public class Account { private AccountId id; private AccountNumber accountNumber; private UserId userId; private Money available; private Money dailyLimit; public void withdraw(Money money) { // 转出 } public void deposit(Money money) { // 转入 } }
和AccountRepository及MyBatis实现类:
public interface AccountRepository { Account find(AccountId id); Account find(AccountNumber accountNumber); Account find(UserId userId); Account save(Account account); } public class AccountRepositoryImpl implements AccountRepository { @Autowired private AccountMapper accountDAO; @Autowired private AccountBuilder accountBuilder; @Override public Account find(AccountId id) { AccountDO accountDO = accountDAO.selectById(id.getValue()); return accountBuilder.toAccount(accountDO); } @Override public Account find(AccountNumber accountNumber) { AccountDO accountDO = accountDAO.selectByAccountNumber(accountNumber.getValue()); return accountBuilder.toAccount(accountDO); } @Override public Account find(UserId userId) { AccountDO accountDO = accountDAO.selectByUserId(userId.getId()); return accountBuilder.toAccount(accountDO); } @Override public Account save(Account account) { AccountDO accountDO = accountBuilder.fromAccount(account); if (accountDO.getId() == null) { accountDAO.insert(accountDO); } else { accountDAO.update(accountDO); } return accountBuilder.toAccount(accountDO); } }
Account实体类和AccountDO数据类的对好比下:
DAO 和 Repository 类的对好比下:
2.1.1 Repository和Entity
2.2 - 抽象第三方服务
相似对于数据库的抽象,全部第三方服务也须要经过抽象解决第三方服务不可控,入参出参强耦合的问题。在这个例子里咱们抽象出 ExchangeRateService 的服务,和一个ExchangeRate的Domain Primitive类:
public interface ExchangeRateService { ExchangeRate getExchangeRate(Currency source, Currency target); } public class ExchangeRateServiceImpl implements ExchangeRateService { @Autowired private YahooForexService yahooForexService; @Override public ExchangeRate getExchangeRate(Currency source, Currency target) { if (source.equals(target)) { return new ExchangeRate(BigDecimal.ONE, source, target); } BigDecimal forex = yahooForexService.getExchangeRate(source.getValue(), target.getValue()); return new ExchangeRate(forex, source, target); }
2.2.1 防腐层(ACL)
这种常见的设计模式叫作Anti-Corruption Layer(防腐层或ACL)。不少时候咱们的系统会去依赖其余的系统,而被依赖的系统可能包含不合理的数据结构、API、协议或技术实现,若是对外部系统强依赖,会致使咱们的系统被”腐蚀“。这个时候,经过在系统间加入一个防腐层,可以有效的隔离外部依赖和内部逻辑,不管外部如何变动,内部代码能够尽量的保持不变。
ACL 不只仅只是多了一层调用,在实际开发中ACL可以提供更多强大的功能:
2.3 - 抽象中间件
相似于2.2的第三方服务的抽象,对各类中间件的抽象的目的是让业务代码再也不依赖中间件的实现逻辑。由于中间件一般须要有通用型,中间件的接口一般是String或Byte[] 类型的,致使序列化/反序列化逻辑一般和业务逻辑混杂在一块儿,形成胶水代码。经过中间件的ACL抽象,减小重复胶水代码。
在这个案例里,咱们经过封装一个抽象的AuditMessageProducer和AuditMessage DP对象,实现对底层kafka实现的隔离:
@Value @AllArgsConstructor public class AuditMessage { private UserId userId; private AccountNumber source; private AccountNumber target; private Money money; private Date date; public String serialize() { return userId + "," + source + "," + target + "," + money + "," + date; } public static AuditMessage deserialize(String value) { // todo return null; } } public interface AuditMessageProducer { SendResult send(AuditMessage message); } public class AuditMessageProducerImpl implements AuditMessageProducer { private static final String TOPIC_AUDIT_LOG = "TOPIC_AUDIT_LOG"; @Autowired private KafkaTemplate<String, String> kafkaTemplate; @Override public SendResult send(AuditMessage message) { String messageBody = message.serialize(); kafkaTemplate.send(TOPIC_AUDIT_LOG, messageBody); return SendResult.success(); } }
具体的分析和2.2相似,在此略过。
2.4 - 封装业务逻辑
在这个案例里,有不少业务逻辑是跟外部依赖的代码混合的,包括金额计算、帐户余额的校验、转帐限制、金额增减等。这种逻辑混淆致使了核心计算逻辑没法被有效的测试和复用。在这里,咱们的解法是经过Entity、Domain Primitive和Domain Service封装全部的业务逻辑:
2.4.1 - 用Domain Primitive封装跟实体无关的无状态计算逻辑
在这个案例里使用ExchangeRate来封装汇率计算逻辑:
BigDecimal exchangeRate = BigDecimal.ONE; if (sourceAccountDO.getCurrency().equals(targetCurrency)) { exchangeRate = yahooForex.getExchangeRate(sourceAccountDO.getCurrency(), targetCurrency); } BigDecimal sourceAmount = targetAmount.divide(exchangeRate, RoundingMode.DOWN);
变为:
ExchangeRate exchangeRate = exchangeRateService.getExchangeRate(sourceAccount.getCurrency(), targetMoney.getCurrency()); Money sourceMoney = exchangeRate.exchangeTo(targetMoney);
2.4.2 - 用Entity封装单对象的有状态的行为,包括业务校验
用Account实体类封装全部Account的行为,包括业务校验以下:
@Data public class Account { private AccountId id; private AccountNumber accountNumber; private UserId userId; private Money available; private Money dailyLimit; public Currency getCurrency() { return this.available.getCurrency(); } // 转入 public void deposit(Money money) { if (!this.getCurrency().equals(money.getCurrency())) { throw new InvalidCurrencyException(); } this.available = this.available.add(money); } // 转出 public void withdraw(Money money) { if (this.available.compareTo(money) < 0) { throw new InsufficientFundsException(); } if (this.dailyLimit.compareTo(money) < 0) { throw new DailyLimitExceededException(); } this.available = this.available.subtract(money); } }
原有的业务代码则能够简化为:
sourceAccount.deposit(sourceMoney); targetAccount.withdraw(targetMoney);
2.4.3 - 用Domain Service封装多对象逻辑
在这个案例里,咱们发现这两个帐号的转出和转入其实是一体的,也就是说这种行为应该被封装到一个对象中去。特别是考虑到将来这个逻辑可能会产生变化:好比增长一个扣手续费的逻辑。这个时候在原有的TransferService中作并不合适,在任何一个Entity或者Domain Primitive里也不合适,须要有一个新的类去包含跨域对象的行为。这种对象叫作Domain Service。
咱们建立一个AccountTransferService的类:
public interface AccountTransferService { void transfer(Account sourceAccount, Account targetAccount, Money targetMoney, ExchangeRate exchangeRate); } public class AccountTransferServiceImpl implements AccountTransferService { private ExchangeRateService exchangeRateService; @Override public void transfer(Account sourceAccount, Account targetAccount, Money targetMoney, ExchangeRate exchangeRate) { Money sourceMoney = exchangeRate.exchangeTo(targetMoney); sourceAccount.deposit(sourceMoney); targetAccount.withdraw(targetMoney); } }
而原始代码则简化为一行:
accountTransferService.transfer(sourceAccount, targetAccount, targetMoney, exchangeRate);
2.5 - 重构后结果分析
这个案例重构后的代码以下:
public class TransferServiceImplNew implements TransferService { private AccountRepository accountRepository; private AuditMessageProducer auditMessageProducer; private ExchangeRateService exchangeRateService; private AccountTransferService accountTransferService; @Override public Result<Boolean> transfer(Long sourceUserId, String targetAccountNumber, BigDecimal targetAmount, String targetCurrency) { // 参数校验 Money targetMoney = new Money(targetAmount, new Currency(targetCurrency)); // 读数据 Account sourceAccount = accountRepository.find(new UserId(sourceUserId)); Account targetAccount = accountRepository.find(new AccountNumber(targetAccountNumber)); ExchangeRate exchangeRate = exchangeRateService.getExchangeRate(sourceAccount.getCurrency(), targetMoney.getCurrency()); // 业务逻辑 accountTransferService.transfer(sourceAccount, targetAccount, targetMoney, exchangeRate); // 保存数据 accountRepository.save(sourceAccount); accountRepository.save(targetAccount); // 发送审计消息 AuditMessage message = new AuditMessage(sourceAccount, targetAccount, targetMoney); auditMessageProducer.send(message); return Result.success(true); } }
能够看出来,通过重构后的代码有如下几个特征:
咱们能够根据新的结构从新画一张图:
而后经过从新编排后该图变为:
咱们能够发现,经过对外部依赖的抽象和内部逻辑的封装重构,应用总体的依赖关系变了:
若是今天可以从新写这段代码,考虑到最终的依赖关系,咱们可能先写Domain层的业务逻辑,而后再写Application层的组件编排,最后才写每一个外部依赖的具体实现。这种架构思路和代码组织结构就叫作Domain-Driven Design(领域驱动设计,或DDD)。因此DDD不是一个特殊的架构设计,而是全部Transction Script代码通过合理重构后必定会抵达的终点。
在咱们传统的代码里,咱们通常都很注重每一个外部依赖的实现细节和规范,可是今天咱们须要勇于抛弃掉原有的理念,从新审视代码结构。在上面重构的代码里,若是抛弃掉全部Repository、ACL、Producer等的具体实现细节,咱们会发现每个对外部的抽象类其实就是输入或输出,相似于计算机系统中的I/O节点。这个观点在CQRS架构中也一样适用,将全部接口分为Command(输入)和Query(输出)两种。除了I/O以外其余的内部逻辑,就是应用业务的核心逻辑。基于这个基础,Alistair Cockburn在2005年提出了Hexagonal Architecture(六边形架构),又被称之为Ports and Adapters(端口和适配器架构)。
在这张图中:
在Hex中,架构的组织关系第一次变成了一个二维的内外关系,而不是传统一维的上下关系。同时在Hex架构中咱们第一次发现UI层、DB层、和各类中间件层其实是没有本质上区别的,都只是数据的输入和输出,而不是在传统架构中的最上层和最下层。
除了2005年的Hex架构,2008年 Jeffery Palermo的Onion Architecture(洋葱架构)和2017年 Robert Martin的Clean Architecture(干净架构),都是极为相似的思想。除了命名不同、切入点不同以外,其余的总体架构都是基于一个二维的内外关系。这也说明了基于DDD的架构最终的形态都是相似的。Herberto Graca有一个很全面的图包含了绝大部分现实中的端口类,值得借鉴。
3.1 - 代码组织结构
为了有效的组织代码结构,避免下层代码依赖到上层实现的状况,在Java中咱们能够经过POM Module和POM依赖来处理相互的关系。经过Spring/SpringBoot的容器来解决运行时动态注入具体实现的依赖的问题。一个简单的依赖关系图以下:
3.1.1 - Types 模块
Types模块是保存能够对外暴露的Domain Primitives的地方。Domain Primitives由于是无状态的逻辑,能够对外暴露,因此常常被包含在对外的API接口中,须要单独成为模块。Types模块不依赖任何类库,纯 POJO 。
3.1.2 - Domain 模块
Domain 模块是核心业务逻辑的集中地,包含有状态的Entity、领域服务Domain Service、以及各类外部依赖的接口类(如Repository、ACL、中间件等。Domain模块仅依赖Types模块,也是纯 POJO 。
3.1.3 - Application模块
Application模块主要包含Application Service和一些相关的类。Application模块依赖Domain模块。仍是不依赖任何框架,纯POJO。
3.1.4 - Infrastructure模块
Infrastructure模块包含了Persistence、Messaging、External等模块。好比:Persistence模块包含数据库DAO的实现,包含Data Object、ORM Mapper、Entity到DO的转化类等。Persistence模块要依赖具体的ORM类库,好比MyBatis。若是须要用Spring-Mybatis提供的注解方案,则须要依赖Spring。
3.1.5 - Web模块
Web模块包含Controller等相关代码。若是用SpringMVC则须要依赖Spring。
3.1.6 - Start模块
Start模块是SpringBoot的启动类。
3.2 - 测试
3.3 - 代码的演进/变化速度
在传统架构中,代码从上到下的变化速度基本上是一致的,改个需求须要从接口、到业务逻辑、到数据库全量变动,而第三方变动可能会致使整个代码的重写。可是在DDD中不一样模块的代码的演进速度是不同的:
因此在DDD架构中,能明显看出越外层的代码越稳定,越内层的代码演进越快,真正体现了领域“驱动”的核心思想。
DDD不是一个什么特殊的架构,而是任何传统代码通过合理的重构以后最终必定会抵达的终点。DDD的架构可以有效的解决传统架构中的问题:
本文为云栖社区原创内容,未经容许不得转载。