MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具库,在 MyBatis 的基础上进行了扩展,提供了大量简化开发的特性,以下是通俗讲解和代码示例:
核心特点
- 无侵入:只做增强不做改变,不会影响现有 MyBatis 功能。
- CRUD 自动化:内置通用 Mapper 和 Service,无需编写基础 SQL。
- 强大的条件构造器:通过链式 API 生成复杂查询条件。
- 代码生成器:一键生成 Entity、Mapper、Service、Controller。
- 插件扩展:分页、乐观锁、逻辑删除等开箱即用。
快速使用(Spring Boot 示例)
1. 添加依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
2. 配置数据源(application.yml)
spring:
datasource:
url: jdbc:mysql://localhost:3306/test?useSSL=false
username: root
password: root
driver-class-name: com.mysql.cj.jdbc.Driver
3. 创建实体类
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
@TableName("user") // 指定表名(默认类名小写)
public class User {
@TableId(type = IdType.AUTO) // 自增主键
private Long id;
private String name;
private Integer age;
private String email;
// getter/setter 省略(可用Lombok)
}
4. 创建 Mapper 接口
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
public interface UserMapper extends BaseMapper<User> {
// 无需写 XML,BaseMapper 已包含基础 CRUD 方法
}
5. 启用 Mapper 扫描
@SpringBootApplication
@MapperScan("com.example.mapper") // 扫描 Mapper 接口
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
核心功能代码示例
1. 基础 CRUD
@Autowired
private UserMapper userMapper;
// 插入
User user = new User();
user.setName("Alice");
user.setAge(25);
userMapper.insert(user); // 返回影响行数
// 查询
User result = userMapper.selectById(1L); // 按 ID 查询
// 更新
user.setAge(30);
userMapper.updateById(user); // 根据 ID 更新
// 删除
userMapper.deleteById(1L);
2. 条件构造器(QueryWrapper)
// 查询年龄 > 20 且名字包含 "Tom" 的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.gt("age", 20) // 字段名、值
.like("name", "Tom");
List<User> list = userMapper.selectList(wrapper);
// Lambda 写法(避免字段名硬编码)
LambdaQueryWrapper<User> lambdaWrapper = new LambdaQueryWrapper<>();
lambdaWrapper.gt(User::getAge, 20)
.like(User::getName, "Tom");
List<User> list2 = userMapper.selectList(lambdaWrapper);
3. 分页查询
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); // 分页插件
return interceptor;
}
}
// 使用分页(页码从 1 开始)
Page<User> page = new Page<>(1, 10); // 当前页、每页大小
Page<User> result = userMapper.selectPage(page, null); // 第二个参数是条件
List<User> users = result.getRecords(); // 当前页数据
long totalPages = result.getPages(); // 总页数
4. 逻辑删除
mybatis-plus:
global-config:
db-config:
logic-delete-field: deleted # 实体类中标记删除的字段(int/boolean)
logic-delete-value: 1 # 删除状态值
logic-not-delete-value: 0 # 未删除状态值
实体类添加字段:
private Integer deleted; // 0 未删除,1 已删除
删除操作自动转为 UPDATE user SET deleted=1 WHERE id=?
。
代码生成器(简化开发)
FastAutoGenerator.create("jdbc:mysql://localhost:3306/test", "root", "root")
.globalConfig(builder -> {
builder.author("YourName") // 作者
.outputDir("src/main/java"); // 输出路径
})
.packageConfig(builder -> {
builder.parent("com.example"); // 包名
})
.strategyConfig(builder -> {
builder.addInclude("user", "product") // 生成哪些表
.entityBuilder() // 实体类配置
.enableLombok(); // 支持 Lombok
})
.execute();
运行后自动生成 Entity、Mapper、Service、Controller 层代码。
总结
- 核心价值:通过内置 CRUD 和条件构造器,减少 80% 重复代码。
- 适用场景:单表操作、快速开发(复杂 SQL 仍可手写 XML)。
- 学习建议:掌握
BaseMapper
、QueryWrapper
、LambdaQueryWrapper
和分页插件即可满足大部分需求。
📌 提示:避免过度依赖自动生成 SQL,复杂关联查询建议手写 XML 以保证可读性。