Mybatis-Plus的使用

1. MyBatis-Plus介绍

MyBatis-Plus(简称 MP)是⼀个MyBatis的增强⼯具,在MyBatis的基础上只做增强不做改变,为简化开 发.提⾼效率⽽⽣

特性:

• 润物⽆声:只做增强不做改变，引⼊它不会对现有⼯程产⽣影响，如丝般顺滑.

• 效率⾄上:只需简单配置，即可快速进⾏单表CRUD操作，从⽽节省⼤量时间.

• 丰富功能:代码⽣成、⾃动分⻚、逻辑删除、⾃动填充、拦截器等功能⼀应俱全.

• ⼴泛认可:连续5年获得开源中国年度最佳开源项⽬殊荣，Github累计16KStar.

⽀持数据库: PostgreSQL, MySQL, MariaDB, Oracle, SQL Server, OceanBase, H2, DB2... (任何能使⽤MyBatis进行增删改查，并且⽀持标准SQL的数据库应该都在MyBatis-Plus的⽀持范围内)

2.准备项目

2. 1.Mysql的数据准备

创建用户表，并创建对应的实体类User

 <dependency><groupId>com.mysql</groupId><artifactId>mysql-connector-j</artifactId><scope>runtime</scope></dependency>

2.2.项目准备

1. 创建springboot⼯程

2. 添加MyBatis-Plus和MySQL依赖,配置数据库连接信息

2.1.1pom.xml文件配置

mybatis-plus

<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-spring-boot3-starter</artifactId>
<version>3.5.5</version>
</dependency>

MySQL

 <dependency><groupId>com.mysql</groupId><artifactId>mysql-connector-j</artifactId><scope>runtime</scope></dependency>

application.yml文件, 配置内容如下:

#数据库连接配置
spring:datasource:url: jdbc:mysql://127.0.0.1:3306/mybatis_test?characterEncoding=utf8&useSSL=falseusername: rootpassword: 123456driver-class-name: com.mysql.cj.jdbc.Driver

2.3 编码

创建实体类UserInfo

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserInfo {private Integer id;private String username;private String password;private Integer age;private Integer gender;private String phone;private Integer deleteFlag;private Date createTime;private Date updateTime;
}

编写Mapper接口类

MybatisPlus提供了⼀个基础的 BaseMapper 接口，已经实现了单表的CRUD,我们⾃定义的 Mapper只需要继承这个BaseMapper,就⽆需⾃⼰实现单表CRUD。

@Mapper
public interface UserInfoMapper extends BaseMapper<UserInfo> {}

在创建出来的SpringBoot⼯程中，在src下的test⽬录下，已经⾃动帮我们创建好了测试类，我们可以直接使用这个测试类来进行测试. 编写几个单元测试,测试基本的CRUD功能

@Slf4j //日志注解
@SpringBootTest //表示是测试类
class MybatisPlusDemoApplicationTests {@Autowiredprivate UserInfoMapper userInfoMapper;@Testvoid testInsert() {UserInfo user = new UserInfo();user.setUsername("张三");user.setPassword("123456");user.setAge(18);user.setGender(1);user.setPhone("12345678901");userInfoMapper.insert(user);}@Testvoid testSelectById() {UserInfo user = userInfoMapper.selectById(1L);System.out.println("user:  " + user);}@Testvoid testSelectByIds() {List<UserInfo> users = userInfoMapper.selectBatchIds(List.of(1L, 2L, 3L,4L));users.forEach(System.out::println);}@Testvoid testUpdateById() {UserInfo user = new UserInfo();user.setId(1);user.setPassword("4444444");userInfoMapper.updateById(user);}@Testvoid testDelete() {userInfoMapper.deleteById(5L);}
}

3. MyBatis-Plus复杂操作

3.1 常见注解

 @Mapperpublic interface UserInfoMapper extends BaseMapper<UserInfo> {}

UserlnfoMapper在继承BaseMapper时，指定了一个泛型，这个Userlnfo就是与数据库表相对应的实体类，
MyBatis-Plus会根据这个实体类来推断表的信息.
 

默认情况下：
 

1.表名：实体类的驼峰表示法转换成蛇形表示法（下划线分割)，作为表名.

比如  Userlnfo->user_info

2.字段：根据实体类的属性名转换为蛇形表示法作为字段名.

比如  deleteFlag->delete_flag

3.主键：默认为id
那如果实体类和数据库不是按照上述规则定义的呢？MyBatis-Plus也给我们提供了一下注解，让我们标识表的信息

3.1.1 @TableName

将UserInfo修改为Userinfo 通过@TableName来标识实体类对应的表

@Data
@TableName("user_info")
public class Userinfo {private Integer id;private String username;private String password;private Integer age;private Integer gender;private String phone;private Integer deleteFlag;private Date createTime;private Date updateTime;
}

 

