MyBatis Plus通用CRUD与条件构造器使用及SQL自动注入原理分析

首先根据MyBatis Plus入门实践详解 搭建好工程。然后创建数据库表与相关的类。

表结构如下：

EmployeeMapper接口继承自BaseMapper

public interface EmployeeMapper extends BaseMapper {
}

这个BaseMapper是com.baomidou.mybatisplus.mapper.BaseMapper。这里测试的MyBatis Plus版本是：

   com.baomidou
   mybatis-plus
   2.3
		

BaseMapper定义了常用的增删改查接口，继承该接口后无需编写mapper.xml文件，即可获得通用的CRUD功能。

当然你可以在这个employeeMapper里面自定义方法，方法通过注解或者mapper.xml里面insert|update|select|delete实现。

【1】通用插入数据

① insert

测试代码如下：

@Test
public void testCommonInsert() {
	//初始化Employee对象
	Employee employee  = new Employee();
	employee.setLastName("MP");
	employee.setEmail("[email protected]");
	employee.setSalary(20000.0);
	//插入到数据库   
	Integer result = employeeMapper.insert(employee);  
	System.out.println("result: " + result );
	//获取当前数据在数据库中的主键值
	Integer key = employee.getId();
	System.out.println("key:" + key );
}

测试结果如下：

结论：

insert方法在插入时， 会根据实体类的每个属性进行非空判断，只有非空的属性对应的字段才会出现到SQL语句中

② insertAllColumn

测试代码如下：

@Test
public void testCommonInsert() {
	//初始化Employee对象
	Employee employee  = new Employee();
	employee.setLastName("MP");
	employee.setEmail("[email protected]");
	employee.setSalary(20000.0);
	//插入到数据库   
	Integer result = employeeMapper.insertAllColumn(employee);  
	System.out.println("result: " + result );
	//获取当前数据在数据库中的主键值
	Integer key = employee.getId();
	System.out.println("key:" + key );
}

测试结果如下：

结论

insertAllColumn方法在插入时， 不管属性是否非空， 属性所对应的字段都会出现到SQL语句中。

---

【2】通用更新数据

① updateById

测试代码如下：

@Test
public void testCommonUpdate() {
	//初始化修改对象
	Employee employee = new Employee();
	employee.setId(7);
	employee.setLastName("小泽老师");
	employee.setEmail("[email protected]");
	employee.setGender(0);
	Integer result = employeeMapper.updateById(employee)；
	System.out.println("result: " + result );
}

测试结果如下：

结论

updateById方法在更新时， 会根据实体类的每个属性进行非空判断，只有非空的属性对应的字段才会出现到SQL语句中

② updateAllColumnById

测试代码如下：

@Test
public void testCommonUpdate() {
	//初始化修改对象
	Employee employee = new Employee();
	employee.setId(7);
	employee.setLastName("小泽老师");
	employee.setEmail("[email protected]");
	employee.setGender(0);
	Integer result = employeeMapper.updateAllColumnById(employee)；
	System.out.println("result: " + result );
}

测试结果如下：

结论

updateAllColumnById方法在更新时， 不管属性是否非空， 属性所对应的字段都会出现到SQL语句中。

---

【3】通用查询数据

① selectById

测试代码如下：

Employee employee = employeeMapper.selectById(7);
System.out.println(employee);

测试结果如下：

② selectOne多列查询

测试代码如下：

Employee  employee = new Employee();
employee.setId(7);
employee.setLastName("小泽老师");
employee.setGender(0);

Employee result = employeeMapper.selectOne(employee);
System.out.println("result: " +result );

测试结果如下：

这里需要注意的是使用selectOne时需要保证数据库中顶多查询出一条数据，否则就会报错nested exception is org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found: 2

③ selectBatchIds

测试代码如下：

List idList = new ArrayList<>();
idList.add(7);
idList.add(8);
idList.add(9);
List emps = employeeMapper.selectBatchIds(idList);
System.out.println(emps);

测试结果如下：

④ selectByMap

测试代码如下：

