关于Mybatis-Plus Wrapper是否应该出现在Servcie类中
一、问题
最近在做代码重构，代码工程采用了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层代码更清爽，可读性更好了，重构过程的代码改动量也在可接收的范围内。
到此这篇关于Mybatis-Plus Wrapper应该出现在Servcie类中吗？的文章就介绍到这了,更多相关Mybatis-Plus Wrapper内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了基于parameters参数实现参数化过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-08-08
SpringBoot+Redis Bitmap实现活跃用户统计
Redis的Bitmap数据结构是一种紧凑的位图,它可以用于实现各种场景,其中统计活跃用户是一种经典的业务场景,下面我们就来学习一下SpringBoot如何利用Redis中的Bitmap实现活跃用户统计吧2023-11-11
这篇文章主要介绍了Java中的Object类详细解读,java.lang.Object是类层次结构的根类,即所有其它类的父类,每个类都使用 Object 作为超类,需要的朋友可以参考下2023-11-11
文件上传SpringBoot后端MultipartFile参数报空问题的解决办法
这篇文章主要介绍了文件上传SpringBoot后端MultipartFile参数报空问题的解决办法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-11-11
下面小编就为大家带来一篇基于Spring中各个jar包的作用及依赖(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-11-11
springboot如何读取配置文件（application.yml）中的属性值
本篇文章主要介绍了springboot如何读取配置文件（application.yml）中的属性值，具有一定的参考价值，有兴趣的小伙伴可以了解一下2017-04-04
Delegate IDE build/run actions to maven 配置会影响程序运行吗?
这篇文章主要介绍了Delegate IDE build/run actions to maven 配置会影响程序运行吗，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2020-08-08
Spring Boot提供了多种方式来实现跨域请求,开发者可以根据具体需求选择适合的方法,在配置时,要确保不仅考虑安全性,还要兼顾应用的灵活性和性能,本文给大家介绍Spring Boot 中实现跨域的多种方式,感兴趣的朋友一起看看吧2024-01-01
深入分析JAVA 多线程--interrupt()和线程终止方式
这篇文章主要介绍了JAVA 多线程--interrupt()和线程终止方式的的相关资料，文中代码非常细致，帮助大家更好的理解和学习，感兴趣的朋友可以了解下2020-06-06
下面小编就为大家带来一篇基于HashMap遍历和使用方法(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-08-08
最新评论