关于Mybatis-Plus Wrapper是否应该出现在Servcie类中

作者:罗小爬EX 时间:2023-11-28 22:04:56 

一、问题

最近在做代码重构,代码工程采用了Controller/Service/Dao分层架构,Dao层使用了Mybatis-Plus框架。
在查看Service层时发现如下代码:

@Service
public class SampleServiceImpl implements SampleService {
   @Resource
   private SampleMapper sampleMapper;
   @Override
   public SampleTo findById(Long id) {
       Sample sample = this.sampleMapper.selectOne(Wrappers.<Sample>lambdaQuery()
               //仅查询指定的column
               .select(Sample::getId, Sample::getName, Sample::getDate)
               //查询条件 id = #{id}
               .eq(Sample::getId, id)
       );
       return (SampleTo) BaseAssembler.populate(sample, new SampleTo());
   }
   @Override
   public PageInfo<SampleTo> findListByDto(SampleQueryDto sampleQueryDto) {
       //开启分页
       PageHelperUtil.startPage(sampleQueryDto);
       //查询分页列表
       List<Sample> sampleList = this.sampleMapper.selectList(Wrappers.<Sample>lambdaQuery()
               //查询条件 id = #{id}
               .eq(Objects.nonNull(sampleQueryDto.getId()), Sample::getId, sampleQueryDto.getId())
               //查询条件 name like concat('%', #{name}, '%')
               .like(StringUtils.hasText(sampleQueryDto.getName()), Sample::getName, sampleQueryDto.getName())
               //查询条件 type = #{type}
               .eq(StringUtils.hasText(sampleQueryDto.getType()), Sample::getType, sampleQueryDto.getType())
               //查询条件 date >= #{startDate}
               .ge(Objects.nonNull(sampleQueryDto.getStartDate()), Sample::getDate, sampleQueryDto.getStartDate())
               //查询条件 date <= #{endDate}
               .le(Objects.nonNull(sampleQueryDto.getEndDate()), Sample::getDate, sampleQueryDto.getEndDate()));
       //转换分页结果
       return PageHelperUtil.convertPageInfo(sampleList, SampleTo.class);
   }
   @Override
   public List<SampleTo> findListByCondition(String name, String type) {
       List<Sample> sampleList = this.sampleMapper.selectList(Wrappers.<Sample>lambdaQuery()
               //查询条件 name like concat('%', #{name}, '%')
               .like(StringUtils.hasText(name), Sample::getName, name)
               //查询条件 type = #{type}
               .eq(StringUtils.hasText(type), Sample::getType, type)
       );
       return BaseAssembler.populateList(sampleList, SampleTo.class);
   }
@Override
   public SampleDetailTo findDetailById(Long id) {
       return this.sampleMapper.findDetail(id);
   }
   @Override
   public Integer add(SampleAddDto sampleAddDto) {
       Sample sample = new Sample();
       BaseAssembler.populate(sampleAddDto, sample);
       return this.sampleMapper.insert(sample);
   }
}

dao层代码:

public interface SampleMapper extends BaseMapper<Sample> {
//SQL脚本通过XML进行定义
   SampleDetailTo findDetail(@Param("id") Long id);
}

如上Service代码中直接使用Mybatis-Plus框架提供的Wrapper构造器,写的时候是挺爽,不用再单独为SampleMapper接口写XML脚本了,直接在Service类中都完成了,但是我不推荐这种写法。

分层架构的本意是通过分层来降低、隔离各层次的复杂度,
各层间仅通过接口进行通信,层间仅依赖抽象接口,不依赖具体实现,
只要保证接口不变可以自由切换每层的实现。

上述Service类中直接引用了Dao层实现框架Mybatis-Plus中的Wrappers类,尽管Servcie层依赖了Dao层的Mapper接口,但是Mapper接口中的参数Wrapper却是Dao层具体实现Mybatis-Plus所独有的,试想我们现在Dao层用的Mybatis-Plus实现,后续如果想将Dao层实现切换为Spring JPA,那Mybatis-Plus中Wrapper是不都要替换,那Servcie层中的相关Wrapper引用也都要进行替换,我们仅是想改变Dao实现,却不得不把Servcie层也进行修改。同时Service层本该是写业务逻辑代码的地方,但是却耦合进了大量的Wrapper构造逻辑,代码可读性差,难以捕捉到核心业务逻辑。