Map columnMap = new HashMap<>();
//这里注意是列名， 非对象属性名
columnMap.put("last_name", "MP");
columnMap.put("gender", 1);

List emps = employeeMapper.selectByMap(columnMap);
System.out.println(emps);

测试结果如下：

⑤ 分页查询selectPage

测试代码如下：

List emps = employeeMapper.selectPage(new Page<>(2, 2), null);
System.out.println(emps);

测试结果如下：

可以看到SQL语句上面并没有limit关键字进行分页，但是返回的数据结果确实是经过分页处理的。这说明其并非是真正的物理分页，而是借助于RowBounds实现的内存分页。如果想实现物理分页，可以考虑使用pageHelper插件。

故而上述分页实例并不推荐，推荐使用MyBatis Plus的分页插件。

---

【4】通用删除数据

① deleteById

测试代码如下：

Integer result = employeeMapper.deleteById(13);
System.out.println("result: " + result );

测试结果如下：

将会返回删除条数，没有删除返回0。

② deleteByMap

根据组合条件删除，返回删除条数，没有删除返回0.

测试代码如下：

Map columnMap = new HashMap<>();
columnMap.put("last_name", "MP");
columnMap.put("email", "[email protected]");
Integer result = employeeMapper.deleteByMap(columnMap);
System.out.println("result: " + result );

测试结果如下：

③ deleteBatchIds

根据ID批量删除，返回删除的记录数，没有删除返回0。

测试代码如下：

List idList = new ArrayList<>();
idList.add(13);
idList.add(14);
idList.add(15);
Integer result = employeeMapper.deleteBatchIds(idList);
System.out.println("result: " + result );

测试结果如下：

---

【5】条件构造器使用

① 条件查询

如下，分页查询tbl_employee表中，年龄在18~50之间且性别为男且姓名为Tom的所有用户。

测试代码如下：

List emps =employeeMapper.selectPage(new Page(1, 2),
					new EntityWrapper()
					.between("age", 18, 50)
					.eq("gender", 1)
					.eq("last_name", "Tom")
				);
System.out.println(emps);

这里使用new EntityWrapper传一个Wrapper实例对象进去，使用between、eq这些关键字来封装查询条件(在JPA里面也可以看到这种思想)。

查询SQL如下：

SELECT id,last_name AS lastName,email,gender,age FROM tbl_employee 
WHERE (age BETWEEN ? AND ? AND gender = ? AND last_name = ?)

还可以使用Wrapper的另外一个子类Condition来实现上述效果，condition和EntityWrapper都wrapper的子类：

List emps = employeeMapper.selectPage(
							new Page(1,2),
							Condition.create()
							.between("age", 18, 50)
							.eq("gender", "1")
							.eq("last_name", "Tom")

							);
System.out.println(emps);

查询SQL如下：

SELECT id,last_name AS lastName,email,gender,age FROM tbl_employee 
WHERE (age BETWEEN ? AND ? AND gender = ? AND last_name = ?) 

---

② 组合条件模糊查询

查询tbl_employee表中， 性别为女并且名字中带有"老师" 或者 邮箱中带有"a"。

测试代码如下：

List emps = employeeMapper.selectList(
				new EntityWrapper()
				.eq("gender", 0)
				.like("last_name", "老师")
				.orNew()   // SQL: (gender = ? AND last_name LIKE ?) OR (email LIKE ?)
				.like("email", "a")
				);
System.out.println(emps);

查询SQL如下：

SELECT id,last_name AS lastName,email,gender,age FROM tbl_employee 
WHERE (gender = ? AND last_name LIKE ?) OR (email LIKE ?) 

Parameters: 0(Integer), %老师%(String), %a%(String)

上面使用的是orNew，下面对比使用or的时候查询SQL：

List emps = employeeMapper.selectList(
	new EntityWrapper()
	.eq("gender", 0)
	.like("last_name", "老师")
	.or()    // SQL: (gender = ? AND last_name LIKE ? OR email LIKE ?)
	.like("email", "a")
	);
System.out.println(emps);

