【后端】MyBatis-Plus 体系（二）

MyBatis-Plus

四、常用注解

1. @TableName

• 经过以上的测试，在使用MyBatis-Plus实现基本的CRUD时，我们并没有指定要操作的表，只是在Mapper接口继承BaseMapper时，设置了泛型User，而操作的表为user表
• 由此得出结论，MyBatis-Plus在确定操作的表时，由BaseMapper的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致

1.1 问题

• 若实体类类型的类名和要操作的表的表名不一致，会出现什么问题？
  • 我们将表user更名为t_user，测试查询功能
  • 程序抛出异常，Table ‘mybatis_plus.user’ doesn’t exist，因为现在的表名为t_user，而默认操作的表名和实体类型的类名一致，即user表

1.2 通过@TableName解决问题

• 在实体类类型上添加@TableName(“t_user”)，标识实体类对应的表，即可成功执行SQL语句
  

1.3 通过全局配置解决问题

• 在开发的过程中，我们经常遇到以上的问题，即实体类所对应的表都有固定的前缀，例如t_或tbl_
• 此时，可以使用MyBatis-Plus提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过@TableName标识实体类对应的表

mybatis-plus: 
  configuration: 
    # 配置MyBatis日志 
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl 
  global-config: 
    db-config: 
    # 配置MyBatis-Plus操作表的默认前缀 
    table-prefix: t_

2. @TableId

• 经过以上的测试，MyBatis-Plus在实现CRUD时，会默认将id作为主键列，并在插入数据时，默认基于雪花算法的策略生成id

2.1 问题

• 若实体类和表中表示主键的不是id，而是其他字段，例如uid，MyBatis-Plus会自动识别uid为主键列吗？
• 我们实体类中的属性id改为uid，将表中的字段id也改为uid，测试添加功能
• 程序抛出异常，Field ‘uid’ doesn’t have a default value，说明MyBatis-Plus没有将uid作为主键赋值
  

2.2 通过@TableId解决问题

• 在实体类中uid属性上通过@TableId将其标识为主键，即可成功执行SQL语句
  

2.3 @TableId的value属性

• 若实体类中主键对应的属性为id，而表中表示主键的字段为uid，此时若只在属性id上添加注解@TableId，则抛出异常Unknown column ‘id’ in ‘field list’，即MyBatis-Plus仍然会将id作为表的主键操作，而表中表示主键的是字段uid
• 此时需要通过@TableId注解的value属性，指定表中的主键字段，@TableId(“uid”)或@TableId(value=“uid”)
• 只使用value属性，value可以省略
  
  

2.4 @TableId的type属性

• type属性用来定义主键策略
• 常用的主键策略：

值	描述
IdType.ASSIGN_ID（默认）	基于雪花算法的策略生成数据id，与数据库id是否设置自增无关
IdType.AUTO	使用数据库的自增策略，注意，该类型请确保数据库设置了id自增，否则无效

• 配置全局主键策略：

mybatis-plus: 
  configuration: 
    # 配置MyBatis日志 
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl   
  global-config: 
    db-config: 
      # 配置MyBatis-Plus操作表的默认前缀 
      table-prefix: t_ 
      # 配置MyBatis-Plus的主键策略 
      id-type: auto

2.5 雪花算法

• 背景
  • 需要选择合适的方案去应对数据规模的增长，以应对逐渐增长的访问压力和数据量。
  • 数据库的扩展方式主要包括：业务分库、主从复制，数据库分表。
• 数据库分表
  • 将不同业务数据分散存储到不同的数据库服务器，能够支撑百万甚至千万用户规模的业务，但如果业务继续发展，同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如，淘宝的几亿用户数据，如果全部存放在一台数据库服务器的一张表中，肯定是无法满足性能要求的，此时就需要对单表数据进行拆分。
  • 单表数据拆分有两种方式：垂直分表和水平分表。示意图如下：
    