二、优化建议

那是不是Mybatis-Plus中的Wrapper就不能用了呢?我的答案是:能用,只是方式没用对。
Wrapper绝对是个好东西,方便我们构造Sql,也可以将我们从繁琐的XML脚本中解救出来,但是不能跨越层间界限。

优化建议如下:

  • 移除Servcie中的Wrapper使用

  • Java8+之后接口提供了默认方法的支持,可通过给Dao层Mapper接口添加default方法使用Wrapper

  • 单表相关的操作 - 通过Dao层Mapper接口的default方法直接使用Wrapper进行实现,提高编码效率

  • 多表关联的复杂操作 - 通过Dao层Mapper接口和XML脚本的方式实现

优化后的Service层代码如下:

@Service
public class SampleServiceImpl implements SampleService {
   @Resource
   private SampleMapper sampleMapper;
   @Override
   public SampleTo findById(Long id) {
       Sample sample = this.sampleMapper.findInfoById(id);
       return (SampleTo) BaseAssembler.populate(sample, new SampleTo());
   }
   @Override
   public SampleDetailTo findDetailById(Long id) {
       return this.sampleMapper.findDetail(id);
   }
   @Override
   public PageInfo<SampleTo> findListByDto(SampleQueryDto sampleQueryDto) {
       //开启分页
       PageHelperUtil.startPage(sampleQueryDto);
       //查询分页列表
       List<Sample> sampleList = this.sampleMapper.findList(sampleQueryDto);
       //转换分页结果
       return PageHelperUtil.convertPageInfo(sampleList, SampleTo.class);
   }
   @Override
   public List<SampleTo> findListByCondition(String name, String type) {
       List<Sample> sampleList = this.sampleMapper.findListByNameAndType(name, type);
       return BaseAssembler.populateList(sampleList, SampleTo.class);
   }
   @Override
   public Integer add(SampleAddDto sampleAddDto) {
       Sample sample = new Sample();
       BaseAssembler.populate(sampleAddDto, sample);
       return this.sampleMapper.insert(sample);
   }
}

优化后的Dao层代码:

public interface SampleMapper extends BaseMapper<Sample> {
   default Sample findInfoById(Long id) {
       return this.selectOne(Wrappers.<Sample>lambdaQuery()
               //仅查询指定的column
               .select(Sample::getId, Sample::getName, Sample::getDate)
               //查询条件 id = #{id}
               .eq(Sample::getId, id)
       );
   }
   default List<Sample> findList(SampleQueryDto sampleQueryDto) {
       return this.selectList(Wrappers.<Sample>lambdaQuery()
               //查询条件 id = #{id}
               .eq(Objects.nonNull(sampleQueryDto.getId()), Sample::getId, sampleQueryDto.getId())
               //查询条件 name like concat('%', #{name}, '%')
               .like(StringUtils.hasText(sampleQueryDto.getName()), Sample::getName, sampleQueryDto.getName())
               //查询条件 type = #{type}
               .eq(StringUtils.hasText(sampleQueryDto.getType()), Sample::getType, sampleQueryDto.getType())
               //查询条件 date >= #{startDate}
               .ge(Objects.nonNull(sampleQueryDto.getStartDate()), Sample::getDate, sampleQueryDto.getStartDate())
               //查询条件 date <= #{endDate}
               .le(Objects.nonNull(sampleQueryDto.getEndDate()), Sample::getDate, sampleQueryDto.getEndDate())
       );
   }
   default List<Sample> findListByNameAndType(String name, String type) {
       return this.selectList(Wrappers.<Sample>lambdaQuery()
               //查询条件 name like concat('%', #{name}, '%')
               .like(StringUtils.hasText(name), Sample::getName, name)
               //查询条件 type = #{type}
               .eq(StringUtils.hasText(type), Sample::getType, type)
       );
   }
   //SQL脚本通过XML进行定义)    
   SampleDetailTo findDetail(@Param("id") Long id);
}

