代码分层设计

背景

一般我们的后端，至少会有这么几层：Controller、Service、Mapper

每一层到底该做哪些事情，在一个项目中，一定是需要有一个统一的规范的，否则随着项目的演进，代码质量就会急剧下降，最终不可维护。

一个好的应用分层需要具备以下几点:

• 方便后续代码进行维护扩展；
• 分层的效果需要让整个团队都接受；
• 各个层职责边界清晰。

基本分层

传统的Controller、Service、Mapper三层代码结构，其各层的代码逻辑范围，我一般是如下处理的

Controller

• 创建

首先是Controller类的创建。

我们在对业务进行划分的时候，以某个维度和粒度为依据，将其相关的接口聚合到一个Controller类中。

如：

​ 系统配置：SysConfController

​ 订单相关：OrderController

​ 用户权限相关：UserAuthController

​ …

• Controller层做什么

1、日志

Controller作为请求的接收与返回，需要记录日志，便于问题排查。

有些系统已经通过其他日志解决方案进行了链路追踪，或者已经通过AOP等方案实现了日志记录，则不需要了。

2、参数校验

3、核心逻辑骨架搭建

如果当前请求的逻辑处理比较复杂，且分步逻辑可能在其他业务上进行复用，则每一个步骤可以在Controller中进行调用

如果步骤较多，则逻辑继续下沉到下一层的Service层。尽量一个Controller不要你超过20行

Service

• 创建

Controller类，其实是面向外部的，是外部系统会调用我们系统的哪些功能，然后本系统对这些功能进行分类，并汇总到某个Controller类上

那么相对的，Service类，其实是面向内部的。是系统内部能够提供什么功能，对这些功能进行了分类，并汇总到某个Service类上

大多数时候，一个Controller类都会对应某个Service类。也会有某个Service类服务于多个Controller的情况

• Service层做什么

Service层代码负责逻辑的具体实现

Mapper

一个Mapper，对应一个持久化的实体，一般如果持久化方式是关系型数据库的话，那就对应于一张表。

如果有表关联的情况，一般是根据当前SQL核心要查询的是哪张表，那么对应的SQL就编写在哪个Mapper上。

小结

以上的经典分层结构，粒度其实是比较粗的，实际环境中往往无法很好的达到要求。

阿里规约

以上为阿里的编码规范中约束的分层

开放接口层：可直接封装 Service 方法暴露成 RPC 接口;通过 Web 封装成 http 接口;进行 网关安全控制、流量控制等。

终端显示层：各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染， JSP 渲染，移动端展示等。

Web 层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。

Service 层：相对具体的业务逻辑服务层。

Manager 层：通用业务处理层，它有如下特征:1. 对第三方平台封装的层，预处理返回结果及转化异常信息;2. 对Service层通用能力的下沉，如缓存方案、中间件通用处理;3. 与DAO层交互，对多个DAO的组合复用。

DAO 层：数据访问层，与底层 MySQL、Oracle、Hbase 进行数据交互。

阿里巴巴规约中的分层比较清晰简单明了，但是描述得还是过于简单了，以及service层和manager层有很多同学还是有点分不清楚之间的关系，就导致了很多项目中根本没有Manager层的存在。下面介绍一下具体业务中应该如何实现分层。

优化分层

从我们的业务开发中总结了一个较为的理想模型,这里要先说明一下由于我们的rpc框架选用的是thrift可能会比其他的一些rpc框架例如dubbo会多出一层,作用和controller层类似

最上层controller和TService是我们阿里分层规范里面的第一层：轻业务逻辑，参数校验，异常兜底。通常这种接口可以轻易更换接口类型，所以业务逻辑必须要轻，甚至不做具体逻辑。

Service：业务层，复用性较低，这里推荐每一个controller方法都得对应一个service,不要把业务编排放在controller中去做，为什么呢？如果我们把业务编排放在controller层去做的话，如果以后我们要接入thrift,我们这里又需要把业务编排在做一次，这样会导致我们每接入一个入口层这个代码都得重新复制一份如下图所示:

这样大量的重复工作必定会导致我们开发效率下降，所以我们需要把业务编排逻辑都得放进service中去做:

Mannager：可复用逻辑层。这里的Mannager可以是单个服务的，比如我们的cache,mq等等，当然也可以是复合的，当你需要调用多个Mannager的时候，这个可以合为一个Mannager，比如逻辑上的连表查询等。如果是httpMannager或rpcMannager需要在这一层做一些数据转换

DAO：数据库访问层。主要负责“操作数据库的某张表，映射到某个java对象”，dao应该只允许自己的Service访问，其他Service要访问我的数据必须通过对应的Service。

分层领域对象

在阿里巴巴编码规约中列举了下面几个领域模型规约:

• DO（Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。
• DTO（Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。
• BO（Business Object）：业务对象。由Service层输出的封装业务逻辑的对象。
• AO（Application Object）：应用对象。在Web层与Service层之间抽象的复用对象模型，极为贴近展示层，复用度不高。
• VO（View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
• Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。

每一个层基本都自己对应的领域模型，这样就导致了有些人过于追求每一层都是用自己的领域模型，这样就导致了一个对象可能会出现3次甚至4次转换在一次请求中，当返回的时候同样也会出现3-4次转换，这样有可能一次完整的请求-返回会出现很多次对象转换。如果在开发中真的按照这么来，恐怕就别写其他的了，一天就光写这个重复无用的逻辑算了吧。

所以我们得采取一个折中的方案:

1、允许Service/Manager可以操作数据领域模型，对于这个层级来说，本来自己做的工作也是做的是业务逻辑处理和数据组装。

2、Controller/TService层的领域模型不允许传入DAO层，这样就不符合职责划分了。

3、同理，不允许DAO层的数据传入到Controller/TService。