本文纲要
一、MyBatis-Plus简介
二、环境准备与入门案例
2.1 创建Spring Boot工程
2.2 引入依赖
2.3 配置数据源
2.4 定义实体类
2.5 编写Mapper接口
2.6 测试查询
三、标准CRUD操作
3.1 新增操作
3.2 删除操作
3.3 修改操作
3.4 查询单个对象
3.5 查询全部
3.6 Lombok简化实体类
四、分页功能
4.1 配置分页拦截器
4.2 执行分页查询
4.3 开启MP日志
五、条件查询的三种方式
5.1 普通QueryWrapper方式
5.2 LambdaQueryWrapper方式
5.3 LambdaQueryWrapper链式编程
5.4 多条件组合:AND与OR
六、条件查询中的NULL判定
七、查询投影
7.1 指定查询字段
7.2 聚合查询与分组
八、查询条件详解
8.1 等值查询 eq
8.2 范围查询 between/lt/gt
8.3 模糊查询 like
8.4 更多条件参考
九、映射匹配兼容性
9.1 表名映射 @TableName
9.2 字段名映射 @TableField
9.3 忽略字段映射
9.4 敏感字段不参与查询
一、MyBatis-Plus简介
MyBatis-Plus(简称MP)是一个基于MyBatis框架的增强工具,在MyBatis的基础上只做增强不做改变,为简化开发、提高效率而生。
核心特性:
- 无侵入:引入
MP不会影响现有MyBatis的使用,可以平滑过渡。 - 强大的CRUD:内置通用
Mapper,仅通过继承即可获得单表大部分CRUD操作。 - Lambda支持:通过
Lambda表达式避免字段名写错。 - 主键策略:支持多种主键生成策略。
- 分页插件:天然集成物理分页,简单配置即可使用。
- 性能分析:内置
SQL执行效率分析插件。
二、环境准备与入门案例
我们将基于Spring Boot整合MyBatis-Plus,快速体验MP的强大之处。
项目结构概览
入门模块 mybatisplus_01_quickstart
mybatisplus_01_quickstart
├── pom.xml
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ └── wb
│ │ │ ├── Mybatisplus01QuickstartApplication.java
│ │ │ ├── config
│ │ │ │ └── MpConfig.java
│ │ │ ├── dao
│ │ │ │ └── UserDao.java
│ │ │ └── domain
│ │ │ └── User.java
│ │ └── resources
│ │ └── application.yml
│ └── test
│ └── java
│ └── com
│ └── wb
│ └── Mybatisplus01QuickstartApplicationTests.java
查询模块 mybatisplus_02_dql
mybatisplus_02_dql
├── pom.xml
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ └── wb
│ │ │ ├── Mybatisplus02DqlApplication.java
│ │ │ ├── dao
│ │ │ │ └── UserDao.java
│ │ │ └── domain
│ │ │ ├── User.java
│ │ │ └── query
│ │ │ └── UserQuery.java
│ │ └── resources
│ │ ├── application.yml
│ │ └── logback.xml
│ └── test
│ └── java
│ └── com
│ └── wb
│ └── Mybatisplus02DqlApplicationTests.java
1 ) 创建Spring Boot工程
使用Spring Initializr创建项目,选择:
- Spring Boot版本:2.5.0
- 依赖:MySQL Driver(不需要勾选MyBatis Framework)
2 ) 引入依赖
MP的起步依赖在IDEA中未收录,需要手动添加。在pom.xml中加入:
<dependencies>
<!-- MyBatis-Plus 起步依赖 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
<!-- Spring Boot 基础依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- 数据库连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.16</version>
</dependency>
<!-- MySQL驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- 测试 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- Lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
</dependencies>
注意:mybatis-plus-boot-starter已经内置了MyBatis及Spring整合的jar包,不要再额外引入MyBatis依赖,避免版本冲突。
3 ) 配置数据源
在 application.yml 中配置数据库连接:
spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC
username: root
password: root
4 ) 定义实体类
创建实体类User,与数据库表字段一一对应:
package com.wb.domain;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private String password;
private Integer age;
private String tel;
}
5 ) 编写Mapper接口
数据层接口继承 BaseMapper<User>,无需编写任何方法:
package com.wb.dao;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.wb.domain.User;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface UserDao extends BaseMapper<User> {
}
只需继承 BaseMapper 并指定泛型,MP会自动生成CRUD方法。
6 ) 测试查询
在测试类中注入 UserDao,调用 selectList 方法即可查询全部数据:
package com.wb;
import com.wb.dao.UserDao;
import com.wb.domain.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class Mybatisplus01QuickstartApplicationTests {
@Autowired
private UserDao userDao;
@Test
void testGetAll() {
List<User> userList = userDao.selectList(null);
System.out.println(userList);
}
}
运行测试,控制台将打印出数据库中的4条用户记录,全程没有写一行SQL。
三、标准CRUD操作
MP已经内置了增删改查的全部方法,我们只需调用即可。
1 ) 新增操作
@Test
void testSave(){
User user = new User();
user.setName("程序员");
user.setPassword("wb");
user.setAge(12);
user.setTel("4006184000");
userDao.insert(user);
}
2 ) 删除操作
@Test
void testDelete(){
userDao.deleteById(1401856123725713409L);
}
3 ) 修改操作
修改操作只更新传入字段,不修改 null 值对应的列。
@Test
void testUpdate(){
User user = new User();
user.setId(1L);
user.setName("Tom888");
user.setPassword("tom888");
userDao.updateById(user);
}
4 ) 查询单个对象
@Test
void testGetById(){
User user = userDao.selectById(2L);
System.out.println(user);
}
5 ) 查询全部
@Test
void testGetAll() {
List<User> userList = userDao.selectList(null);
System.out.println(userList);
}
6 ) Lombok简化实体类
使用@Data注解可以自动生成getter/setter、toString、equals/hashCode等方法。
package com.wb.domain;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private String password;
private Integer age;
private String tel;
}
分页功能
1 )配置分页拦截器
分页功能需要配置 MybatisPlusInterceptor 并添加 PaginationInnerInterceptor 拦截器。
package com.wb.config;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mpInterceptor(){
//1.定义Mp拦截器
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
//2.添加具体的拦截器(分页拦截器)
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return mpInterceptor;
}
}
2 ) 执行分页查询
使用 Page 对象设置页码和每页条数,分页结果封装在 IPage 对象中。
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
@Test
void testGetByPage(){
IPage page = new Page(2,3);
userDao.selectPage(page,null);
System.out.println("当前页码值:" + page.getCurrent());
System.out.println("每页显示数:" + page.getSize());
System.out.println("一共多少页:" + page.getPages());
System.out.println("一共多少条数据:" + page.getTotal());
System.out.println("数据:" + page.getRecords());
}
3 ) 开启MP日志
在application.yml中配置日志输出,方便观察生成的SQL。
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
执行分页查询后,控制台会打印出带 LIMIT 的SQL语句,验证物理分页已经生效。
五、条件查询的三种方式
1 ) 普通 QueryWrapper 方式
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
QueryWrapper qw = new QueryWrapper();
qw.lt("age", 18);
List<User> userList = userDao.selectList(qw);
2 ) LambdaQueryWrapper方式
通过Lambda表达式避免字段名硬编码。
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.lt(User::getAge, 10);
List<User> userList = userDao.selectList(lqw);
3 ) LambdaQueryWrapper链式编程
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.lt(User::getAge, 30).gt(User::getAge, 10);
List<User> userList = userDao.selectList(lqw);
4 ) 多条件组合:AND与OR
AND(并且):直接链式调用即为AND关系。OR(或者):调用.or()方法。
// 查询年龄小于10 或者 大于30的用户
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.lt(User::getAge, 10).or().gt(User::getAge, 30);
List<User> userList = userDao.selectList(lqw);
六、条件查询中的NULL判定
在实际开发中,查询条件可能为 null,MP提供了条件判断的重载方法,第一个参数为 boolean,为true才拼接条件。
传统if写法:
UserQuery uq = new UserQuery();
uq.setAge(10);
uq.setAge2(30);
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
if (null != uq.getAge()) {
lqw.gt(User::getAge, uq.getAge());
}
if (null != uq.getAge2()) {
lqw.lt(User::getAge, uq.getAge2());
}
MP优雅写法:
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.gt(null != uq.getAge(), User::getAge, uq.getAge())
.lt(null != uq.getAge2(), User::getAge, uq.getAge2());
七、查询投影
1 ) 指定查询字段
通过select方法指定需要查询的列。
Lambda格式:
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.select(User::getId, User::getName, User::getAge);
List<User> userList = userDao.selectList(lqw);
普通格式(字符串):
QueryWrapper<User> lqw = new QueryWrapper<>();
lqw.select("id", "name", "age", "tel");
List<User> userList = userDao.selectList(lqw);
2 ) 聚合查询与分组
对于统计查询,可以使用selectMaps返回Map列表。
QueryWrapper<User> lqw = new QueryWrapper<>();
lqw.select("count(*) as count, tel");
lqw.groupBy("tel");
List<Map<String, Object>> userList = userDao.selectMaps(lqw);
System.out.println(userList);
查询条件详解
1 ) 等值查询 eq
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.eq(User::getName, "Jerry").eq(User::getPassword, "jerry");
User loginUser = userDao.selectOne(lqw);
2 ) 范围查询 between/lt/gt
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.between(User::getAge, 10, 30);
List<User> userList = userDao.selectList(lqw);
| 方法 | 说明 | SQL示例 |
|---|---|---|
| eq | 等于 | age = ? |
| ne | 不等于 | age <> ? |
| gt | 大于 | age > ? |
| ge | 大于等于 | age >= ? |
| lt | 小于 | age < ? |
| le | 小于等于 | age <= ? |
| between | 介于 | age between ? and ? |
| notBetween | 不介于 | age not between ? and ? |
3 ) 模糊查询 like
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.likeLeft(User::getName, "J"); // %J
lqw.likeRight(User::getName, "J"); // J%
lqw.like(User::getName, "J"); // %J%
likeLeft:百分号在左边,%JlikeRight:百分号在右边,J%like:两边都有百分号,%J%
4 ) 更多条件参考
MP支持的条件非常丰富,还包括:isNull、isNotNull、in、notIn、groupBy、having、orderBy等,具体可查阅官方条件构造器文档 。
九、映射匹配兼容性
1 ) 表名映射 @TableName
当表名与实体类名不一致时,使用 @TableName 注解指定表名。
@Data
@TableName("tbl_user")
public class User {
// ...
}
2 ) 字段名映射 @TableField
当字段名与数据库列名不一致时,使用 @TableField 注解的 value 属性指定。
@TableField(value = "pwd")
private String password;
3 ) 忽略字段映射
实体类中存在但数据库表中没有的字段,使用@TableField(exist = false)。
@TableField(exist = false)
private Integer online;
4 ) 敏感字段不参与查询
不希望某些字段被查询出来(如密码),设置 select = false
@TableField(value = "pwd", select = false)
private String password;
总结
通过本文的学习,你应该能够使用MyBatis-Plus快速完成数据层的标准开发,包括增删改查、分页、条件查询以及映射兼容处理。
MP极大地简化了持久层代码,让开发者可以更专注于业务逻辑。
9334



被折叠的 条评论
为什么被折叠?



