如何操作Mybatis-Plus通用CRUD

這篇文章給大家介紹如何操作Mybatis-Plus通用CRUD，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

1、插入操作

 1.1 方法定義

/*** 
插入一條記錄 *
@param entity 實體對象 
*/ 
int insert(T entity);

1.2 測試用例

@RunWith(SpringRunner.class)
@SpringBootTest
public class TestUserMapper {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testInsert(){
        User user=new User();
        user.setAge(12);
        user.setName("曹操");
        user.setPassword("123");
        user.setMail("caocao@qq.com");
        user.setUserName("曹操");
        user.setAddress("北京");
        //result數據庫受影響的行數
        int result = userMapper.insert(user);
        System.out.println("result=>"+result);
        //獲取自增長后的id值
        System.out.println(user.getId());//自增后的id會回填到對象中
    }
}

1.3 測試

可以看到，數據已經寫入到了數據庫，但是，id的值不正確，我們期望的是數據庫自增長，實際是MP生成了id的值
寫入到了數據庫。

如何設置id的生成策略呢？

MP支持的id策略

package com.baomidou.mybatisplus.annotation;

import lombok.Getter;

/**
 * 生成ID類型枚舉類
 *
 * @author hubin
 * @since 2015-11-10
 */
@Getter
public enum IdType {
    /**
     * 數據庫ID自增
     */
    AUTO(0),
    /**
     * 該類型為未設置主鍵類型
     */
    NONE(1),
    /**
     * 用戶輸入ID
     * <p>該類型可以通過自己注冊自動填充插件進行填充</p>
     */
    INPUT(2),

    /* 以下3種類型、只有當插入對象ID 為空，才自動填充。 */
    /**
     * 全局唯一ID (idWorker)
     */
    ID_WORKER(3),
    /**
     * 全局唯一ID (UUID)
     */
    UUID(4),
    /**
     * 字符串全局唯一ID (idWorker 的字符串表示)
     */
    ID_WORKER_STR(5);

    private final int key;

    IdType(int key) {
        this.key = key;
    }
}

修改User對象：

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user")
public class User {
    @TableId(value="id",type= IdType.AUTO)//設置id字段為自增長
    private Long id;
    private String userName;
    private String password;
    private String name;
    private Integer age;
    private String email;
}

數據插入成功：

1.4 @TableField

在MP中通過@TableField注解可以指定字段的一些屬性，常常解決的問題有2個：

1、對象中的屬性名和字段名不一致的問題（非駝峰）

2、對象中的屬性字段在表中不存在的問題

使用：

其他用法，如密碼字段不加入查詢字段：

效果：

.

2、更新操作

在MP中，更新操作有2種，一種是根據id更新，另一種是根據條件更新。

2.1 根據id更新

方法定義：

/*** 根據 ID 修改
 ** @param entity 實體對象
  */ 
int updateById(@Param(Constants.ENTITY) T entity);

測試：

@RunWith(SpringRunner.class) 
@SpringBootTest 
public class UserMapperTest { 

@Autowired private UserMapper userMapper; 

@Test 
public void testUpdateById() { 
	User user = new User(); user.setId(6L); //主鍵 
	user.setAge(21); //更新的字段 
	//根據id更新，更新不為null的字段 
	this.userMapper.updateById(user); 
} 

}

結果：

2.2 根據條件更新

方法定義：

/*** 
根據 whereEntity 條件，更新記錄 
**
 @param entity 實體對象 (set 條件值,可以為 null) * 
 @param updateWrapper 實體對象封裝操作類（可以為 null,里面的 entity 用于生成 where 語句） 
 */ 
 int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

測試用例：

@Test public void testUpdate() {
	User user = new User(); user.setAge(22); //更新的字段 
	//更新的條件 
	QueryWrapper<User> wrapper = new QueryWrapper<>(); 
	wrapper.eq("id", 6); 
	//執行更新操作 
	int result = this.userMapper.update(user, wrapper); 
	System.out.println("result = " + result); 
}

或者，通過UpdateWrapper進行更新：

