当前位置：首页 > news >正文

MybatisPlus-插件篇

news 2025/7/5 13:38:05

文章目录

一、前言
二、插件
- 1、分页插件
- - 2.1.1、引入依赖
  - 2.1.1、配置分页插件
  - 2.1.3、使用分页方法
- 2、乐观锁插件
- - 2.1、引入依赖
  - 2.2、添加版本字段
  - 2.3、配置乐观锁插件
  - 2.4、执行更新操作
三、总结

一、前言

本文将详细介绍mybatisplus中常用插件的使用。

二、插件

1、分页插件

分页查询在实际应用中非常常见，它允许我们从数据库中检索大量数据时，将结果分成若干页显示，以提高用户体验并减轻数据库负担。Mybatis-Plus的分页插件就是为了解决这个问题而设计的，它能够让我们以更简单的方式进行分页查询。
官方对Page类的说明：
在这里插入图片描述

以下是Mybatis-Plus分页插件的详细介绍：

2.1.1、引入依赖

引入依赖： 首先，你需要在项目中引入Mybatis-Plus的相关依赖，包括核心依赖以及分页插件的依赖。

<!-- Mybatis-Plus 依赖 -->
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>最新版本</version>
</dependency>

2.1.1、配置分页插件

配置分页插件： 在Mybatis-Plus的配置文件中，需要配置分页插件。一般来说，你需要创建一个PaginationInterceptor的实例，并将其添加到Mybatis的插件列表中。这个插件会在执行数据库查询时自动处理分页逻辑。

mybatis-plus:configuration:# 配置数据库字段下划线转驼峰命名规则map-underscore-to-camel-case: true# 分页插件配置plugin:pagination:dialect: mysql # 指定数据库方言，支持的数据库有很多，这里以 MySQL 为例

2.1.3、使用分页方法

使用分页方法： Mybatis-Plus提供了一些内置的分页方法，可以直接在Mapper接口中使用。这些方法包括：
- selectPage(Page<T> page, Wrapper<T> queryWrapper): 根据查询条件进行分页查询，并将结果封装到Page对象中。
- selectMapsPage(Page<T> page, Wrapper<T> queryWrapper): 类似于上述方法，但返回的是一个分页的Map列表，每个Map代表一行记录。
分页参数： 分页查询需要指定当前页数和每页显示的记录数。Mybatis-Plus的分页方法中，通常会传入一个Page对象，你可以在该对象中设置这些参数。
分页结果： 分页查询的结果会被封装到Page对象中，该对象除了包含查询结果的列表外，还包含了分页相关的元数据，如总记录数、总页数、当前页码等。

总体而言，Mybatis-Plus的分页插件使得分页查询变得更加方便和简单。你不再需要手动编写分页查询的SQL语句，只需要调用相应的分页方法，传入分页参数和查询条件即可。

以下是一个使用Mybatis-Plus分页插件的简单示例：

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import org.springframework.beans.factory.annotation.Autowired;public class UserService {@Autowiredprivate UserMapper userMapper;public Page<User> getUserListByPage(int pageNum, int pageSize) {Page<User> page = new Page<>(pageNum, pageSize);QueryWrapper<User> queryWrapper = new QueryWrapper<>();// 设置查询条件...return userMapper.selectPage(page, queryWrapper);}
}

在这个示例中，UserMapper是一个继承了Mybatis-Plus的BaseMapper接口的接口，它继承了一些基本的查询方法，包括分页方法。

需要注意的是，Mybatis-Plus的版本可能会有更新，因此具体的用法可能会有所变化。建议查阅官方文档或者示例代码以获取最新的用法信息。

2、乐观锁插件

乐观锁是一种用于处理数据库并发访问的策略，它不会锁住整个数据行，而是在更新时检查数据版本，如果版本号匹配，则允许更新操作；如果版本号不匹配，则说明数据已经被其他事务修改，更新操作将被拒绝。

2.1、引入依赖

引入依赖： 在项目的 pom.xml 文件中，添加 Mybatis-Plus 的依赖（如果尚未添加）。

<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>最新版本</version>
</dependency>

2.2、添加版本字段

实体类添加版本字段： 在需要应用乐观锁的实体类中，添加一个版本号字段，并使用 @Version 注解标记。

import com.baomidou.mybatisplus.annotation.Version;
import com.baomidou.mybatisplus.annotation.TableName;@TableName("user")
public class User {private Long id;private String name;// 其他字段...@Versionprivate Integer version; // 乐观锁版本号字段// getter 和 setter 方法...
}

2.3、配置乐观锁插件

配置乐观锁插件： 在 Spring Boot 的配置文件中，添加乐观锁插件的配置。

在 application.yml 文件中：

mybatis-plus:configuration:# 配置数据库字段下划线转驼峰命名规则map-underscore-to-camel-case: trueglobal-config:db-config:# 配置乐观锁插件logic-not-delete-value: 0 # 逻辑未删除值logic-delete-value: 1     # 逻辑已删除值

2.4、执行更新操作

执行更新操作： 在需要进行更新操作的地方，调用 Mybatis-Plus 提供的更新方法即可。

import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
public class UserService {@Autowiredprivate UserMapper userMapper;public boolean updateUser(User user) {UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();updateWrapper.eq("id", user.getId());// 设置其他更新条件...return userMapper.update(user, updateWrapper) > 0;}
}

在这个例子中，当执行更新操作时，Mybatis-Plus 会自动根据实体对象的版本号字段进行版本检查。如果版本号匹配，则更新数据并将版本号加一；如果版本号不匹配，更新操作将失败。

乐观锁插件使得并发更新操作更加安全，避免了数据的覆盖和错误。通过添加版本号字段以及乐观锁插件的配置，你可以轻松地在 Spring Boot 项目中应用乐观锁。

三、总结

Mybatis-Plus 插件提供了很多便捷的方法和功能，能够大幅简化 MyBatis 的开发，减少重复劳动。通过配置依赖、实体类、Mapper 接口以及相应的插件，可以在 Spring Boot 项目中高效地进行数据库操作。