1.常用注解
1.1 @TableName注解
MyBatis-Plus在确定操作的表时,由BaseMapper的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致。若实体类类型的类名和要操作的表的表名不一致,会出现什么问题?
将数据库user表改为t_user,运行测试方法。
可以看到报错了,mp依旧回去操作user表,但是此时数据库中已经没有user表了,所以就会报错,此时需要使用@TableName注解表明实体类与数据库表之间的映射关系。
@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("t_user")
public class User {
private Long id;
private String name;
private Integer age;
}
添加注解修改过后,再次运行测试就不会出现报错了。
同时,如果实体类与数据库表都是采用相同的前缀表示方法,例如:User -> t_user,那么可以使用全局配置来完成映射。
mybatis-plus:
# 设置MyBatis-Plus的全局配置
global-config:
db-config:
# 设置实体类所对应的表的统一前缀
table-prefix: t_
1.2 @TableId注解
MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认基于雪花算法的策略生成id。若实体类和表中表示主键的不是id,而是其他字段,例如uid。
将user类的id属性修改为uid,数据库表中id字段也同时改为uid,运行测试方法。,
可以看到mp依旧会操作id这个字段,所以就会出现报错。此时使用@TableId注解表明那个属性是主键即可解决这个问题。
@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("t_user")
public class User {
@TableId
private Long uid;
private String name;
private Integer age;
}
添加注解后,再次运行测试方法,就不会报错了。
@TableId注解有value属性,可以用来指定主键字段,type属性可以用来指定主键生成策略。
值 | 描述 |
---|---|
IdType.ASSIGN_ID(默认) | 基于雪花算法的策略生成数据id,与数据库id是否设置自增无关 |
IdType.AUTO | 使用数据库的自增策略,注意,该类型请确保数据库设置了id自增,否则无效 |
1.3 @TableField注解
MyBatis-Plus在执行SQL语句时,要保证实体类中的属性名和表中的字段名一致,如果实体类中的属性名和字段名不一致的情况,会出现什么问题呢?
将user类的name属性修改为userName,将数据库t_use表的name字段修改为user_name,运行测试方法。
此时运行成功了,若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格。例如实体类属性userName,表中字段user_name,此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格。
将user类的name属性修改为username,继续运行测试方法。
此时报错了,mp依旧会操作username,但是数据库表中没有这个字段。这时可以用@TableField注解来解决问题。
@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("t_user")
public class User {
@TableId
private Long uid;
@TableField("user_name")
private String username;
private Integer age;
}
添加注解后,再次运行测试方法,就不会报错了。
1.4 @TableLogic注解
- 物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除的数据
- 逻辑删除:假删除,将对应数据中代表是否被删除字段的状态修改为“被删除状态”,之后在数据库中仍旧能看到此条数据记录
修改实体类和数据库表结构。
@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("t_user")
public class User {
@TableId
private Long uid;
@TableField("user_name")
private String username;
private Integer age;
@TableLogic
private Integer isDelete;
}
接下来测试删除方法。
可以看到删除操作,只是修改记录的状态,将0变为1,表示由有效状态变为无效状态,但是实际的记录依旧在数据库中,并没有被删除掉。
2.条件构造器
2.1 wapper介绍
- Wrapper : 条件构造抽象类,最顶端父类
– AbstractWrapper : 用于查询条件封装,生成 sql 的 where 条件
– QueryWrapper : 查询条件封装
– UpdateWrapper : Update 条件封装
– AbstractLambdaWrapper : 使用Lambda 语法
---- LambdaQueryWrapper :用于Lambda语法使用的查询Wrapper
---- LambdaUpdateWrapper : Lambda 更新封装Wrapper
2.2 QueryWrapper
组装查询条件
@Test
public void testQueryWrapper(){
// 查询用户名中包含pica,并且年龄在20到24之间的用户
QueryWrapper<User> query = new QueryWrapper<>();
query.like("user_name", "pica")
.between("age", 20, 24);
List<User> userList = userMapper.selectList(query);
System.out.println(userList);
}
测试结果:
组装删除条件
@Test
public void testQueryWrapper1(){
// 删除年龄为23的用户
QueryWrapper<User> query = new QueryWrapper<>();
query.eq("age", 23);
int result = userMapper.delete(query);
System.out.println("影响的行数:" + result);
}
测试结果:
条件的优先级
@Test
public void testQueryWrapper2(){
// 将(年龄大于20并且用户名中包含有pica)或年龄为18的用户信息修改
QueryWrapper<User> query = new QueryWrapper<>();
query.like("user_name", "pica")
.gt("age", 20)
.or()
.eq("age", 18);
User user = new User();
user.setAge(18);
user.setUsername("修改");
int result = userMapper.update(user, query);
System.out.println("受影响的行数:" + result);
}
测试结果:
组装select子句
@Test
public void testQueryWrapper3() {
//查询用户信息的username和age字段
// SELECT username,age FROM t_user
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.select("user_name", "age");
//selectMaps()返回Map集合列表,通常配合select()使用,避免User对象中没有被查询到的列值 为null
List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
maps.forEach(System.out::println);
}
测试结果:
实现子查询
@Test
public void test06() {
//查询id大于5的用户信息
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.inSql("uid", "select uid from t_user where uid > 5");
//selectObjs的使用场景:只返回一列
List<Object> objects = userMapper.selectObjs(queryWrapper);
objects.forEach(System.out::println);
}
测试结果:
剩余的条件构造其使用基本一致,就不一一展示了。
3.分页插件
MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能。
添加配置类,实现分页插件功能。
@Configuration
//扫描mapper接口所在的包
@MapperScan("com.picacho.mybatisplus.mapper")
public class MyBatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//添加分页插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
@Test
public void testPage(){
//设置分页参数
Page<User> page = new Page<>(1, 5);
userMapper.selectPage(page, null);
//获取分页数据
List<User> list = page.getRecords();
list.forEach(System.out::println);
System.out.println("当前页:"+page.getCurrent());
System.out.println("每页显示的条数:"+page.getSize());
System.out.println("总记录数:"+page.getTotal());
System.out.println("总页数:"+page.getPages());
System.out.println("是否有上一页:"+page.hasPrevious());
System.out.println("是否有下一页:"+page.hasNext());
}
测试结果:
可以看到,直接添加一个配置,然后添加分页插件,就可以在代码中直接使用分页功能了,相当简便。