mybatis-plus框架的使用

MyBatis-Plus 是一个基于 MyBatis 的增强工具，它提供了很多增强功能，简化了 MyBatis 的使用，支持常用的 CRUD 操作、分页查询、性能分析、自动填充等。以下是 MyBatis-Plus 的使用详解，包括配置、基本操作和一些高级功能。

1. 引入依赖

首先，在 Maven 项目中添加 MyBatis-Plus 的依赖。以下是 pom.xml 的示例：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version> <!-- 请根据需要选择版本 -->
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.25</version> <!-- 请根据需要选择版本 -->
</dependency>

如果使用 Gradle，可以在 build.gradle 中添加：

implementation 'com.baomidou:mybatis-plus-boot-starter:3.5.1'
implementation 'mysql:mysql-connector-java:8.0.25'

2. 配置 MyBatis-Plus

2.1 数据源配置

在 application.yml 或 application.properties 文件中配置数据源和 MyBatis-Plus 的相关属性。
application.yml 示例：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb?useSSL=false&serverTimezone=UTC
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis-plus:
    mapper-locations: classpath*:/mapper/**/*Mapper.xml

2.2 启动类配置

在 Spring Boot 的启动类上添加 @MapperScan 注解，指定 Mapper 接口的位置。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.mybatis.spring.annotation.MapperScan;
@SpringBootApplication
@MapperScan("com.example.mapper") // 指定 Mapper 接口的包路径
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

3. 实体类和 Mapper 接口

3.1 创建实体类

创建一个实体类，并使用 MyBatis-Plus 提供的注解。

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
@Data
@TableName("user") // 指定表名
public class User {
    @TableId // 主键
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

3.2 创建 Mapper 接口

创建一个 Mapper 接口，继承 BaseMapper 接口，MyBatis-Plus 将为你提供基本的 CRUD 方法。

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface UserMapper extends BaseMapper<User> {
    // 可在此添加自定义的方法
}

4. 基本操作

4.1 插入数据

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
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 = new User();
        user.setName("John Doe");
        user.setAge(30);
        user.setEmail("john.doe@example.com");
        userMapper.insert(user); // 插入数据
    }
}

4.2 查询数据

4.2.1 查询所有

public List<User> getAllUsers() {
    return userMapper.selectList(null); // 查询所有用户
}

4.2.2 根据条件查询

public User getUserById(Long id) {
    return userMapper.selectById(id); // 根据 ID 查询用户
}

4.2.3 使用 QueryWrapper

public List<User> getUsersByAge(Integer age) {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("age", age); // 条件：年龄
    return userMapper.selectList(queryWrapper);
}

4.3 更新数据

public void updateUser(User user) {
    userMapper.updateById(user); // 根据 ID 更新用户
}

4.4 删除数据

public void deleteUser(Long id) {
    userMapper.deleteById(id); // 根据 ID 删除用户
}

5. 分页查询

MyBatis-Plus 提供了分页功能，可以通过 Page 类进行分页查询。

5.1 引入分页依赖

在 pom.xml 中引入分页插件依赖（如果使用 Spring Boot Starter，则无需单独添加）。

5.2 使用分页

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
public Page<User> getUsersPage(int pageNum, int pageSize) {
    Page<User> page = new Page<>(pageNum, pageSize);
    return userMapper.selectPage(page, null); // 查询分页数据
}

6. 其他功能

6.1 逻辑删除

MyBatis-Plus 支持逻辑删除，可以通过在实体类中使用 @TableLogic 注解来实现。

import com.baomidou.mybatisplus.annotation.TableLogic;
@Data
@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableLogic // 逻辑删除字段
    private Integer deleted; // 0 表示未删除，1 表示已删除
}

6.2 自动填充

MyBatis-Plus 支持自动填充，可以通过实现 MetaObjectHandler 接口来实现。

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", LocalDateTime.now(), metaObject); // 填充创建时间
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject); // 填充更新时间
    }
}

6.3 性能分析

MyBatis-Plus 提供了性能分析插件，可以在 application.yml 中进行配置。

mybatis-plus:
  global-config:
    db-config:
      performance-analysis: true # 启用性能分析

7. 总结

MyBatis-Plus 是一个强大且易于使用的 ORM 框架，提供了丰富的功能来简化数据库操作。通过以上的使用详解，你可以快速上手 MyBatis-Plus，进行基本的 CRUD 操作、分页查询、逻辑删除、自动填充等操作。在实际开发中，结合 MyBatis-Plus 的强大功能，可以大大提高开发效率。