• 垂直分表
  • 垂直分表适合将表中某些不常用且占了大量空间的列拆分出去。
  • 例如，前面示意图中的 nickname 和 description 字段，假设我们是一个婚恋网站，用户在筛选其他用户的时候，主要是用 age 和 sex 两个字段进行查询，而 nickname 和 description 两个字段主要用于展示，一般不会在业务查询中用到。description 本身又比较长，因此我们可以将这两个字段独立到另外一张表中，这样在查询 age 和 sex 时，就能带来一定的性能提升。
• 水平分表
  • 水平分表适合表行数特别大的表，有的公司要求单表行数超过 5000 万就必须进行分表，这个数字可以作为参考，但并不是绝对标准，关键还是要看表的访问性能。对于一些比较复杂的表，可能超过 1000 万就要分表了；而对于一些简单的表，即使存储数据超过 1 亿行，也可以不分表。
  • 但不管怎样，当看到表的数据量达到千万级别时，作为架构师就要警觉起来，因为这很可能是架构的性能瓶颈或者隐患。
  • 水平分表相比垂直分表，会引入更多的复杂性，例如要求全局唯一的数据id该如何处理。

主键自增
①以最常见的用户 ID 为例，可以按照 1000000 的范围大小进行分段，
1 ~ 999999 放到表 1中，
1000000 ~ 1999999 放到表2中，以此类推。
②复杂点：分段大小的选取。分段太小会导致切分后子表数量过多，增加维护复杂度；
分段太大可能会导致单表依然存在性能问题，
一般建议分段大小在 100 万至 2000 万之间，
具体需要根据业务选取合适的分段大小。
③优点：可以随着数据的增加平滑地扩充新的表。
例如，现在的用户是 100 万，如果增加到 1000 万，
只需要增加新的表就可以了，原有的数据不需要动。
④缺点：分布不均匀。假如按照 1000 万来进行分表，
有可能某个分段实际存储的数据量只有 1 条，
而另外一个分段实际存储的数据量有 1000 万条。

取模
①同样以用户 ID 为例，假如我们一开始就规划了 10 个数据库表，
可以简单地用 user_id % 10 的值来
表示数据所属的数据库表编号，
ID 为 985 的用户放到编号为 5 的子表中，
ID 为 10086 的用户放到编号为 6 的子表中。
②复杂点：初始表数量的确定。表数量太多维护比较麻烦，
表数量太少又可能导致单表性能存在问题。
③优点：表分布比较均匀。
④缺点：扩充新的表很麻烦，所有数据都要重分布。

雪花算法
雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的
主键的有序性。
①核心思想：
长度共64bit（一个long型）。
首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，
最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。
41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，
结果约等于69.73年。
10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，
可以部署在1024个节点）。
12bit作为毫秒内的流水号
（意味着每个节点在每毫秒可以产生 4096 个 ID）。
②优点：整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

3. @TableField

• 经过以上的测试，我们可以发现，MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致
• 如果实体类中的属性名和字段名不一致的情况，会出现什么问题呢？

3.1 情况1

• 若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格
• 例如实体类属性userName，表中字段user_name
• 此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格
• 相当于在MyBatis中配置

3.2 情况2

• 若实体类中的属性和表中的字段不满足情况1
• 例如实体类属性name，表中字段username
• 此时需要在实体类属性上使用@TableField(“username”)设置属性所对应的字段名
  

4. @TableLogic

4.1 逻辑删除

• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据
• 逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录
• 使用场景：可以进行数据恢复

4.2 实现逻辑删除

• step1：数据库中创建逻辑删除状态列，设置默认值为0
  
• step2：实体类中添加逻辑删除属性
  
• step3：测试
  • 测试删除功能，真正执行的是修改
  • UPDATE t_user SET is_deleted=1 WHERE id=? AND is_deleted=0
  • 测试查询功能，被逻辑删除的数据默认不会被查询
  • SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0

