MyBatis-plus 是一款 Mybatis 增强工具,用于简化开发,提高效率。下文使用缩写 mp来简化表示 MyBatis-plus,本文主要介绍 mp 搭配 Spring Boot 的使用。
快速入门
1.创建一个Spring Boot项目。
2.导入依赖
<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.5.5</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.ccode</groupId><artifactId>springboot-mp</artifactId><version>0.0.1-SNAPSHOT</version><name>springboot-mp</name><description>Demo project for Spring Boot</description><properties><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId></dependency><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.4.2</version></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.12</version><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><excludes><exclude><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></exclude></excludes></configuration></plugin></plugins></build></project>
3.配置数据库
# application.ymlspring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://192.168.71.128:3306/test?serverTimezone=Asia/Shanghaiusername: rootpassword: rootmybatis-plus:configuration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #开启sql语句打印
4.创建一个实体类
package com.ccode.pojo;import lombok.Data;import java.time.LocalDateTime;/*** @auther 14632* @date 2021/10/3 18:11*/@Datapublic class User {private Long id;private String name;private Integer age;private String email;private Long managerId;private LocalDateTime createTime;}
5.创建一个mapper接口
package com.ccode.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.ccode.pojo.User;/*** @auther 14632* @date 2021/10/3 18:12*/public interface UserMapper extends BaseMapper<User> {}
6.在SpringBoot启动类上配置mapper接口的扫描路径
package com.ccode;import org.mybatis.spring.annotation.MapperScan;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication@MapperScan("com.ccode.mapper")public class SpringbootMpApplication {public static void main(String[] args) {SpringApplication.run(SpringbootMpApplication.class, args);}}
7.在数据库中创建表
DROP TABLE IF EXISTS user;CREATE TABLE user (id BIGINT(20) PRIMARY KEY NOT NULL COMMENT '主键',name VARCHAR(30) DEFAULT NULL COMMENT '姓名',age INT(11) DEFAULT NULL COMMENT '年龄',email VARCHAR(50) DEFAULT NULL COMMENT '邮箱',manager_id BIGINT(20) DEFAULT NULL COMMENT '直属上级id',create_time DATETIME DEFAULT NULL COMMENT '创建时间',CONSTRAINT manager_fk FOREIGN KEY(manager_id) REFERENCES user (id)) ENGINE=INNODB CHARSET=UTF8;INSERT INTO user (id, name, age ,email, manager_id, create_time) VALUES(1, '大BOSS', 40, 'boss@baomidou.com', NULL, '2021-03-22 09:48:00'),(2, '李经理', 40, 'boss@baomidou.com', 1, '2021-01-22 09:48:00'),(3, '黄主管', 40, 'boss@baomidou.com', 2, '2021-01-22 09:48:00'),(4, '吴组长', 40, 'boss@baomidou.com', 2, '2021-02-22 09:48:00'),(5, '小菜', 40, 'boss@baomidou.com', 2, '2021-02-22 09:48:00')
8.编写一个SpringBoot测试类
package com.ccode;import com.ccode.mapper.UserMapper;import com.ccode.pojo.User;import org.junit.Test;import org.junit.runner.RunWith;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import org.springframework.test.context.junit4.SpringRunner;import java.util.List;/*** @auther 14632* @date 2021/10/3 19:41*/@RunWith(SpringRunner.class)@SpringBootTestpublic class SampleTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testSelect(){List<User> list = userMapper.selectList(null);assertEquals(5, list.size());list.forEach(System.out::println);}private void assertEquals(int i, int size) {}}
核心功能
注解
mp一共提供了8个注解,这些注解是用在Java的实体类上面的。
@TableName
注解在类上,指定类和数据库表的映射关系。实体类的类名(转成小写后)和数据库表名相同时,可以不指定该注解。
@TableId
注解在实体类的某一字段上,表示这个字段对应数据库表的主键。当主键名为id时(表中列名为id,实体类中字段名为id),无需使用该注解显式指定主键,mp会自动关联。若类的字段名和表的列名不一致,可用value属性指定表的列名。另,这个注解有个重要的属性type,用于指定主键策略。
@TableField
排除非表字段
若Java实体类中某个字段,不对应表中的任何列,它只是用于保存一些额外的,或组装后的数据,则可以设置exist属性为false,这样在对实体对象进行插入时,会忽略这个字段。排除非表字段也可以通过其他方式完成,如使用static或transient关键字,但个人觉得不是很合理,不做赘述
字段验证策略
若Java实体类中某个字段,不对应表中的任何列,它只是用于保存一些额外的,或组装后的数据,则可以设置exist属性为false,这样在对实体对象进行插入时,会忽略这个字段。排除非表字段也可以通过其他方式完成,如使用static或transient关键字,但个人觉得不是很合理,不做赘述
字段填充策略
通过fill属性指定,字段为空时会进行自动填充
@Version
@EnumValue
@TableLogic
逻辑删除
@KeySequence
@InterceptorIgnore
插件过滤规则
CRUD接口
mp封装了一些最基础的CRUD方法,只需要直接继承mp提供的接口,无需编写任何SQL,即可食用。mp提供了两套接口,分别是Mapper CRUD接口和Service CRUD接口。并且mp还提供了条件构造器Wrapper,可以方便地组装SQL语句中的WHERE条件。
Mapper CRUD接口
只需定义好实体类,然后创建一个接口,继承mp提供的BaseMapper,即可使用。mp会在mybatis启动时,自动解析实体类和表的映射关系,并注入带有通用CRUD方法的mapper。BaseMapper里提供的方法,部分列举如下:
- insert(T entity) 插入一条记录
- deleteById(Serializable id) 根据主键id删除一条记录
- delete(Wrapper
wrapper) 根据条件构造器wrapper进行删除 - selectById(Serializable id) 根据主键id进行查找
- selectBatchIds(Collection idList) 根据主键id进行批量查找
- selectByMap(Map
map) 根据map中指定的列名和列值进行等值匹配查找 - selectMaps(Wrapper
wrapper) 根据 wrapper 条件,查询记录,将查询结果封装为一个Map,Map的key为结果的列,value为值 - selectList(Wrapper
wrapper) 根据条件构造器wrapper进行查询 - update(T entity, Wrapper
wrapper) 根据条件构造器wrapper进行更新 - updateById(T entity)
- …
下面讲解几个比较特别的方法
selectMaps
BaseMapper接口还提供了一个selectMaps方法,这个方法会将查询结果封装为一个Map,Map的key为结果的列,value为值
该方法的使用场景如下:
- 只查部分列
当某个表的列特别多,而SELECT的时候只需要选取个别列,查询出的结果也没必要封装成Java实体类对象时(只查部分列时,封装成实体后,实体对象中的很多属性会是null),则可以用selectMaps,获取到指定的列后,再自行进行处理即可
@Testpublic void test1(){QueryWrapper<User> queryWrapper = new QueryWrapper<>();queryWrapper.select("id","name","email").likeRight("name","黄");List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);maps.forEach(System.out::println);}
进行数据统计
// 按照直属上级进行分组,查询每组的平均年龄,最大年龄,最小年龄/**select avg(age) avg_age ,min(age) min_age, max(age) max_age from user group by manager_id having sum(age) < 500;**/@Testpublic void test2() {QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.select("manager_id", "avg(age) avg_age", "min(age) min_age", "max(age) max_age").groupBy("manager_id").having("sum(age) < {0}", 500);List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);maps.forEach(System.out::println);}
selectObjs
只会返回第一个字段(第一列)的值,其他字段会被舍弃
比如:
@Testpublic void test3() {QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.select("id", "name").like("name", "黄");List<Object> objects = userMapper.selectObjs(wrapper);objects.forEach(System.out::println);}