做如上操作程序运行结果正常，不然会报出   mybatis_test.userinfo doesn't exist 异常.

3.1.2 @TableField

修改属性名deleteFlag为deleteflag,重新执行测试方法testSelectById

@Data
public class UserInfo {private Integer id;private String username;private String password;private Integer age;private Integer gender;private String phone;@TableField("delete_flag")private Integer deleteFlag;private Date createTime;private Date updateTime;
}

 

做如上操作程序运行结果正常，不然会报出   Unknown column 'deleteflag' in field list 异常

3.1.3 @TableId

我们可以通过@TableId来指定对应的主键

@Data
public class UserInfo {@TableId("id")private Integer userId;private String username;private String password;private Integer age;private Integer gender;private String phone;private Integer deleteFlag;private Date createTime;private Date updateTime;
}

如果属性名和字段名不⼀致,需要在 @TableId

指明对应的字段名 属性名和字段⼀致的情况下,直接加 @TableId 注解就可以

 做如上操作程序运行结果正常.

3.2 打印日志

为了方便学习，我们可以借助日志，查看Mybatis-Plus执行的SQL语句，参数和执行结果
Mybatis-Plus配置日志如下：

mybatis-plus:configuration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.3 条件构造器

入门程序里的使用，都是简单的CRUD，在实际的应用场景中，我们还需要使用更复杂的操作，MyBatis-Plus也给我们提供了相应的支持.

MyBatis-Plus提供了一套强大的条件构造器(Wrapper)，用于构建复杂的数据库查询条件.Wrapper类允许开发者以链式调用的方式构造查询条件，无需编写繁琐的SQL语句，从而提高开发效率并减少SQL注入的风险。

以下是主要的Wrapper类及其功能：

AstractWrapper	这是一个抽象基类，提供了所有Wrapper类共有的方法和属性.详细参考官网 介绍：条件构造器
QueryWrapper	用于构造查询条件，在AbstractWrapper的基础上拓展了一个select方法，允许指定查询字段.
UpdateWrapper	用于构造更新条件，可以在更新数据时指定条件.
LambdaQueryWrapper	基于Lambda表达式的查询条件构造器，它通过Lambda表达式来引用实体类的属性，从而避免了硬编码字段名.
ambdaUpdateWrapper	基于Lambda表达式的更新条件构造器，它允许你使用Lambda表达式来指定更新字段和条件，同样避免了硬编码字段名的问题.

3.3.1 QueryWrapper

QueryWrapper并不只用于查询语句,⽆论是修改,删除,查询,都可以使用QueryWrapper来构建查询条件.

查询

完成下述SQL查询

SELECT id,username,password,age FROM user_info WHERE age = 18 AND username 
"%min%"

测试代码

@Test
void testQueryWrapper(){
QueryWrapper<UserInfo> userInfoQueryWrapper = new QueryWrapper<UserInfo>()
.select("id","username","password","age")
.eq("age",18)
.like("username", "min");
List<UserInfo> userInfos = userInfoMapper.selectList(userInfoQueryWrapper) ;
userInfos.forEach(System.out::println);
}

更新

完成下述SQL查询

 UPDATE user_info SET delete_flag=? WHERE age < 20

测试代码

@Testvoid testUpdateByQueryWrapper(){QueryWrapper<UserInfo> userInfoQueryWrapper = new QueryWrapper<UserInfo>().lt("age", 20);UserInfo userInfo = new UserInfo();userInfo.setDeleteFlag(1);userInfoMapper.update(userInfo, userInfoQueryWrapper);}

lt："lessthan"的缩写，表示小于.
le："lessthanorequalto"的缩写，表示小于等于
ge："greaterthanorequalto"的缩写，表示大于等于.
gt："greaterthan"的缩写，表示大于.
eq："equals"的缩写，表示等于.
ne："notequals"的缩写，表示不等于.

删除

完成下述SQL查询

 DELETE FROM user_info WHERE age = 18

测试代码

 @Testvoid testDeleteByQueryWrapper(){QueryWrapper<UserInfo> userInfoQueryWrapper = new QueryWrapper<UserInfo>().eq("age",18);userInfoMapper.delete(userInfoQueryWrapper);}

3.3.2 UpdateWrapper

对于更新,我们也可以直接使⽤UpdateWrapper,在不创建实体对象的情况下,直接设置更新字段和条 件.

基础更新:

完成下述SQL查询

UPDATE user_info SET delete_flag=0, age=5 WHERE id IN (1,2,3)

测试代码

@Testvoid testUpdateByUpdateWrapper(){UpdateWrapper<UserInfo> updateWrapper = new UpdateWrapper<UserInfo>().set("delete_flag",0).set("age", 5).in("id", List.of(1,2,3));userInfoMapper.update(updateWrapper);}

基于SQL更新:

完成下述SQL查询

 UPDATE user_info SET age = age+10 WHERE id IN (1,2,3);

