COLA架构

淩亂°似流年 2023-09-24 14:08 50阅读 0赞

# COLA架构 #

来自[小张的博客][Link 1]  
**COLA 是 Clean Object-Oriented and Layered Architecture的缩写，代表“整洁面向对象分层架构”**

在COLA 4.0，也就是目前最新的版本中，作者将COLA拆分为COLA架构（Archetype）和COLA组件（Components）两个部分：

*  COLA架构：COLA应用的代码模板。
 *  COLA组件：提供一些非常有用的通用组件，这些组件可以帮助我们提升研发效率。  
    **两者互不干扰，可以独立使用。**

## COLA整体架构 ##

首先主要谈谈COLA架构，COLA的官方博文中是这么介绍的：

> 在平时我们的业务开发中，大部分的系统都需要：  
> 接收request，响应response；  
> 做业务逻辑处理，像校验参数，状态流转，业务计算等等；  
> 和外部系统有联动，像数据库，微服务，搜索引擎等；  
> 正是有这样的共性存在，才会有很多普适的架构思想出现，比如分层架构、六边形架构、洋葱圈架构、整洁架构（Clean Architecture）、DDD架构等等。  
> 这些应用架构思想虽然很好，但我们很多同学还是“不讲Co德，明白了很多道理，可还是过不好这一生”。问题就在于缺乏实践和指导。COLA的意义就在于，他不仅是思想，还提供了可落地的实践。应该是为数不多的应用架构层面的开源软件。

COLA提供了一整套代码架构，拿来即用。 其中包含了很多架构设计思想，包括讨论度很高的领域驱动设计DDD等。

## COLA分层架构 ##

![image-1667315500441][]

![image-1667315509367][]

官方的表格，介绍了COLA中每个层的命名和含义：  
![image-1667317111251][]  
这两张图和一个表格已经把整个COLA架构的绝大部分内容展现给了大家，但是一下子这么多信息量可能很难消化。  
既然整个示例架构项目是一个Maven父子结构，那我们就从父模块一个个好好过一遍。  
首先父模块的pom.xml包含了如下子模块：

<modules>
      <module>demo-web-client</module>
      <module>demo-web-adapter</module>
      <module>demo-web-app</module>
      <module>demo-web-domain</module>
      <module>demo-web-infrastructure</module>
      <module>start</module>
    </modules>

### start层 ###

该模块作为整个应用的启动模块（通常是一个SpringBoot应用），只承担启动项目和全局相关配置项的存放职责。代码目录如下：  
![image-1667317201674][]  
将启动独立出来，好处是清晰简洁，也能让新人一眼就看出如何运行项目，以及项目的一些基础依赖。

### adapter层 ###

接下来我们按照之前架构图从上到下的顺序，一个个看。  
首先是demo-web-adapter模块，这名字是不是很新鲜？但其实，可以理解为平时我们用的controller层（对于Web应用来说），换汤不换药。  
在COLA官方博客中，也能找到如下的描述：

> Controller这个名字主要是来自于MVC，因为是MVC，所以自带了Web应用的烙印。然而，随着mobile的兴起，现在很少有应用仅仅只支持Web端，通常的标配是Web，Mobile，WAP三端都要支持。

![image-1667317260605][]

### cilent层 ###

有了我们说的“controller”层，接下来有的小伙伴肯定就会想，是不是service层啦。  
*是，也不是。*  
传统的Web应用中，完全可以只有一个service层给controller层调用，但是作为一个业务应用，除非你真的只是个前端页面的无情吐数据机器，否则很大可能性你的应用会有很多其他上下游调用方，并且你需要提供接口给他们。  
这时候你给他们的不应该是一个Web接口，应该是RPC调用的服务层接口，至于原因不是本文的重点，具体就不展开了。  
所以在COLA中，你的adapter层，调用了client层，client层中就是你服务接口的定义。  
![image-1667317299134][]

从上图中可以看到，client包里有：

*  api文件夹：存放服务接口定义
 *  dto文件夹：存放传输实体  
    注意，这里只是服务接口定义，而不是服务层的具体实现，所以在adapter层中，调用的其实是client层的接口：

@RestController
    public class CustomerController {
        
    
        @Autowired
        private CustomerServiceI customerService;
    
        @GetMapping(value = "/customer")
        public MultiResponse<CustomerDTO> listCustomerByName(@RequestParam(required = false) String name){
        
            CustomerListByNameQry customerListByNameQry = new CustomerListByNameQry();
            customerListByNameQry.setName(name);
            return customerService.listByName(customerListByNameQry);
        }
    
    }

而最终接口的具体实现逻辑放到了app层。

