您的位置:

MybatisPlusServiceImpl详解

一、简介

MybatisPlus是Mybatis的增强工具,提供了很多便捷的功能如代码生成器、分页插件、多租户注入等。MybatisPlusService接口是MybatisPlus提供的Service层接口,MybatisPlusServiceImpl是MybatisPlus对Service层接口的默认实现。在本文中,我们将从以下几个方面详细阐述MybatisPlusServiceImpl的相关内容。

二、实现分析

1. 基础实现

MybatisPlusServiceImpl是MybatisPlus提供的默认Service层接口实现,实现了IService接口,在这个基础上,MybatisPlusServiceImpl还提供了在IService接口基础上新增的一些方法,如 getBaseMapper()返回mapper、saveBatch()批量插入、removeByIds()批量删除等等。通过阅读源码,我们可以找到MybatisPlusServiceImpl的实现方式,其核心实现代码如下:

public class ServiceImpl, T> extends ServiceImplBase
    implements IService
     {

    @Override
    public M getBaseMapper() {
        return this.baseMapper;
    }

    @Override
    public boolean saveBatch(Collection
      entityList) {
        return super.saveBatch(entityList, DEFAULT_BATCH_SIZE);
    }

    @Override
    public boolean saveBatch(Collection
       entityList, int batchSize) {
        return super.saveBatch(entityList, batchSize);
    }

    @Override
    public boolean removeByIds(Collection idList) {
        return SqlHelper.delBool(baseMapper.deleteBatchIds(idList));
    }

    //...

}

      
     
    
   
  

MybatisPlusServiceImpl是通过继承ServiceImplBase来实现IService接口的,ServiceImplBase提供了很多增删改查的基础实现方法,这些方法的具体实现在IService接口中有详细说明。

2. 自定义实现

除了默认的基础实现外,MybatisPlusServiceImpl还提供了自定义实现的方式,比如我们可以自定义实现一些业务相关的方法。我们只需要继承MybatisPlusServiceImpl并在类中增加我们自己的方法即可,例如:

public class UserServiceImpl extends ServiceImpl implements UserService{

    @Override
    public List
    getUserVOList(){
        return baseMapper.getUserVOList();
    }

}

   
  

这样我们就可以在UserService中调用getUserVOList()方法来获取UserVO集合,这个方法的实现由我们自己编写。

三、常用功能

1. 基本增删改查

MybatisPlusServiceImpl提供了基本的增删改查方法,我们可以直接使用,这些方法包括:

  • save - 插入或更新一条记录
  • saveBatch - 批量插入记录
  • updateById - 根据ID修改一条记录
  • removeById - 根据ID删除一条记录
  • removeByIds - 根据ID批量删除记录
  • getById - 根据ID查询一条记录
  • list - 查询所有记录
  • page - 分页查询记录

其中list方法和page方法可以传入Wrapper来进行条件查询,下面是一个使用Wrapper进行分页查询的示例:

public IPage getUsers(Wrapper
    wrapper, Page
     page) {
    return baseMapper.selectPage(page, wrapper);
}

    
   
  

2. 常用注解

MybatisPlusServiceImpl还提供了一些常用注解,我们可以通过这些注解来方便地实现一些常用的操作。

  • @TableName - 当实体类和数据库表名不一致时,可以使用该注解来指定数据库表名
  • @TableId - 指定当前属性为主键
  • @TableField - 当属性和数据库表字段名不一致时,可以使用该注解来指定数据库字段名
  • @Version - 乐观锁,用于控制数据的并发访问,可以让数据在更新时判断是否被其他线程修改过

3. 自定义方法

MybatisPlusServiceImpl允许我们自定义方法,并且还可以调用Mapper中的方法以及使用自定义Mapper,这些操作都非常方便。

如果我们需要自定义方法,只需要在ServiceImpl中新增方法即可,例如:

public class UserServiceImpl extends ServiceImpl implements UserService{

    @Override
    public List
    getUserVOList(){
        return baseMapper.getUserVOList();
    }

}

   
  

如果需要调用Mapper中的方法,可以直接使用baseMapper调用,例如:

public List getUserVOList(){
    return baseMapper.getUserVOList();
}

  

如果需要使用自定义Mapper,可以在ServiceImpl中通过@Autowired注入自定义Mapper,例如:

public class UserServiceImpl extends ServiceImpl implements UserService{

    @Autowired
    private UserMapper userMapper;

    public List
    getUserVOList(){
        return userMapper.getUserVOList();
    }

}

   
  

四、结论

MybatisPlusServiceImpl是MybatisPlus提供的默认Service层接口实现,提供了基本的增删改查方法,并且允许我们自定义方法、调用Mapper中的方法以及使用自定义Mapper。在实际开发中,MybatisPlusServiceImpl可以大大提高我们的开发效率,减少重复代码的编写。