MyBatis-Plus 使用指南

前言

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具包，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。它提供了许多便捷的功能，如代码生成器、分页插件、性能分析插件等。本文将通过实例详细介绍如何在项目中集成和使用 MyBatis-Plus。

一、环境搭建

1. 添加依赖

首先，在您的 Maven 或 Gradle 项目中添加 MyBatis-Plus 的依赖。这里以 Maven 为例：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.2</version> <!-- 请根据实际情况选择最新版本 -->
</dependency>

2. 配置数据库连接

在 application.yml 或 application.properties 中配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: your_username
    password: your_password
    driver-class-name: com.mysql.cj.jdbc.Driver

3. 创建实体类

假设我们有一个用户表 user，创建对应的实体类 User：

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

@TableName("user")
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;

    // Getters and Setters
}

4. 创建 Mapper 接口

创建一个继承自 BaseMapper 的接口 UserMapper：

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

public interface UserMapper extends BaseMapper<User> {
}

5. 配置 Mapper 扫描

在 Spring Boot 的主配置类或 @Configuration 类中添加 Mapper 扫描配置：

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan("com.example.demo.mapper") // 替换为你的 Mapper 接口所在的包路径
public class MyBatisPlusConfig {
}

二、基本 CRUD 操作

1. 插入数据

import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public void addUser(User user) {
        userMapper.insert(user);
    }
}

2. 查询数据

public User getUserById(Long id) {
    return userMapper.selectById(id);
}

public List<User> getAllUsers() {
    return userMapper.selectList(null);
}

3. 更新数据

public void updateUser(User user) {
    userMapper.updateById(user);
}

4. 删除数据

public void deleteUserById(Long id) {
    userMapper.deleteById(id);
}

三、高级功能

1. 分页查询

首先需要引入分页插件，并在配置类中进行配置：

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 MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    }
}

然后在服务层实现分页查询：

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;

public IPage<User> getUsersByPage(int currentPage, int pageSize) {
    Page<User> page = new Page<>(currentPage, pageSize);
    return userMapper.selectPage(page, null);
}

2. 条件构造器

MyBatis-Plus 提供了强大的条件构造器 QueryWrapper 和 UpdateWrapper，可以方便地构建复杂的查询条件和更新条件。

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;

public List<User> getUsersByNameAndAge(String name, Integer age) {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("name", name).eq("age", age);
    return userMapper.selectList(queryWrapper);
}

3. 代码生成器

MyBatis-Plus 还提供了一个强大的代码生成器，可以快速生成 Entity、Mapper、Service 等基础代码。可以通过以下方式启动代码生成器：

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;

public class CodeGenerator {
    public static void main(String[] args) {
        FastAutoGenerator.create(
                "jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai",
                "your_username",
                "your_password"
        ).globalConfig(builder -> {
            builder.author("Your Name") // 设置作者
                    .outputDir(System.getProperty("user.dir") + "/src/main/java"); // 设置输出目录
        }).packageConfig(builder -> {
            builder.parent("com.example.demo") // 设置父包名
                    .moduleName("generator"); // 设置模块名
        }).strategyConfig(builder -> {
            builder.addInclude("user") // 设置需要生成的表名
                    .entityBuilder().enableLombok(); // 开启 Lombok
        }).execute();
    }
}