测试代码

@Testvoid testUpdateBySQLUpdateWrapper(){UpdateWrapper<UserInfo> updateWrapper = new UpdateWrapper<UserInfo>().setSql("age = age+10").in("id", List.of(1,2,3));userInfoMapper.update(updateWrapper);}

3.3.3 LambdaQueryWrapper

QueryWrapper和UpdateWrapper存在一个问题，就是需要写死字段名，如果字段名发生变更，可能会因为测试不到位酿成事故.

MyBatis-Plus给我们提供了一种基于Lambda表达式的条件构造器，它通过Lambda表达式来引用实体类的属性，从而避免了硬编码字段名，也提高了代码的可读性和可维护性.

LambdaQueryWrapper
LambdaUpdateWrapper
分别对应上述的QueryWrapper和UpdateWrapper

具体使用

 @Testvoid testLambdaQueryWrapper(){QueryWrapper<UserInfo> queryWrapper = new QueryWrapper<UserInfo>();queryWrapper.lambda().select(UserInfo::getUsername, UserInfo::getPassword,UserInfo::getAge).eq(UserInfo::getUserId, 1);userInfoMapper.selectList(queryWrapper).forEach(System.out::println);}

3.3.4 LambdaUpdateWrapper

LambdaUpdateWrapper⽤法和LambdaQueryWrapper相似

 @Testvoid testLambdUpdateByUpdateWrapper(){UpdateWrapper<UserInfo> updateWrapper = new UpdateWrapper<UserInfo>();updateWrapper.lambda().set(UserInfo::getDeleteFlag, 0).set(UserInfo::getAge, 5).in(UserInfo::getUserId, List.of(1,2,3));userInfoMapper.update(updateWrapper);}

3.4 自定义SQL

在实际的开发中,MyBatis-Plus提供的操作不能满⾜我们的实际需求,MyBatis-Plus也提供了⾃定义 SQL的功能,我们可以利⽤Wrapper构造查询条件,再结合Mapper编写SQL。为了使用这一功能，mybatis-plus版本不低于3.0.7

代码示例1

完成下述SQL查询

select id,username,password,age FROM user_info WHERE username = "admin"

Mapper:

@Mapperpublic interface UserInfoMapper extends BaseMapper<UserInfo> {@Select("select id,username,password,age FROM user_info 
${ew.customSqlSegment}")List<UserInfo> queryUserByCustom(@Param(Constants.WRAPPER) 
Wrapper<UserInfo> wrapper);}

测试代码

@Testvoid testQueryUserByCustom(){QueryWrapper<UserInfo> queryWrapper = new QueryWrapper<UserInfo>().eq("username","admin");userInfoMapper.queryUserByCustom(queryWrapper).forEach(System.out::println);}

注意事项：
参数命名：在自定义SQL时，传递Wrapper对象作为参数时，参数名必须为ew，或者使用注解
@Param（Constants.wRAPPER）明确指定参数为Wrapper对象.
·使用${ew.customSqlSegment}：在SQL语句中，使用${ew.customSqLSegment}来
引用Wrapper对象生成的SQL片段.
·不支持基于entity的where语句：自定义SQL时，Wrapper对象不会基于实体类自动生成
where子句，你需要手动编写完整的SQL语句.

代码示例2

MyBatis-Plus 在 MyBatis 的基础上只做增强不做改变,所以也⽀持XML的实现⽅式

上述功能也可以使⽤XML的⽅式完成

1. 配置mapper路径

 mybatis-plus:mapper-locations: "classpath*:/mapper/**.xml" # Mapper.xml

2. 定义方法

@Mapperpublic interface UserInfoMapper extends BaseMapper<UserInfo> {List<UserInfo> queryUserByCustom2(@Param(Constants.WRAPPER) 
Wrapper<UserInfo> wrapper);}

3. 编写XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.book.mapper.UserInfoMapper"><select id="queryUserByCustom2">select id,username,password,age FROM user_info ${ew.customSqlSegment}</select>
</mapper>

4. 测试

@Testvoid testQueryUserByCustom2(){QueryWrapper<UserInfo> queryWrapper = new QueryWrapper<UserInfo>().eq("username","admin");userInfoMapper.queryUserByCustom2(queryWrapper).forEach(System.out::println);}

代码示例3

完成下述SQL查询

UPDATE user_info SET age = age+10 WHERE id IN (1,2,3);

Mapper:

 @Update("UPDATE user_info SET age = age+ #{addAge}  ${ew.customSqlSegment}")void updateUserByCustom(@Param("addAge") int addAge, @Param("ew") 
Wrapper<UserInfo> wrapper);

测试代码

@Testvoid updateUserByCustom(){QueryWrapper<UserInfo> queryWrapper = new QueryWrapper<UserInfo>().in("id",List.of(1,2,3));userInfoMapper.updateUserByCustom(10, queryWrapper);}