MyBatis Plus学习：初学者快速入门指南

本文提供了MyBatis Plus学习的快速入门指南，介绍了MyBatis Plus相对于MyBatis的多项增强功能，包括简化CRUD操作、逻辑删除和分页插件等。文章还详细讲解了MyBatis Plus的安装配置、基本的数据操作和高级查询功能。通过本文，读者可以快速掌握MyBatis Plus的核心特性和使用方法。

MyBatis Plus的基本概念

MyBatis Plus 是一个 MyBatis 的增强工具，旨在简化 MyBatis 的操作。它通过提供一系列扩展功能和简化代码来提高开发效率，使得开发者可以专注于业务逻辑，而不是底层的数据库操作。

MyBatis Plus相对于MyBatis的优势

1. 简化CRUD操作：
   • MyBatis Plus 提供了丰富的 CRUD 操作方法，例如 save、updateById、deleteById 等，大大简化了开发流程。
2. 自动填充：
   • MyBatis Plus 支持自动填充字段功能，可以在插入或更新记录时自动填充某些字段，例如插入时间、更新时间等。
3. 逻辑删除：
   • 支持逻辑删除功能，可以设置一个字段来标记删除状态，而不是物理删除记录。
4. 乐观锁：
   • 提供了乐观锁的支持，可以在更新记录时自动检查版本号，防止多线程环境下的并发问题。
5. 分页插件：
   • 内置了分页插件，可以方便地实现分页查询功能。
6. 代码生成器：
   • 提供了代码生成器工具，可以自动生成实体类、Mapper 接口等代码。

MyBatis Plus的安装与配置

要使用 MyBatis Plus，首先需要在项目中引入依赖。对于 Maven 项目，可以在 pom.xml 文件中添加如下依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3</version>
</dependency>

对于 Gradle 项目，可以在 build.gradle 文件中添加如下依赖：

implementation 'com.baomidou:mybatis-plus-boot-starter:3.4.3'

接下来，在 Spring Boot 项目中，配置 application.yml 文件中的数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatisplus
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
mybatis-plus:
    # 设置数据库类型
    type-enu: MYSQL

配置完成后，可以在启动类中添加 MyBatis Plus 的配置：

import com.baomidou.mybatisplus.annotation.DbType;
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(DbType.MYSQL));
        return interceptor;
    }
}

实体类定义

实体类用于表示数据库中的表，每个实体类对应一个数据库表，包含一些基本的字段和方法。

以下是一个简单的用户实体类示例：

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

@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;

    // Getter and Setter methods
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

数据库表映射

MyBatis Plus 通过 @TableName 注解来映射实体类对应的数据库表，@TableId 注解用于标识主键字段。此外，还可以使用其他注解来映射其他字段。

基本的CRUD操作

MyBatis Plus 提供了丰富的 CRUD 操作方法，以下是一些常见操作的示例：

插入数据

User user = new User();
user.setName("张三");
user.setAge(25);

userMapper.insert(user);

查询数据

User user = userMapper.selectById(1L);

更新数据

User user = new User();
user.setId(1L);
user.setName("李四");
user.setAge(30);

userMapper.updateById(user);

删除数据

userMapper.deleteById(1L);

条件构造器的使用

MyBatis Plus 提供了条件构造器 QueryWrapper，可以方便地构造复杂的查询条件。

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("age", 25);
List<User> users = userMapper.selectList(queryWrapper);

自定义SQL查询

对于复杂的查询需求，可以使用 @Select 注解来自定义 SQL 语句。

@Select("SELECT * FROM user WHERE name = #{name}")
List<User> selectByName(@Param("name") String name);

动态SQL支持

MyBatis Plus 支持动态 SQL，可以通过条件构造器来动态构建 SQL 语句。

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("age", 25).or().eq("name", "张三");
List<User> users = userMapper.selectList(queryWrapper);

事务的基本概念

事务是一组操作的集合，要么全部成功，要么全部失败。事务具有原子性、一致性、隔离性和持久性（ACID）的特性。

MyBatis Plus的事务管理

MyBatis Plus 使用 Spring 的事务管理功能来管理事务。以下是一个简单的事务管理示例：

开启事务

@Transactional
public void saveUserAndRole(User user, Role role) {
    userMapper.insert(user);
    roleMapper.insert(role);
}

事务的回滚与提交

在上述示例中，如果 userMapper.insert(user) 或 roleMapper.insert(role) 任何一条 SQL 语句执行失败，整个事务将会回滚，如果所有 SQL 语句都成功执行，则事务将自动提交。

实际应用示例

假设有一个需求是同时插入用户和角色信息，保证两者信息的完整性。通过事务管理可以确保这两条插入操作要么都成功，要么都失败。

@Transactional
public void createUserWithRole(User user, Role role) {
    userMapper.insert(user);
    roleMapper.insert(role);
}

分页查询的实现

MyBatis Plus 提供了内置的分页插件来实现分页查询。

Page<User> page = new Page<>(1, 10);
IPage<User> result = userMapper.selectPage(page, new QueryWrapper<>());
List<User> users = result.getRecords();
long total = result.getTotal();

排序规则的应用

可以通过条件构造器来设置排序规则。

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.orderByAsc("age").orderByDesc("name");
List<User> users = userMapper.selectList(queryWrapper);

分页与排序的结合使用

可以将分页和排序结合使用，实现复杂的查询需求。

Page<User> page = new Page<>(1, 10);
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.orderByAsc("age").orderByDesc("name");
IPage<User> result = userMapper.selectPage(page, queryWrapper);
List<User> users = result.getRecords();

插件的使用

MyBatis Plus 提供了插件机制来扩展功能。例如，可以使用分页插件、乐观锁插件等。

分页插件

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

乐观锁插件

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

扩展功能的开发

可以通过实现 MetaObjectHandler 接口来自定义对象处理逻辑。

public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        metaObject.setValue("gmtCreate", new Date());
        metaObject.setValue("gmtModified", new Date());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        metaObject.setValue("gmtModified", new Date());
    }
}

常见问题与解决

1. 插入数据时自动填充字段：
   • 可以通过实现 MetaObjectHandler 接口来自定义插入和更新时的字段填充逻辑。
2. 查询时字段映射问题：
   • 确保实体类字段与数据库表字段一一对应，并使用合适的注解进行映射。
3. 事务管理问题：
   • 确保在需要事务支持的方法上使用 @Transactional 注解，并正确配置事务管理器。

通过以上步骤，您可以快速上手 MyBatis Plus，并充分利用其强大功能来提高开发效率。更多详细内容可以参考 MyBatis Plus 的官方文档。