@Test public void testUpdate() { 
	//更新的條件以及字段 
	UpdateWrapper<User> wrapper = new UpdateWrapper<>(); 
	wrapper.eq("id", 6).set("age", 23); 
	//執行更新操作 
	int result = this.userMapper.update(null, wrapper); 
	System.out.println("result = " + result); 
}

測試結果：

均可達到更新的效果。

關于wrapper更多的用法后面會詳細講解。

3、刪除操作

3.1 deleteById

方法定義：

/*** 根據 ID 刪除 ** 
@param id 主鍵ID */ 
int deleteById(Serializable id);

測試用例：

@Test 
public void testDeleteById() { 
	//執行刪除操作 
	int result = this.userMapper.deleteById(6L); 
	System.out.println("result = " + result); 
}

數據被刪除。

3.2 deleteByMap

方法定義：

/*** 根據 columnMap 條件，刪除記錄 ** 
@param columnMap 表字段 map 對象
 */ 
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

測試用例：

@Test 
public void testDeleteByMap() { 
	Map<String, Object> columnMap = new HashMap<>(); 
	columnMap.put("age",20); columnMap.put("name","張三"); 
	
	//將columnMap中的元素設置為刪除的條件，多個之間為and關系 
	int result = this.userMapper.deleteByMap(columnMap); 
	System.out.println("result = " + result); 
}

3.3 delete

方法定義：

/*** 
根據 entity 條件，刪除記錄 ** @param wrapper 實體對象封裝操作類（可以為 null）
 */ 
 int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);

測試用例：

@Test public void testDeleteByMap() { 
	User user = new User(); 
	user.setAge(20); 
	user.setName("張三"); 
	
	//將實體對象進行包裝，包裝為操作條件 
	QueryWrapper<User> wrapper = new QueryWrapper<>(user); 
	int result = this.userMapper.delete(wrapper); 
	System.out.println("result = " + result); 
}

結果：

3.4 deleteBatchIds

方法定義：

/*** 
刪除（根據ID 批量刪除） ** 
@param idList 主鍵ID列表(不能為 null 以及 empty) */ 
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

測試用例：

@Test 
public void testDeleteByMap() { 
	//根據id集合批量刪除 
	int result = this.userMapper.deleteBatchIds(Arrays.asList(1L,10L,20L)); 
	System.out.println("result = " + result); 
}

結果：

4、查詢操作

MP提供了多種查詢操作，包括根據id查詢、批量查詢、查詢單條數據、查詢列表、分頁查詢等操作。

4.1 selectById

方法定義：

/*** 
根據 ID 查詢 ** @param id 主鍵ID 
*/ 
T selectById(Serializable id);

測試用例：

@Test 
public void testSelectById() { 
	//根據id查詢數據 
	User user = this.userMapper.selectById(2L); 
	System.out.println("result = " + user); 
}

結果：

4.2 selectBatchIds

方法定義：

/*** 
查詢（根據ID 批量查詢） 
** @param idList 主鍵ID列表(不能為 null 以及 empty) 
*/ 
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

測試用例：

@Test 
public void testSelectBatchIds() { 
	//根據id集合批量查詢 
	List<User> users = this.userMapper.selectBatchIds(Arrays.asList(2L, 3L, 10L)); 
	for (User user : users) { 
	System.out.println(user); 
	} 
}

4.3 selectOne

方法定義：

/*** 
根據 entity 條件，查詢一條記錄 ** @param queryWrapper 實體對象封裝操作類（可以為 null） 
*/ 
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

測試用例：

@Test public void testSelectOne() { 
	QueryWrapper<User> wrapper = new QueryWrapper<User>(); 
	wrapper.eq("name", "李四"); 
	//根據條件查詢一條數據，如果結果超過一條會報錯 
	User user = this.userMapper.selectOne(wrapper);
	System.out.println(user); 
}

結果：

4.4 selectCount

方法定義：

/*** 
根據 Wrapper 條件，查詢總記錄數 ** 
@param queryWrapper 實體對象封裝操作類（可以為 null） 
*/ 
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

測試用例：

@Test 
public void testSelectCount() { 
	QueryWrapper<User> wrapper = new QueryWrapper<User>(); 
	wrapper.gt("age", 23); //年齡大于23歲 
	
	//根據條件查詢數據條數
	Integer count = this.userMapper.selectCount(wrapper); 
	System.out.println("count = " + count); 
}