SELECT id,last_name AS lastName,email,gender,age FROM tbl_employee 
WHERE (gender = ? AND last_name LIKE ? OR email LIKE ?)

Parameters: 0(Integer), %老师%(String), %a%(String)

可以发现OR只是作为一个查询条件，而orNew则封装了两个子查询。针对本例效果是一致的，但是在某些情况下结果会不一致。

---

③ 条件查询排序

查询性别为女的, 根据age进行排序(asc/desc), 简单分页。

测试代码如下：

List emps  = employeeMapper.selectList(
				new EntityWrapper()
				.eq("gender", 0)
				.orderBy("age")//默认升序 可以使用orderAsc
				//.orderDesc(Arrays.asList(new String [] {"age"}))
				.last("desc limit 1,3")
				);

查询SQL如下：

SELECT id,last_name AS lastName,email,gender,age FROM tbl_employee 
WHERE (gender = ?) ORDER BY age desc limit 1,3

---

④ 更新数据

测试代码如下：

@Test
public void testEntityWrapperUpdate() {
	
	Employee employee = new Employee();
	employee.setLastName("苍老师");
	employee.setEmail("[email protected]");
	employee.setGender(0);
	
	
	employeeMapper.update(employee, 
				new EntityWrapper()
				.eq("last_name", "Tom")
				.eq("age", 44)
				);
}

更新SQL如下：

Preparing: UPDATE tbl_employee SET last_name=?, email=?, gender=? WHERE (last_name = ? AND age = ?) 
 
Parameters: 苍老师(String), [email protected](String), 0(Integer), Tom(String), 44(Integer)

Updates: 0

⑤ 删除数据

测试代码如下：

@Test
public void testEntityWrapperDelete() {
	
	employeeMapper.delete(
				new EntityWrapper()
				.eq("last_name", "Tom")
				.eq("age", 22)
			);
}

测试结果如下：

为什么继承了BaseMapper后，不需要写SQL，不需要mapper.xml配置文件，即可使用大多CRUD方法？

---

【6】MP 启动注入 SQL原理分析

以如下代码为例跟踪一下究竟发生了什么：

@Test
public void testEntityWrapperUpdate() {
	
	Employee employee = new Employee();
	employee.setLastName("苍老师");
	employee.setEmail("[email protected]");
	employee.setGender(0);


	Integer update = employeeMapper.update(employee,
			new EntityWrapper()
					.eq("last_name", "Tom")
					.eq("age", 44)
	);
	System.out.println(update);
}

① 此时的employeeMapper对象是个什么？

此时的employeeMapper是个代理对象org.apache.ibatis.binding.MapperProxy@7728643a，如下图所示其是一个代理对象。

这里sqlsessionTemplate是sqlsession实现类：

主要属性如下：

继续跟踪其sqlSessionFactory属性，即employeeMapper.sqlSession.sqlSessionFactory:

sqlSessionFactory只有一个属性configuration，其是MybatisConfiguration实例对象，该实例对象有MybatisMapperRegistry注册中心实例对象、 mappedStatements(Configuration$StrictMap)。那么什么是mappedStatements？我们看一下：

似乎找到了employeeMapper那么多默认功能的来源！项目启动的时候初始化employeeMapper对象时会自动注入这些方法！那么具体如何注入的呢？我们跟下代码看看。

② debug运行代码

如下图所示，在启动的时候根据type注入了employeeMapper，在AbstractAutowireCapableBeanFactory类中调用了afterPropertiesSet方法，然后将一系列mapper的方法注入。

那么有两个问题：

• 1.调用了谁的afterPropertiesSet方法？afterPropertiesSet方法是InitializingBean接口的。
• 2.MappedStatement究竟是什么？
  

1.1 AbstractAutowireCapableBeanFactory.initializeBean

如下所示我们跟踪源码从这里开始，主要跟踪其invokeInitMethods方法。

	protected Object initializeBean(final String beanName, final Object bean, RootBeanDefinition mbd) {
		if (System.getSecurityManager() != null) {
			AccessController.doPrivileged(new PrivilegedAction