整合 MyBatis-Plus 高效开发：特性与实战

最新推荐文章于 2025-06-10 17:46:18 发布

YY...yy

最新推荐文章于 2025-06-10 17:46:18 发布

阅读量913

点赞数 27

分类专栏： SpringBoot框架学习文章标签： mybatis java 开发语言

本文链接：https://blog.youkuaiyun.com/2302_76552486/article/details/145521656

版权

SpringBoot框架学习专栏收录该内容

12 篇文章

订阅专栏

引言

一、MyBatis-Plus 简介

1. 什么是 MyBatis-Plus？

2. 为什么选择 MyBatis-Plus？

二、MyBatis-Plus 核心特性详解

三、实战案例：整合 MyBatis-Plus 开发用户管理系统

引言

在现代企业级应用开发中，数据持久化是不可或缺的一部分。MyBatis 作为一款流行的 ORM（对象关系映射）框架，因其灵活性和强大的功能受到广泛欢迎。然而，在实际开发中，手动编写大量的 SQL 语句和 Mapper 接口往往会增加开发成本和维护难度。

为了解决这一问题，MyBatis-Plus 应运而生。它是 MyBatis 的增强工具，旨在通过提供一系列开箱即用的功能（如通用 Mapper、条件构造器、分页插件等），显著提升开发效率和代码质量。本文将详细介绍 MyBatis-Plus 的核心特性，并通过实战案例展示如何高效整合 MyBatis-Plus 进行开发。

一、MyBatis-Plus 简介

1. 什么是 MyBatis-Plus？

MyBatis-Plus 是 MyBatis 的增强工具，专注于简化开发流程和提高生产力。它通过提供以下功能模块，帮助开发者快速构建高效的数据持久化层：

通用 Mapper：自动生成 CRUD 方法。
条件构造器：链式调用构建复杂查询条件。
分页插件：简化分页查询。
性能分析：监控 SQL 执行情况。
乐观锁与悲观锁：支持事务管理。
代码生成器：自动生成实体类、Mapper 接口等。

2. 为什么选择 MyBatis-Plus？

减少重复代码：通过通用 Mapper 和条件构造器，大幅减少手写 SQL 和 Mapper 接口的工作量。
提高开发效率：内置丰富的功能模块，开箱即用。
降低维护成本：统一的 API 设计和简洁的代码风格，便于团队协作和后期维护。
社区活跃：拥有活跃的开源社区和技术支持。

二、MyBatis-Plus 核心特性详解

1. 通用 Mapper

通用 Mapper 是 MyBatis-Plus 最为核心的功能之一。它通过动态代理的方式，自动生成 CRUD 方法，从而避免了手动编写大量重复的 Mapper 接口和实现类。

import com.baomidou.mybatisplus.core.mapper.BaseMapper; 
 
public interface UserMapper extends BaseMapper<User> {
    // 无需手动编写CRUD方法 
}

通过继承 BaseMapper，UserMapper 自动获得了以下 CRUD 方法：

insert(User entity)：插入一条记录。
deleteById(Long id)：根据主键删除记录。
updateById(User entity)：根据主键更新记录。
selectById(Long id)：根据主键查询记录。
selectAll()：查询所有记录。

2. 条件构造器

条件构造器（QueryWrapper 和 UpdateWrapper）是 MyBatis-Plus 提供的另一个强大功能。它允许开发者通过链式调用的方式构建复杂的查询和更新条件。

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; 
import com.baomidou.mybatisplus.core.toolkit.Wrappers; 
 
public class UserService {
 
    @Autowired 
    private UserMapper userMapper;
 
    public List<User> findByUsernameOrEmail(String username, String email) {
        QueryWrapper<User> wrapper = Wrappers.query();  // 创建一个空的QueryWrapper实例 
        wrapper.like("username",  username).or().like("email", email); // 构建模糊查询条件 
        return userMapper.selectList(wrapper);  // 执行查询并返回结果 
    }
}

QueryWrapper：用于构建查询条件。
Wrappers.query() ：创建一个空的 QueryWrapper 实例。
like 和 or：构建模糊查询和逻辑或条件。

3. 分页插件

分页插件是 MyBatis-Plus 提供的一个实用工具，用于简化分页查询的实现。

配置分页插件：

import com.baomidou.mybatisplus.extension.plugins.pagination.Page; 
import org.springframework.stereotype.Service; 
 
@Service 
public class UserService {
 
    @Autowired 
    private UserMapper userMapper;
 