@Service
    @CatchAndLog
    public class CustomerServiceImpl implements CustomerServiceI {
        
    
        @Resource
        private CustomerListByNameQryExe customerListByNameQryExe;
    
        @Override
        public MultiResponse<CustomerDTO> listByName(CustomerListByNameQry customerListByNameQry) {
        
            return customerListByNameQryExe.execute(customerListByNameQry);
        }
    }

### app层 ###

接着上面说的，我们的app模块作为服务的实现，存放了各个业务的实现类，并且严格按照业务分包，这里划重点，是先按照业务分包，再按照功能分包的，为何要这么做，文章后面还会多说两句，先看图：  
![image-1667317459685][]

customer和order分别对应了消费着和订单两个业务子领域。里面是COLA定义app层下面三种功能：  
![image-1667317506478][]  
可以看到，消息队列的消费者和定时任务，这类平时我们业务开发经常会遇到的场景，也放在app层。

### domain层 ###

接下来便是domain，也就是领域层，先看一下领域层整体结构：  
![image-1667317530540][]  
可以看到，首先是按照不同的领域（customer和order）分包，里面则是三种主要的文件类型：

1.  领域实体：实体模型可以是充血模型（请自行了解），例如官方示例里的Customer.java如下：

@Data
    @Entity
    public class Customer{
        
    
        private String customerId;
        private String memberId;
        private String globalId;
        private long registeredCapital;
        private String companyName;
        private SourceType sourceType;
        private CompanyType companyType;
    
        public Customer() {
        
        }
    
        public boolean isBigCompany() {
        
            return registeredCapital > 10000000; //注册资金大于1000万的是大企业
        }
    
        public boolean isSME() {
        
            return registeredCapital > 10000 && registeredCapital < 1000000; //注册资金大于10万小于100万的为中小企业
        }
    
        public void checkConfilict(){
        
            //Per different biz, the check policy could be different, if so, use ExtensionPoint
            if("ConflictCompanyName".equals(this.companyName)){
        
                throw new BizException(this.companyName+" has already existed, you can not add it");
            }
    
        }
    }

1.  领域能力：domainservice文件夹下，是领域对外暴露的服务能力，如上图中的CreditChecker
2.  领域网关：gateway文件夹下的接口定义，这里的接口你可以粗略的理解成一种SPI，也就是交给infrastructure层去实现的接口。

例如CustomerGateway里定义了接口getByById，要求infrastructure的实现类必须定义如何通过消费者Id获取消费者实体信息，而infrastructure层可以实现任何数据源逻辑，比如，从MySQL获取，从Redis获取，还是从外部API获取等等。

public interface CustomerGateway {
        
        public Customer getByById(String customerId);
    }

在示例代码的CustomerGatewayImpl（位于infrastructure层）中，CustomerDO（数据库实体）经过MyBatis的查询，转换为了Customer领域实体，进行返回。完成了依赖倒置。

@Component
    public class CustomerGatewayImpl implements CustomerGateway {
        
        @Autowired
        private CustomerMapper customerMapper;
    
        public Customer getByById(String customerId){
        
          CustomerDO customerDO = customerMapper.getById(customerId);
          //Convert to Customer
          return null;
        }
    }

![image-1667317642180][]

### infrastructure层 ###

最后是我们的infrastructure也就是基础设施层，这层有我们刚才提到的gatewayimpl网关实现，也有MyBatis的mapper等数据源的映射和config配置文件。  
![image-1667317675069][]  
![image-1667317687177][]  
所有层讲完了，COLA4.0很简单明了，*最后，在引用一段官方介绍博客原文来总结COLA的层级：*

> 1）适配层（Adapter Layer）：负责对前端展示（web，wireless，wap）的路由和适配，对于传统B/S系统而言，adapter就相当于MVC中的controller；
> 
> 2）应用层（Application Layer）：主要负责获取输入，组装上下文，参数校验，调用领域层做业务处理，如果需要的话，发送消息通知等。层次是开放的，应用层也可以绕过领域层，直接访问基础实施层；
> 
> 3）领域层（Domain Layer）：主要是封装了核心业务逻辑，并通过领域服务（Domain Service）和领域对象（Domain Entity）的方法对App层提供业务实体和业务逻辑计算。领域是应用的核心，不依赖任何其他层次；
> 
> 4）基础实施层（Infrastructure Layer）：主要负责技术细节问题的处理，比如数据库的CRUD、搜索引擎、文件系统、分布式服务的RPC等。此外，领域防腐的重任也落在这里，外部依赖需要通过gateway的转义处理，才能被上面的App层和Domain层使用。

## COLA架构的特色 ##

说完了分层架构，我们再来回顾下上面提到的COLA架构的几个特色的设计

### 领域与功能的分包策略 ###

也就是下面这张图的意思，先按照领域分包，再按照功能分包，这样做的其中一点好处是能将腐烂控制在该业务域内。

