代码层架构设计需要注意的问题

Love The Way You Lie 2021-11-04 16:14 443阅读 0赞

## 1.划清业务边界 ##

如果对未来的架构有微服务的考虑，那么在单体架构的时候就需要理清业务边界的问题，常见的简单划分就是以业务区分，例如：用户，商品，订单，支付，权限等等，具体的拆分程度可根据自身业务量和需要做划分。

当前流行的 DDD（领域驱动设计）可以作为一个指导原则，但是 DDD 比较偏向于理论，需要执行人员有良好的专业能力才能实施的比较好。

## 代码的层次结构 ##

业务区分好之后，就是项目代码模块的设计。在代码层我们需要根据MVC的模式，建议的代码设计层次如下：

├─demo-common
    │  │  demo-common.iml
    │  │  pom.xml
    │  │  
    │  └─src
    │      ├─main
    │      │  ├─java
    │      │  └─resources
    │      └─test
    │          └─java
    ├─demo-dao
    │  │  demo-dao.iml
    │  │  pom.xml
    │  │  
    │  └─src
    │      ├─main
    │      │  ├─java
    │      │  └─resources
    │      └─test
    │          └─java
    ├─demo-service
    │  │  demo-service.iml
    │  │  pom.xml
    │  │  
    │  └─src
    │      ├─main
    │      │  ├─java
    │      │  └─resources
    │      └─test
    │          └─java
    └─demo-web
        │  demo-web.iml
        │  pom.xml
        │  
        └─src
            ├─main
            │  ├─java
            │  └─resources
            └─test
                └─java

主要包含4个 module 模块

*  demo-common：基础模块，枚举，常亮类，工具类，配置类。
 *  demo-dao：Dao层，mapper接口，mapper.xml。
 *  demo-service：服务接口提供层，业务service接口。
 *  demo-web：web层，Controller类，服务接口，与外部进行交互。

各模块之间的依赖关系为：![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3R3dDkzNjQ1Nzk5MQ_size_16_color_FFFFFF_t_70]  
目 Module 模块设计完成之后，每个模块的内部 package 包如何设计呢？通常有两种划分模式：**根据业务模块然后内部按MVC划分，根据MVC模式然后内部按业务划分。**

1、**根据业务模块划分**，就是将每个业务模块作为一个 package，然后每个package里面有自己的 MVC，这样就做到业务模块的隔离。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3R3dDkzNjQ1Nzk5MQ_size_16_color_FFFFFF_t_70 1]  
2、**根据 MVC 模式划分**，先根据 MVC模式划分不同的包，service，serviceImpl，dto等，然后再是各个业务自己的模型和服务接口。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3R3dDkzNjQ1Nzk5MQ_size_16_color_FFFFFF_t_70 2]  
针对上述的两个划分模式，个人的选择是根据业务模式划分，这样的包设计与后期微服务拆分有良好的匹配度，拆分的时候只需要将每个业务包下的代码 Copy 到新的微服务中就行了，易迁移变动小。每个模块中对不同的业务通过 package 包名进行划分，例如：com.example.jajian.service.order、com.example.jajian.service.user等。

└─src
        ├─main
        │  ├─java
        │  │  └─com
        │  │      └─example
        │  │          └─jajian
        │  │              ├─common
        │  │              │      BaserService.java
        │  │              │      
        │  │              └─service
        │  │                  ├─order
        │  │                  │  ├─dto
        │  │                  │  │      OrderDto.java
        │  │                  │  │      
        │  │                  │  └─service
        │  │                  │      │  OrderService.java
        │  │                  │      │  
        │  │                  │      └─impl
        │  │                  │              OrderServiceImpl.java
        │  │                  │              
        │  │                  ├─pay
        │  │                  │  ├─dto
        │  │                  │  │      PayDto.java
        │  │                  │  │      
        │  │                  │  └─service
        │  │                  │      │  PayService.java
        │  │                  │      │  
        │  │                  │      └─impl
        │  │                  │              PayServiceImpl.java
        │  │                  │              
        │  │                  └─user
        │  │                      ├─dto
        │  │                      │      UserDto.java
        │  │                      │      
        │  │                      └─service
        │  │                          │  UserService.java
        │  │                          │  
        │  │                          └─impl
        │  │                                  UserServiceImpl.java
        │  │                                  
        │  └─resources
        └─test
            └─java