五、条件构造器和常用接口

1. wrapper介绍

• Wrapper ： 条件构造抽象类，最顶端父类
  • AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件
    • QueryWrapper ： 查询条件封装
    • UpdateWrapper ： Update 条件封装
    • AbstractLambdaWrapper ： 使用Lambda 语法
      • LambdaQueryWrapper ：用于Lambda语法使用的查询Wrapper
      • LambdaUpdateWrapper ： Lambda 更新封装Wrapper

2. QueryWrapper

2.1 组装查询条件

@Test 
public void test01(){ 
	//查询用户名包含a，年龄在20到30之间，并且邮箱不为null的用户信息 	
	//SELECT id,username AS name,age,email,is_deleted FROM t_user 
	//WHERE is_deleted=0 AND (username LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL) 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	queryWrapper.like("username", "a") 
			.between("age", 20, 30) 
			.isNotNull("email"); 
	List<User> list = userMapper.selectList(queryWrapper); 
	list.forEach(System.out::println); 
}

2.2 组装排序条件

@Test 
public void test02(){ 
	//按年龄降序查询用户，如果年龄相同则按id升序排列 
	//SELECT id,username AS name,age,email,is_deleted FROM t_user 
	//WHERE is_deleted=0 ORDER BY age DESC,id ASC QueryWrapper<User> 
	queryWrapper = new QueryWrapper<>(); 
	queryWrapper
		.orderByDesc("age") 
		.orderByAsc("id"); 
	List<User> users = userMapper.selectList(queryWrapper); 
	users.forEach(System.out::println); 
}

2.3 组装删除条件

@Test 
public void test03(){ 
	//删除email为空的用户 
	//DELETE FROM t_user WHERE (email IS NULL) 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	queryWrapper.isNull("email"); 
	//条件构造器也可以构建删除语句的条件 
	int result = userMapper.delete(queryWrapper); 
	System.out.println("受影响的行数：" + result); 
}

2.4 条件的优先级

@Test 
public void test04() { 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	//将（年龄大于20并且用户名中包含有a）或邮箱为null的用户信息修改 
	//UPDATE t_user SET age=?, email=? 
	//WHERE (username LIKE ? AND age > ? OR email IS NULL) 
	queryWrapper 
		.like("username", "a") 
		.gt("age", 20) 
		.or() 
		.isNull("email"); 
	User user = new User(); 
	user.setAge(18); 
	user.setEmail("user@gmail.com"); 
	int result = userMapper.update(user, queryWrapper); 
	System.out.println("受影响的行数：" + result); 
}

@Test 
public void test04() { 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	//将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改 
	//UPDATE t_user SET age=?, email=? 
	//WHERE (username LIKE ? AND (age > ? OR email IS NULL)) 
	//lambda表达式内的逻辑优先运算 
	queryWrapper
		.like("username", "a") 
		.and(i -> i.gt("age", 20)
		.or()
		.isNull("email")); 
	User user = new User(); 
	user.setAge(18); 
	user.setEmail("user@gmail.com"); 
	int result = userMapper.update(user, queryWrapper); 
	System.out.println("受影响的行数：" + result); 
}

2.5 组装select子句

@Test 
public void test05() { 
	//查询用户信息的username和age字段 
	//SELECT username,age FROM t_user 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	queryWrapper.select("username", "age"); 
	//selectMaps()返回Map集合列表，
	//通常配合select()使用，避免User对象中没有被查询到的列值为null
	List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper); 
	maps.forEach(System.out::println); 
}

2.6 实现子查询

@Test 
public void test06() { 
	//查询id小于等于3的用户信息 
	//SELECT id,username AS name,age,email,is_deleted FROM t_user 
	//WHERE (id IN (select id from t_user where id <= 3)) 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	queryWrapper.inSql("id", "select id from t_user where id <= 3"); 
	List<User> list = userMapper.selectList(queryWrapper); 
	list.forEach(System.out::println); 
}