比如消费者customer和订单order两个领域是两个后端开发并行开发，两个人对于dto，util这些文件夹的命名习惯都不同，那么只会腐烂在各自的业务包下面，而不会将dto,util,config等文件夹放在一起，极容易引发文件冲突。

## ![image-1667317754335][] ##

![image-1667317763178][]

> 前面的包定义，都是功能维度的定义。为了兼顾领域维度的内聚性，我们有必要对包结构进行一下微调，即顶层包结构应该是按照领域划分，让领域内聚。

业务域和外部依赖解耦  
前面提到的domain和infrastructure层的依赖倒置，是一个非常有用的设计，进一步解耦了取数逻辑的实现。

例如下图中，你的领域实体是商品item，通过gateway接口，你的商品的数据源可以是数据库，也可以是外部的服务API。

如果是外部的商品服务，你经过API调用后，商品域吐出的是一个大而全的DTO（可能包含几十个字段），而在下单这个阶段，订单所需要的可能只是其中几个字段而已。你拿到了外部领域DTO，转为自己领域的Item，只留下标题价格库存等必要的数据字段。  
![image-1667317816138][]

## COLA并不完美 ##

诚然，COLA已经做的足够清晰简洁了，但是它仍然有不完美的地方，比如每个接口的出入参都会根据业务名做定义，导致了很多结构极为相似的DTO，DTO的爆炸增长是个问题。参考：[ISSUE-271][]  
但是总的来说，COLA只是给你提供了一种架构设计的思想，并不深入到强制你使用某种规范的层面，所以对于COLA中你觉得复杂，或者不理解的地方，很多时候需要你自己来做权衡，作取舍。取其精华，去其糟粕的运用到你的项目中。

# 总结 #

COLA架构并不复杂，COLA已经从1.0版本经过逐次精简，发展到了如今的形态。在代码脚手架生成器中作为一个可选项，足见其已经趋于成熟。

### 来源&参考 ###

腾讯云社区  
https://cloud.tencent.com/developer/article/1971122

COLA Github  
https://github.com/alibaba/COLA

COLA 4.0.0 版本  
https://blog.csdn.net/significantfrank/article/details/110934799

COLA 3.1.0 版本  
https://blog.csdn.net/significantfrank/article/details/109529311

COLA 3.0.0 版本  
https://blog.csdn.net/significantfrank/article/details/106976804

COLA 2.0.0 版本  
https://blog.csdn.net/significantfrank/article/details/100074716

COLA 1.0.0 版本  
https://blog.csdn.net/significantfrank/article/details/85785565

[Link 1]: https://www.zwnblog.com/
[image-1667315500441]: https://img-blog.csdnimg.cn/img_convert/9dd776c39058008833478439e777edfc.png
[image-1667315509367]: https://img-blog.csdnimg.cn/img_convert/3b2ef3ca78112191d61a68c7985dde5f.png
[image-1667317111251]: https://img-blog.csdnimg.cn/img_convert/e666b890223d0d52b507470903637ee3.png
[image-1667317201674]: https://img-blog.csdnimg.cn/img_convert/7b41ad5dcf60c89d3133ba47a947da5c.png
[image-1667317260605]: https://img-blog.csdnimg.cn/img_convert/59e75c29f8b9268040d7d7e2048e2079.png
[image-1667317299134]: https://img-blog.csdnimg.cn/img_convert/d15d3a2bc7e0ba84ddadbdea090fb190.png
[image-1667317459685]: https://img-blog.csdnimg.cn/img_convert/cd50a3f1a5fce7cee8795af8f931e1eb.png
[image-1667317506478]: https://img-blog.csdnimg.cn/img_convert/5c5d4c2598f65bd8e3e1dbdc48d4d2e0.png
[image-1667317530540]: https://img-blog.csdnimg.cn/img_convert/8d17d73863c0104cf11b221f389be024.png
[image-1667317642180]: https://img-blog.csdnimg.cn/img_convert/0131a5529be610e700fae08398fa915a.png
[image-1667317675069]: https://img-blog.csdnimg.cn/img_convert/b7726914be3688b01cee05a5ff84714d.png
[image-1667317687177]: https://img-blog.csdnimg.cn/img_convert/696afb494b3df45669060d45d71b5c59.png
[image-1667317754335]: https://img-blog.csdnimg.cn/img_convert/08f2cf898d6b1c6484296e7aebdb475d.png
[image-1667317763178]: https://img-blog.csdnimg.cn/img_convert/b6822263459f5b9c9404d2850cf512cd.png
[image-1667317816138]: https://img-blog.csdnimg.cn/img_convert/06553daf5f2ba14d6970334ed2beafd5.png
[ISSUE-271]: https://github.com/alibaba/COLA/issues/271