这样划分有什么好处？我们单体架构的时候这样开发，当需要拆分成微服务的时候就可以直接将业务包拆分出去，因为每个业务包里面就已经包含了所有的当前业务的关联业务类。

## 3.避免多边界的关联查询 ##

单表关联由于业务需要而且简单方便易使用，所以多表关联查询在单体服务中是普遍存在的，如果我们后期不需要做服务拆分则可以不需要考虑这方面的限制。

但是如果后期有微服务的规划，那么单体服务的时候如果没有做这个方面的限制，mybatis 的 mapper.xml中有过多的多表关联查询，这些关联查询会严重影响服务拆分的进度和复杂度。

如果同属于一个业务领域则可以使用关联查询，而那些微服务拆分后属于不同领域的业务则应避免使用多表关联查询，因为不同的业务领域后期会被隔离拆分到不同的服务当中，即数据库表都是分布在不同的服务器上，所有服务之间都是通过RPC方式进行通信，关联查询这时是无法处理的。

## 4.Controller尽量不做业务处理 ##

常看到很多 coder 会在Controller 层做一些业务处理，个人认为这是很不规范的。Controller层是控制层，是和前端进行数据转换的，这里我们应该只做请求的接受和返回，也无需做一些异常的try…catch…的捕获，异常可以通过全局通用拦截器统一进行拦截然后返回给前端异常提示语，提升代码的简洁性。

所有的参数校验也放到 service层，因为如果服务内部调用也可以使用提高代码的共用度。当然分层领域模型最好也能区分开。

*  DO(Data Object)：此对象与数据库表结构–对应，通过DAO层向上传输数据源对象。
 *  DTO（Date Transfer Object）：数据传输对象，service或Manager向外传输的对象。
 *  VO（View Object）:显示层的对象，通常是Web向模板渲染引擎层传输的对象。

这样区分开的好处是，当你需要对展示层数据进行特殊定制化的时候可以灵活变通，例如针对用户隐私信息身份证号，手机号码脱敏处理，或者用户ID加密显示等。

最后就是统一通用返回类了，通过这种格式的封装我们将数据格式进行全局格式化，这里的状态码可以自己设计的更详细一点。

public class CommonResult<T> {
    
        public static final String CODE_SUCCESS = "0";
        public static final String CODE_FAILED = "9999";
    
        private String code;
        private T data;
    
        private String msg;
    
        private CommonResult(String code, T data, String msg) {
            this.code = code;
            this.data = data;
            this.msg = msg;
        }
    
        public boolean isSuccess() {
            return CODE_SUCCESS.equals(code);
        }
    
        public static <T> CommonResult<T> success() {
            return new CommonResult<>(CODE_SUCCESS, null, null);
        }
    
        public static <T> CommonResult<T> success(T data) {
            return new CommonResult<>(CODE_SUCCESS, data, null);
        }
    
        public static <T> CommonResult<T> success(T data, String msg) {
            return new CommonResult<>(CODE_SUCCESS, data, msg);
        }
    
        public static <T> CommonResult<T> failed() {
            return new CommonResult<>(CODE_FAILED, null, null);
        }
    
        public static <T> CommonResult<T> failed(String errorCode, String msg) {
            return new CommonResult<>(errorCode, null, msg);
        }
    
        public static <T> CommonResult<T> failed(String msg) {
            return new CommonResult<>(CODE_FAILED, null, msg);
        }
    
        public static <T> CommonResult<T> failed(T data, String msg) {
            return new CommonResult<>(CODE_FAILED, data, msg);
        }
    
        public static <T> CommonResult<T> failed(String errorCode, T data, String msg) {
            return new CommonResult<>(errorCode, data, msg);
        }
       
       // 省略 setter、getter
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3R3dDkzNjQ1Nzk5MQ_size_16_color_FFFFFF_t_70]: /images/20211104/ddd40d7a3eeb4e1d9942adac75d45aba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3R3dDkzNjQ1Nzk5MQ_size_16_color_FFFFFF_t_70 1]: /images/20211104/af7efe82e231428386cfcecc16900207.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3R3dDkzNjQ1Nzk5MQ_size_16_color_FFFFFF_t_70 2]: /images/20211104/cd9f1eedfb774586b48282ba75656eba.png