3. UpdateWrapper

@Test 
public void test07() { 
	//将（年龄大于20或邮箱为null）并且用户名中包含有a的用户信息修改 
	//组装set子句以及修改条件 
	UpdateWrapper<User> updateWrapper = new UpdateWrapper<>(); 
	//lambda表达式内的逻辑优先运算 
	updateWrapper
		.set("age", 18) 
		.set("email", "user@alex.com") 
		.like("username", "a") 
		.and(i -> i.gt("age", 20)
		.or()
		.isNull("email")); 
	//这里必须要创建User对象，否则无法应用自动填充。如果没有自动填充，可以设置为null 
	//UPDATE t_user SET username=?, age=?,email=? 
	//WHERE (username LIKE ? AND (age > ? OR email IS NULL)) 
	//User user = new User(); 
	//user.setName("张三");
	//int result = userMapper.update(user, updateWrapper); 	
	//UPDATE t_user SET age=?,email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL)) 
	int result = userMapper.update(null, updateWrapper); 
	System.out.println(result); 
}

4. condition

• 在真正开发的过程中，组装条件是常见的功能，而这些条件数据来源于用户输入，是可选的，因此我们在组装这些条件时，必须先判断用户是否选择了这些条件，若选择则需要组装该条件，若没有选择则一定不能组装，以免影响SQL执行的结果
• 思路一：

@Test 
public void test08() { 
	//定义查询条件，有可能为null（用户未输入或未选择） 
	String username = null; 
	Integer ageBegin = 10; 
	Integer ageEnd = 24; 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace) 构成 
	if(StringUtils.isNotBlank(username)){ 
		queryWrapper.like("username","a"); 
	}
	if(ageBegin != null){ 
		queryWrapper.ge("age", ageBegin); 
	}
	if(ageEnd != null){ 
		queryWrapper.le("age", ageEnd); 
	}
	//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >= ? AND age <= ?) 
	List<User> users = userMapper.selectList(queryWrapper); 
	users.forEach(System.out::println); 
}

• 思路二

@Test 
public void test08UseCondition() { 
	//定义查询条件，有可能为null（用户未输入或未选择） 
	String username = null; 
	Integer ageBegin = 10; 
	Integer ageEnd = 24; 
	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
	//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace) 构成 
	queryWrapper
		.like(StringUtils.isNotBlank(username), "username", "a")
		.ge(ageBegin != null, "age", ageBegin) 
		.le(ageEnd != null, "age", ageEnd); 
	//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >= ? AND age <= ?) 
	List<User> users = userMapper.selectList(queryWrapper); 
	users.forEach(System.out::println); 
}

5. LambdaQueryWrapper

@Test 
public void test09() { 
	//定义查询条件，有可能为null（用户未输入） 
	String username = "a"; 
	Integer ageBegin = 10; 
	Integer ageEnd = 24; 
	LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>(); 
	//避免使用字符串表示字段，防止运行时错误 
	queryWrapper 
		.like(StringUtils.isNotBlank(username), User::getName, username) 
		.ge(ageBegin != null, User::getAge, ageBegin) 
		.le(ageEnd != null, User::getAge, ageEnd); 
	List<User> users = userMapper.selectList(queryWrapper); 
	users.forEach(System.out::println); 
}

6. LambdaUpdateWrapper

@Test 
public void test10() { 
	//组装set子句 
	LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>(); 
	updateWrapper 
		.set(User::getAge, 18) 
		.set(User::getEmail, "user@alex.com") 
		.like(User::getName, "a") 
		.and(i -> i.lt(User::getAge, 24)
		.or()
		.isNull(User::getEmail)); 
	//lambda 表达式内的逻辑优先运算 
	User user = new User(); 
	int result = userMapper.update(user, updateWrapper); 
	System.out.println("受影响的行数：" + result); 
}