优化后的Servcie层完全移除了对Wrapper的依赖,将Servcie层和Dao层实现进行解耦,同时Dao层通过Java8+接口的默认方法同时支持Wrapper和XML的使用,整合编码和XML脚本的各自优势。

三、Repository模式

经过优化过后,Service层代码确实清爽了许多,移除了Mybatis-Plus的Wrapper构造逻辑,使得Service层可以更专注于业务逻辑的实现。但是细心的小伙伴还是会发现Servcie层仍旧依赖了Mybatis的分页插件PageHelper中的PageHelper类、PageInfo类,PageHelper插件也是技术绑定的(强绑定到Mybatis),既然我们们之前强调了Servcie层与Dao层间的界限,如此在Servcie层使用PageHelper也是越界了,例如后续如果切换Spring JPA,那PageHelper在Servcie层的相关的引用也都需要调整。

真正做到业务和技术解耦,可以参考DDD中的Repository(仓库、资源库)模式

  • 单独定义通用的分页查询参数DTO、分页查询结果DTO(与具体技术解耦)

  • 定义Repository接口,仅依赖聚合、通用分页查询参数DTO、分页查询结果DTO

  • 定义Repository接口的实现类,具体实现可依赖如Mybatis、JPA等Dao框架,在Repository的具体实现类中完成转换:

    • 领域模型(聚合)<==> 数据实体

    • 通用分页查询参数DTO、结果DTO <==> Dao框架的分页参数、结果(如PageHelper、IPage等)

DDD映射到代码层面,改动还是比较大的,所以在这次重构代码的过程中并没有真正采用DDD Repository模式,
而是仅从Servcie中移除Mybatis-Plus Wrapper便结束了,虽没有完全将Service层与Dao层实现(PageHelper)解耦,
但在Service层移除Wrapper构造逻辑后,使得Service层代码更清爽,可读性更好了,重构过程的代码改动量也在可接收的范围内。

来源:https://blog.csdn.net/luo15242208310/article/details/130556852

标签:Mybatis-Plus,Wrapper
0
投稿

猜你喜欢

  • Android Handler之消息循环的深入解析

    2022-02-10 20:08:45
  • Java实现的日期处理类完整实例

    2023-12-08 00:16:10
  • Java interrupt()方法使用实例介绍

    2022-05-04 11:09:35
  • java编程求二叉树最大路径问题代码分析

    2023-03-16 20:44:16
  • Android编程实现AIDL(跨进程通信)的方法详解

    2022-08-29 00:19:23
  • C# 获取动态key的json对象的值案例

    2023-03-03 22:02:08
  • 在C# WPF下自定义滚动条ScrollViewer样式的操作

    2022-09-17 16:55:28
  • C#实现控制线程池最大数并发线程

    2023-02-23 14:50:43
  • 一文搞懂Java设计模式之责任链模式

    2021-12-24 22:19:40
  • Java 反射机制详解及实例代码

    2023-07-13 15:22:29
  • 关于bootstrap.yml和bootstrap.properties的优先级问题

    2021-10-04 11:50:30
  • Android RecycleView和线型布局制作聊天布局

    2022-08-01 15:36:56
  • ASM的tree api对匿名线程的hook操作详解

    2022-07-16 15:03:30
  • 基于spring-boot和docker-java实现对docker容器的动态管理和监控功能[附完整源码下载]

    2022-02-04 00:41:18
  • Java代码实现简单酒店管理系统

    2023-11-21 03:38:57
  • Java泛型变量如何添加约束

    2021-06-02 23:12:06
  • SpringTask实现定时任务方法讲解

    2022-06-11 11:43:42
  • Java Web实现session过期后自动跳转到登陆页功能【基于过滤器】

    2021-08-19 03:44:37
  • JAXB简介_动力节点Java学院整理

    2021-09-15 00:09:32
  • Spring-Security实现登录接口流程

    2023-03-24 05:35:40
  • asp之家 软件编程 m.aspxhome.com