    public IPage<User> findAllUsers(Pageable pageable) {
        Page<User> page = new Page<>(pageable.getPageNumber(),  pageable.getPageSize());  // 创建分页对象 
        QueryWrapper<User> wrapper = Wrappers.query();  // 创建空的QueryWrapper实例 
        return userMapper.selectPage(page,  wrapper); // 执行分页查询并返回结果 
    }
}

Page：分页对象，包含当前页码、每页大小和总记录数等信息。
selectPage：执行分页查询。

4. 性能分析

性能分析插件可以帮助开发者监控 SQL 执行情况，优化数据库操作。

启用性能分析插件：

import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor; 
import org.springframework.context.annotation.Bean; 
import org.springframework.context.annotation.Configuration; 
 
@Configuration 
public class MybatisPlusConfig {
 
    @Bean 
    public PerformanceInterceptor performanceInterceptor() {
        return new PerformanceInterceptor(); // 创建性能分析插件实例 
    }
}

启用后，控制台会输出 SQL 执行时间、执行次数等信息，便于开发者进行性能优化。

三、实战案例：整合 MyBatis-Plus 开发用户管理系统

1. 创建项目

首先，我们需要创建一个 Spring Boot 项目，并添加 MyBatis-Plus 相关依赖。

pom.xml 配置：

<dependencies>
    <!-- Spring Boot 核心依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId> 
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
 
    <!-- MyBatis-Plus 依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId> 
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.3</version>
    </dependency>
 
    <!-- 数据库驱动 -->
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
 
    <!-- 其他依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId> 
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 配置文件

在 application.properties 文件中配置数据库和 MyBatis-Plus 相关参数：

# 数据库配置 
spring.datasource.url=jdbc:h2:mem:mydb  
spring.datasource.driverClassName=org.h2.Driver  
spring.datasource.username=sa  
spring.datasource.password= 
 
# MyBatis-Plus 配置 
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl  
mybatis-plus.global-config.db-config.id-type=auto

3. 实体类

定义 User 实体类，并使用 JPA 注解进行字段映射：

import jakarta.persistence.*; 
 
@Entity 
@Table(name = "users")
public class User {
 
    @Id 
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
 
    @Column(name = "username", length = 50, nullable = false)
    private String username;
 
    @Column(name = "email", unique = true)
    private String email;
 
    // Getter and Setter methods 
}

4. Mapper 接口

定义 UserMapper 接口，并继承 BaseMapper：

import com.baomidou.mybatisplus.core.mapper.BaseMapper; 
 
public interface UserMapper extends BaseMapper<User> {
}

5. Service 层

在 Service 层中使用条件构造器和分页插件：

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; 
import com.baomidou.mybatisplus.core.toolkit.Wrappers; 
import com.baomidou.mybatisplus.extension.plugins.pagination.Page; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.stereotype.Service; 
 
import java.util.List; 
 
@Service 
public class UserService {
 
    @Autowired 
    private UserMapper userMapper;
 
    public List<User> findByUsernameOrEmail(String username, String email) {
        QueryWrapper<User> wrapper = Wrappers.query();  // 创建空的QueryWrapper实例 
        wrapper.like("username",  username).or().like("email", email); // 构建模糊查询条件 
        return userMapper.selectList(wrapper);  // 执行查询并返回结果 
    }
 
    public IPage<User> findAllUsers(Pageable pageable) {
        Page<User> page = new Page<>(pageable.getPageNumber(),  pageable.getPageSize());  // 创建分页对象 
        QueryWrapper<User> wrapper = Wrappers.query();  // 创建空的QueryWrapper实例 
        return userMapper.selectPage(page,  wrapper); // 执行分页查询并返回结果 
    }
}

6. Controller 层

在 Controller 层中暴露 RESTful API：

import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.data.domain.Pageable; 
import org.springframework.web.bind.annotation.*; 
 
@RestController 
@RequestMapping("/api/users")
public class UserController {
 
    @Autowired 
    private UserService userService;
 
    @GetMapping 
    public List<User> getAllUsers() {
        return userService.findByUsernameOrEmail(null,  null); // 调用Service层方法获取所有用户 
    }
 
    @GetMapping("/page")
    public IPage<User> getUsersByPage(Pageable pageable) {
        return userService.findAllUsers(pageable);  // 调用Service层方法获取分页用户数据 
    }
 
    @PostMapping 
    public User createUser(@RequestBody User user) {
        return userService.createUser(user);  // 调用Service层方法创建新用户 
    }
}