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<M extends BaseMapper, 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可以大大提高我們的開發效率，減少重複代碼的編寫。

原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-hk/n/199846.html