项目领域模型的应用

阳光穿透心脏的1/2处 2023-06-03 11:54 18阅读 0赞

### 1.领域对象的使用 ###

用于项目不同层次间的数据交互，并可以在不同层次中实现转换；

所有的领域对象建议使用贫血模型；

领域对象的使用会使得类数量增多；

### 2.常见的几种领域对象 ###

1.PO (persistant object)持久对象 / Entity：通常对应数据模型 ( 数据库 )。可以看成是与数据库中的表相映射的 Java 对象, PO 中应该不包含任何对数据库的操作。

2.DO（Domain Object）领域对象：从现实世界中抽象出来的有形或无形的业务实体。大多数情况下是与PO一一对应的。但是它还可以表示多个PO之间的业务关系（与PO接近）。

3.DTO（Data Transfer Object）数据传输对象：泛指用于展示层(web和api层)与服务层（service）之间的数据传输对象。

4.VO（View Object）：视图对象，用于展示层，它的作用是把某个指定页面（或组件）的所有数据封装起来(使用统一返回对象Result<xxxDto>()代替)。

5.QUERY: 查询对象，用于数据访问层。

常用的有：po/entity, dto, query

### 3.项目分层 ###

（摘自阿里开发规范）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nX2ppYXl1YW4_size_16_color_FFFFFF_t_70][]

### 4.各层的领域对象 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nX2ppYXl1YW4_size_16_color_FFFFFF_t_70 1][]

### 5.项目分包结构 ###

web, api, service, dal

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>web层</td> 
   <td>UserController</td> 
  </tr> 
  <tr> 
   <td>领域对象</td> 
   <td>query, dto</td> 
  </tr> 
 </tbody> 
</table>

@PostMapping(value = "/v1/school/{userId}")
    public ZHKUResult<UserDto> saveUser(@Validated UserSaveQuery query) {
         userService.saveUser(query);
         return new ZHKUResult<>();
    }
    
    @DeleteMapping(value = "/v1/school/{userId}")
    public ZHKUResult removeUser(@Validated UserQuery query) {
         userService.removeUser(query);
         return new ZHKUResult();
    }
    
    @PutMapping(value = "/v1/school/{userId}")
    public ZHKUResult<UserDto> updateUser(@Validated UserSaveQuery query) {
         userService.updateUser(query);
         return new ZHKUResult();
    }
    
    @GetMapping(value = "/v1/school/{userId}")
    public ZHKUResult<UserDto> findUser(@Validated UserQuery query) {
         return new ZHKUResult<UserDto>(userService.findUser(query));
    }

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>service-api层</td> 
   <td>UserService&nbsp; &lt;interface&gt;</td> 
  </tr> 
  <tr> 
   <td>领域对象</td> 
   <td>query, dto</td> 
  </tr> 
 </tbody> 
</table>

void saveUser(UserSaveQuery query);
    
    void removeUser(UserQuery query)
    
    void updateUser(UserSaveQuery query)
    
    UserDto findUser(UserQuery query)

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>service层</td> 
   <td>UserServiceImpl</td> 
  </tr> 
  <tr> 
   <td>领域对象</td> 
   <td>query, dto, po/entity</td> 
  </tr> 
 </tbody> 
</table>

void saveUser(UserSaveQuery query){
        systemService.validated(query);  //other service api, exp: dubbo api / http api
        UserEntity user = convert.toUserEntity(query);
        userManager.saveUser(user);
    }
    
    void deleteUser(UserQuery query){
        String userId = query.getUserId();
        userManager.deleteUser(userId);
    }
    
    void updateUser(usersaveQuery query){
        UserEntity user = convert.toUserEntity(query);
        userManager.updateUser(user);
    }
    
    UserDto findUser(UserQuery query){
        String userId = query.getUserId();
        UserEntity user = userManager.findUser(userId);
        return convert.toUserDto(user);
    }

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>dal-manager层</td> 
   <td>userManager</td> 
  </tr> 
  <tr> 
   <td>领域对象</td> 
   <td>po/entity</td> 
  </tr> 
 </tbody> 
</table>

void saveUser(UserEntity user){
        userMapper.saveUser(user);
    }
    
    void deleteUser(String userId){
        userMapper.deleteUser(userId);
    }
    
    void updateUser(UserEntity user){
        userMapper.updateUser(user);
    }
    
    UserEntity findUser(String userId){
        return userMapper.findUser(userId);
    }

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>dal层</td> 
   <td>UserMapper &lt;interface&gt;,与xml绑定</td> 
  </tr> 
  <tr> 
   <td>领域对象</td> 
   <td>po/entity</td> 
  </tr> 
 </tbody> 
</table>

void saveUser(@Param("user") UserEntity user);
    
    void deleteUser(@Param("userId") String userId);
    
    void updateUser(@Param("user")UserEntity user);
    
    UserEntity findUser(@Param("userId")String userId);

ps: 领域对象转换工具：mapstruct (实际使用存在部分字段转换失败的情况/bug，建议手动写默认方法实现转换，idea安装GenerateAllSetter插件)，或是浅拷贝 BeanUtils.copyProperties （缺点：1.对两个转换对象有要求,2.反射牺牲了性能）

### 实践规约 ###

1. 各个模块层级之间，不能跨级引用，不能层级倒转引用：即web -> api -> service -> service/manager -> dal;

2. 同层级只能单向引用不能循环引用，A service引用了B sevice，那么B service不能引用A service;

3. Controller层统一独立抽出放置网关中，所有的参数校验放在网关层;

4. Service层只能注入DAO（不建议），Manager层的依赖;

5. po/entity不可在web层，api层中暴露，系统对外提供的领域对象为dto;

6. 尽量每个请求使用不同的query;

7.dto需要实现序列化接口；

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nX2ppYXl1YW4_size_16_color_FFFFFF_t_70]: /images/20230601/58d953f596874f019fd18ace254ae54a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nX2ppYXl1YW4_size_16_color_FFFFFF_t_70 1]: /images/20230601/3b07866d69344e04b353da85dbaeb3be.png