4.5 selectList

方法定義：

/*** 
根據 entity 條件，查詢全部記錄 ** 
@param queryWrapper 實體對象封裝操作類（可以為 null） */ 
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

測試用例：

@Test 
public void testSelectList() { 
	QueryWrapper<User> wrapper = new QueryWrapper<User>(); 
	wrapper.gt("age", 23); //年齡大于23歲
	
	//根據條件查詢數據 
	List<User> users = this.userMapper.selectList(wrapper); 
	for (User user : users) { 
		System.out.println("user = " + user); 
	} 
}

4.6 selectPage

方法定義：

/*** 根據 entity 條件，查詢全部記錄（并翻頁） 
** @param page 分頁查詢條件（可以為 RowBounds.DEFAULT） 
* @param queryWrapper 實體對象封裝操作類（可以為 null） 
*/ 
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

配置分頁插件：

package cn.itcast.mp; 
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor; 
import org.mybatis.spring.annotation.MapperScan; 
import org.springframework.context.annotation.Bean; 
import org.springframework.context.annotation.Configuration; 

@Configuration 
@MapperScan("cn.itcast.mp.mapper") //設置mapper接口的掃描包 
public class MybatisPlusConfig { 
	/*** 分頁插件 */ 
	@Bean 
	public PaginationInterceptor paginationInterceptor() {
		return new PaginationInterceptor(); 
	} 
}

測試用例：

@Test 
public void testSelectPage() { 
	QueryWrapper<User> wrapper = new QueryWrapper<User>(); 
	wrapper.gt("age", 20); //年齡大于20歲 
	Page<User> page = new Page<>(1,1); 
	
	//根據條件查詢數據 
	IPage<User> iPage = this.userMapper.selectPage(page, wrapper); 
	System.out.println("數據總條數：" + iPage.getTotal()); 
	System.out.println("總頁數：" + iPage.getPages()); 
	
	List<User> users = iPage.getRecords(); 
	for (User user : users) { 
		System.out.println("user = " + user); 
	} 
}

結果：

5 SQL注入的原理

前面我們已經知道，MP在啟動后會將BaseMapper中的一系列的方法注冊到mappedStatements中，那么究竟是如
何注入的呢？流程又是怎么樣的？下面我們將一起來分析下。

在MP中，ISqlInjector負責SQL的注入工作，它是一個接口，AbstractSqlInjector是它的實現類，實現關系如下：

在AbstractSqlInjector中，主要是由inspectInject()方法進行注入的，如下：

 @Override
    public void inspectInject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass) {
        Class<?> modelClass = extractModelClass(mapperClass);
        if (modelClass != null) {
            String className = mapperClass.toString();
            Set<String> mapperRegistryCache = GlobalConfigUtils.getMapperRegistryCache(builderAssistant.getConfiguration());
            if (!mapperRegistryCache.contains(className)) {
                List<AbstractMethod> methodList = this.getMethodList();
                if (CollectionUtils.isNotEmpty(methodList)) {
                    TableInfo tableInfo = TableInfoHelper.initTableInfo(builderAssistant, modelClass);
                    // 循環注入自定義方法
                    methodList.forEach(m -> m.inject(builderAssistant, mapperClass, modelClass, tableInfo));
                } else {
                    logger.debug(mapperClass.toString() + ", No effective injection method was found.");
                }
                mapperRegistryCache.add(className);
            }
        }
    }

在實現方法中， methodList.forEach(m -> m.inject(builderAssistant, mapperClass, modelClass, tableInfo)); 是關鍵，循環遍歷方法，進行注入。

最終調用抽象方法injectMappedStatement進行真正的注入：

 /**
     * 注入自定義 MappedStatement
     *
     * @param mapperClass mapper 接口
     * @param modelClass  mapper 泛型
     * @param tableInfo   數據庫表反射信息
     * @return MappedStatement
     */
    public abstract MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo);

查看該方法的實現：

以SelectById為例查看：

可以看到，生成了SqlSource對象，再將SQL通過addSelectMappedStatement方法添加到mappedStatements中。

關于如何操作Mybatis-Plus通用CRUD就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。