得到的结果,只封装了第一列的id
selectCount
查询满足条件的总数,注意,使用这个方法,不能调用QueryWrapper的select方法设置要查询的列了。这个方法会自动添加select count(1)
@Testpublic void test4() {QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.like("name", "黄");Integer count = userMapper.selectCount(wrapper);System.out.println(count);}
Service CRUD 接口
另外一套CRUD是Service层的,只需要编写一个接口,继承IService,并创建一个接口实现类,即可食用。(这个接口提供的CRUD方法,和Mapper接口提供的功能大同小异,比较明显的区别在于IService支持了更多的批量化操作,如saveBatch,saveOrUpdateBatch等方法。
1.首先,新建一个接口,继承IService
package com.ccode.service;import com.baomidou.mybatisplus.extension.service.IService;import com.ccode.pojo.User;/*** @auther 14632* @date 2021/10/3 20:50*/public interface UserService extends IService<User> {}
2.创建这个接口的实现类,并继承ServiceImpl,最后打上@Service注解,注册到Spring容器中,即可使用
package com.ccode.service.impl;import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;import com.ccode.mapper.UserMapper;import com.ccode.pojo.User;import com.ccode.service.UserService;/*** @auther 14632* @date 2021/10/3 20:53*/@Servicepublic class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {}
3.测试代码
package com.ccode;import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;import com.baomidou.mybatisplus.core.toolkit.Wrappers;import com.ccode.pojo.User;import com.ccode.service.UserService;import org.junit.Test;import org.junit.runner.RunWith;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import org.springframework.test.context.junit4.SpringRunner;/*** @auther 14632* @date 2021/10/3 20:55*/@SpringBootTest@RunWith(SpringRunner.class)public class ServiceTest {@Autowiredprivate UserService userService;@Testpublic void testGetOne() {LambdaQueryWrapper<User> wrapper = Wrappers.<User>lambdaQuery();wrapper.gt(User::getAge, 28);User one = userService.getOne(wrapper, false); // 第二参数指定为false,使得在查到了多行记录时,不抛出异常,而返回第一条记录System.out.println(one);}}

另,IService也支持链式调用,代码写起来非常简洁,查询示例如下
@Testpublic void testChain() {List<User> list = userService.lambdaQuery().gt(User::getAge, 39).likeRight(User::getName, "王").list();list.forEach(System.out::println);}
更新示例如下
@Testpublic void testChain1() {userService.lambdaUpdate().gt(User::getAge, 39).likeRight(User::getName, "王").set(User::getEmail, "w39@baomidou.com").update();}

删除示例如下
@Testpublic void testChain2() {userService.lambdaUpdate().like(User::getName, "青蛙").remove();}
条件构造器
mp让我觉得极其方便的一点在于其提供了强大的条件构造器Wrapper,可以非常方便的构造WHERE条件。条件构造器主要涉及到3个类,AbstractWrapper。QueryWrapper,UpdateWrapper,它们的类关系如下
在AbstractWrapper中提供了非常多的方法用于构建WHERE条件,而QueryWrapper针对SELECT语句,提供了select()方法,可自定义需要查询的列,而UpdateWrapper针对UPDATE语句,提供了set()方法,用于构造set语句。条件构造器也支持lambda表达式,写起来非常舒爽。
下面对AbstractWrapper中用于构建SQL语句中的WHERE条件的方法进行部分列举
- eq:equals,等于
- allEq:all equals,全等于
- ne:not equals,不等于
- gt:greater than ,大于 >
- ge:greater than or equals,大于等于≥
- lt:less than,小于<
- le:less than or equals,小于等于≤
- between:相当于SQL中的BETWEEN
- notBetween
- like:模糊匹配。like(“name”,”黄”),相当于SQL的name like ‘%黄%’
- likeRight:模糊匹配右半边。likeRight(“name”,”黄”),相当于SQL的name like ‘黄%’
- likeLeft:模糊匹配左半边。likeLeft(“name”,”黄”),相当于SQL的name like ‘%黄’
- notLike:notLike(“name”,”黄”),相当于SQL的name not like ‘%黄%’
- isNull
- isNotNull
- in
- and:SQL连接符AND
- or:SQL连接符OR
- apply:用于拼接SQL,该方法可用于数据库函数,并可以动态传参
- …….
使用示例
// 案例先展示需要完成的SQL语句,后展示Wrapper的写法// 1. 名字中包含佳,且年龄小于25// SELECT * FROM user WHERE name like '%佳%' AND age < 25QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.like("name", "佳").lt("age", 25);List<User> users = userMapper.selectList(wrapper);// 下面展示SQL时,仅展示WHERE条件;展示代码时, 仅展示Wrapper构建部分// 2. 姓名为黄姓,且年龄大于等于20,小于等于40,且email字段不为空// name like '黄%' AND age BETWEEN 20 AND 40 AND email is not nullwrapper.likeRight("name","黄").between("age", 20, 40).isNotNull("email");// 3. 姓名为黄姓,或者年龄大于等于40,按照年龄降序排列,年龄相同则按照id升序排列// name like '黄%' OR age >= 40 order by age desc, id ascwrapper.likeRight("name","黄").or().ge("age",40).orderByDesc("age").orderByAsc("id");// 4.创建日期为2021年3月22日,并且直属上级的名字为李姓// date_format(create_time,'%Y-%m-%d') = '2021-03-22' AND manager_id IN (SELECT id FROM user WHERE name like '李%')wrapper.apply("date_format(create_time, '%Y-%m-%d') = {0}", "2021-03-22") // 建议采用{index}这种方式动态传参, 可防止SQL注入.inSql("manager_id", "SELECT id FROM user WHERE name like '李%'");// 上面的apply, 也可以直接使用下面这种方式做字符串拼接,但当这个日期是一个外部参数时,这种方式有SQL注入的风险wrapper.apply("date_format(create_time, '%Y-%m-%d') = '2021-03-22'");// 5. 名字为王姓,并且(年龄小于40,或者邮箱不为空)// name like '王%' AND (age < 40 OR email is not null)wrapper.likeRight("name", "王").and(q -> q.lt("age", 40).or().isNotNull("email"));// 6. 名字为王姓,或者(年龄小于40并且年龄大于20并且邮箱不为空)// name like '王%' OR (age < 40 AND age > 20 AND email is not null)wrapper.likeRight("name", "王").or(q -> q.lt("age",40).gt("age",20).isNotNull("email"));// 7. (年龄小于40或者邮箱不为空) 并且名字为王姓// (age < 40 OR email is not null) AND name like '王%'wrapper.nested(q -> q.lt("age", 40).or().isNotNull("email")).likeRight("name", "王");// 8. 年龄为30,31,34,35// age IN (30,31,34,35)wrapper.in("age", Arrays.asList(30,31,34,35));// 或wrapper.inSql("age","30,31,34,35");// 9. 年龄为30,31,34,35, 返回满足条件的第一条记录// age IN (30,31,34,35) LIMIT 1wrapper.in("age", Arrays.asList(30,31,34,35)).last("LIMIT 1");// 10. 只选出id, name 列 (QueryWrapper 特有)// SELECT id, name FROM user;wrapper.select("id", "name");// 11. 选出id, name, age, email, 等同于排除 manager_id 和 create_time// 当列特别多, 而只需要排除个别列时, 采用上面的方式可能需要写很多个列, 可以采用重载的select方法,指定需要排除的列wrapper.select(User.class, info -> {String columnName = info.getColumn();return !"create_time".equals(columnName) && !"manager_id".equals(columnName);});
Condition
条件构造器的诸多方法中,均可以指定一个boolean类型的参数condition,用来决定该条件是否加入最后生成的WHERE语句中,比如
String name = "黄"; // 假设name变量是一个外部传入的参数QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.like(StringUtils.hasText(name), "name", name);// 仅当 StringUtils.hasText(name) 为 true 时, 会拼接这个like语句到WHERE中// 其实就是对下面代码的简化if (StringUtils.hasText(name)) {wrapper.like("name", name);}
实体对象作为条件
调用构造函数创建一个Wrapper对象时,可以传入一个实体对象。后续使用这个Wrapper时,会以实体对象中的非空属性,构建WHERE条件(默认构建等值匹配的WHERE条件,这个行为可以通过实体类里各个字段上的@TableField注解中的condition属性进行改变)
示例如下:
@Testpublic void test1() {User user = new User();user.setName("黄主管");user.setAge(28);QueryWrapper<User> wrapper = new QueryWrapper<>(user);List<User> users = userMapper.selectList(wrapper);users.forEach(System.out::println);}
若希望针对某些属性,改变等值匹配的行为,则可以在实体类中用@TableField注解进行配置,示例如下
package com.ccode.pojo;import com.baomidou.mybatisplus.annotation.SqlCondition;import com.baomidou.mybatisplus.annotation.TableField;import lombok.Data;import java.time.LocalDateTime;/*** @auther 14632* @date 2021/10/3 18:11*/@Datapublic class User {private Long id;@TableField(condition = SqlCondition.LIKE) // 配置该字段使用like进行拼接private String name;private Integer age;private String email;private Long managerId;private LocalDateTime createTime;}
运行下面的测试代码
@Testpublic void test3() {User user = new User();user.setName("黄");QueryWrapper<User> wrapper = new QueryWrapper<>(user);List<User> users = userMapper.selectList(wrapper);users.forEach(System.out::println);}
从下图得到的结果来看,对于实体对象中的name字段,采用了like进行拼接
@TableField中配置的condition属性实则是一个字符串,SqlCondition类中预定义了一些字符串以供选择
package com.ccode.condition;/*** @auther 14632* @date 2021/10/3 21:33*/public class SqlCondition {//下面的字符串中, %s 是占位符, 第一个 %s 是列名, 第二个 %s 是列的值public static final String EQUAL = "%s=#{%s}";public static final String NOT_EQUAL = "%s<>#{%s}";public static final String LIKE = "%s LIKE CONCAT('%%',#{%s},'%%')";public static final String LIKE_LEFT = "%s LIKE CONCAT('%%',#{%s})";public static final String LIKE_RIGHT = "%s LIKE CONCAT(#{%s},'%%')";}
SqlCondition中提供的配置比较有限,当我们需要<或>等拼接方式,则需要自己定义。比如
package com.ccode.pojo;import com.baomidou.mybatisplus.annotation.SqlCondition;import com.baomidou.mybatisplus.annotation.TableField;import lombok.Data;import java.time.LocalDateTime;/*** @auther 14632* @date 2021/10/3 18:11*/@Datapublic class User {private Long id;@TableField(condition = SqlCondition.LIKE) // 配置该字段使用like进行拼接private String name;@TableField(condition = "%s > #{%s}") // 这里相当于大于, 其中 > 是字符实体private Integer age;private String email;private Long managerId;private LocalDateTime createTime;}
测试如下
@Testpublic void test3() {User user = new User();user.setName("黄");user.setAge(30);QueryWrapper<User> wrapper = new QueryWrapper<>(user);List<User> users = userMapper.selectList(wrapper);users.forEach(System.out::println);}
从下图得到的结果,可以看出,name属性是用like拼接的,而age属性是用>拼接的

