MybatisPlus——插件功能

最新推荐文章于 2024-08-15 21:48:30 发布
最新推荐文章于 2024-08-15 21:48:30 发布
阅读量457 收藏 9
点赞数 10
分类专栏： MybatisPlus 文章标签： java 开发语言 mybatis MybatisPlus
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_74197695/article/details/141107942
版权

插件功能

MybatisPlus提供了很多的插件功能，进一步拓展其功能。目前已有的插件有：

  • PaginationInnerInterceptor：自动分页

  • TenantLineInnerInterceptor：多租户

  • DynamicTableNameInnerInterceptor：动态表名

  • OptimisticLockerInnerInterceptor：乐观锁

  • IllegalSQLInnerInterceptor：sql 性能规范

  • BlockAttackInnerInterceptor：防止全表更新与删除

注意： 使用多个分页插件的时候需要注意插件定义顺序，建议使用顺序如下：

  • 多租户,动态表名

  • 分页,乐观锁

  • sql 性能规范,防止全表更新与删除

1.分页插件

        在未引入分页插件的情况下，MybatisPlus是不支持分页功能的，IService和BaseMapper中的分页方法都无法正常起效。 所以，我们必须配置分页插件。

1.1.配置分页插件

在项目中新建一个配置类，其代码如下：

package com.itheima.mp.config;

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

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        // 初始化核心插件
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

1.2.分页API

编写一个分页查询的测试：

@Test
void testPageQuery() {
    // 1.分页查询，new Page()的两个参数分别是：页码、每页大小
    Page<User> p = userService.page(new Page<>(2, 2));
    // 2.总条数
    System.out.println("total = " + p.getTotal());
    // 3.总页数
    System.out.println("pages = " + p.getPages());
    // 4.数据
    List<User> records = p.getRecords();
    records.forEach(System.out::println);
}

运行的SQL如下：

这里用到了分页参数，Page，即可以支持分页参数，也可以支持排序参数。常见的API如下：

int pageNo = 1, pageSize = 5;
// 分页参数
Page<User> page = Page.of(pageNo, pageSize);
// 排序参数, 通过OrderItem来指定
page.addOrder(new OrderItem("balance", false));
page.addOrder(new OrderItem("id", false));
userService.page(page);

2.通用分页实体

简单分页查询案例：

实现一个用户分页查询的接口，接口规范如下：

这里定义3个实体：

  • UserQuery：分页查询条件的实体，包含分页、排序参数、过滤条件

  • PageDTO：分页结果实体，包含总条数、总页数、当前页数据

  • UserVO：用户页面视图实体

2.1.实体

由于UserQuery之前已经定义过了，并且其中已经包含了过滤条件，具体代码如下：

package com.itheima.mp.domain.query;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
@ApiModel(description = "用户查询条件实体")
public class UserQuery {
    @ApiModelProperty("用户名关键字")
    private String name;
    @ApiModelProperty("用户状态：1-正常，2-冻结")
    private Integer status;
    @ApiModelProperty("余额最小值")
    private Integer minBalance;
    @ApiModelProperty("余额最大值")
    private Integer maxBalance;
}

        其中缺少的仅仅是分页条件，而分页条件不仅仅用户分页查询需要，以后其它业务也都有分页查询的需求。因此建议将分页查询条件单独定义为一个PageQuery实体：

PageQuery是前端提交的查询参数，一般包含四个属性：

  • pageNo：页码

  • pageSize：每页数据条数

  • sortBy：排序字段

  • isAsc：是否升序

@Data
@ApiModel(description = "分页查询实体")
public class PageQuery {
    @ApiModelProperty("页码")
    private Long pageNo;
    @ApiModelProperty("页码")
    private Long pageSize;
    @ApiModelProperty("排序字段")
    private String sortBy;
    @ApiModelProperty("是否升序")
    private Boolean isAsc;
}

然后，让我们的UserQuery继承这个实体：

package com.itheima.mp.domain.query;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;

@EqualsAndHashCode(callSuper = true)
@Data
@ApiModel(description = "用户查询条件实体")
public class UserQuery extends PageQuery {
    @ApiModelProperty("用户名关键字")
    private String name;
    @ApiModelProperty("用户状态：1-正常，2-冻结")
    private Integer status;
    @ApiModelProperty("余额最小值")
    private Integer minBalance;
    @ApiModelProperty("余额最大值")
    private Integer maxBalance;
}

最后，则是分页实体PageDTO代码如下：

package com.itheima.mp.domain.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.util.List;

@Data
@ApiModel(description = "分页结果")
public class PageDTO<T> {
    @ApiModelProperty("总条数")
    private Long total;
    @ApiModelProperty("总页数")
    private Long pages;
    @ApiModelProperty("集合")
    private List<T> list;
}

2.2.开发接口

我们在UserController中定义分页查询用户的接口：

package com.itheima.mp.controller;

import com.itheima.mp.domain.dto.PageDTO;
import com.itheima.mp.domain.query.PageQuery;
import com.itheima.mp.domain.vo.UserVO;
import com.itheima.mp.service.UserService;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("users")
@RequiredArgsConstructor
public class UserController {

    private final UserService userService;

    @GetMapping("/page")
    public PageDTO<UserVO> queryUsersPage(UserQuery query){
        return userService.queryUsersPage(query);
    }

    // 。。。 略
}

然后在IUserService中创建queryUsersPage方法：

PageDTO<UserVO> queryUsersPage(PageQuery query);

接下来，在UserServiceImpl中实现该方法：

@Override
public PageDTO<UserVO> queryUsersPage(PageQuery query) {
    // 1.构建条件
    // 1.1.分页条件
    Page<User> page = Page.of(query.getPageNo(), query.getPageSize());
    // 1.2.排序条件
    if (query.getSortBy() != null) {
        page.addOrder(new OrderItem(query.getSortBy(), query.getIsAsc()));
    }else{
        // 默认按照更新时间排序
        page.addOrder(new OrderItem("update_time", false));
    }
    // 2.查询
    page(page);
    // 3.数据非空校验
    List<User> records = page.getRecords();
    if (records == null || records.size() <= 0) {
        // 无数据，返回空结果
        return new PageDTO<>(page.getTotal(), page.getPages(), Collections.emptyList());
    }
    // 4.有数据，转换
    List<UserVO> list = BeanUtil.copyToList(records, UserVO.class);
    // 5.封装返回
    return new PageDTO<UserVO>(page.getTotal(), page.getPages(), list);
}

2.3.改造PageQuery实体

        在刚才的代码中，从PageQuery到MybatisPlus的Page之间转换的过程还是比较麻烦的。

我们完全可以在PageQuery这个实体中定义一个工具方法，简化开发。 像这样：

package com.itheima.mp.domain.query;

import com.baomidou.mybatisplus.core.metadata.OrderItem;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import lombok.Data;

@Data
public class PageQuery {
    private Integer pageNo;
    private Integer pageSize;
    private String sortBy;
    private Boolean isAsc;

    public <T>  Page<T> toMpPage(OrderItem ... orders){
        // 1.分页条件
        Page<T> p = Page.of(pageNo, pageSize);
        // 2.排序条件
        // 2.1.先看前端有没有传排序字段
        if (sortBy != null) {
            p.addOrder(new OrderItem(sortBy, isAsc));
            return p;
        }
        // 2.2.再看有没有手动指定排序字段
        if(orders != null){
            p.addOrder(orders);
        }
        return p;
    }

    public <T> Page<T> toMpPage(String defaultSortBy, boolean isAsc){
        return this.toMpPage(new OrderItem(defaultSortBy, isAsc));
    }

    public <T> Page<T> toMpPageDefaultSortByCreateTimeDesc() {
        return toMpPage("create_time", false);
    }

    public <T> Page<T> toMpPageDefaultSortByUpdateTimeDesc() {
        return toMpPage("update_time", false);
    }
}

这样我们在开发也时就可以省去对从PageQuery到Page的的转换：

// 1.构建条件
Page<User> page = query.toMpPageDefaultSortByCreateTimeDesc();

2.4.改造PageDTO实体

        在查询出分页结果后，数据的非空校验，数据的vo转换都是模板代码，编写起来很麻烦。

我们完全可以将其封装到PageDTO的工具方法中，简化整个过程：

package com.itheima.mp.domain.dto;

import cn.hutool.core.bean.BeanUtil;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Collections;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Collectors;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class PageDTO<V> {
    private Long total;
    private Long pages;
    private List<V> list;

    /**
     * 返回空分页结果
     * @param p MybatisPlus的分页结果
     * @param <V> 目标VO类型
     * @param <P> 原始PO类型
     * @return VO的分页对象
     */
    public static <V, P> PageDTO<V> empty(Page<P> p){
        return new PageDTO<>(p.getTotal(), p.getPages(), Collections.emptyList());
    }

    /**
     * 将MybatisPlus分页结果转为 VO分页结果
     * @param p MybatisPlus的分页结果
     * @param voClass 目标VO类型的字节码
     * @param <V> 目标VO类型
     * @param <P> 原始PO类型
     * @return VO的分页对象
     */
    public static <V, P> PageDTO<V> of(Page<P> p, Class<V> voClass) {
        // 1.非空校验
        List<P> records = p.getRecords();
        if (records == null || records.size() <= 0) {
            // 无数据，返回空结果
            return empty(p);
        }
        // 2.数据转换
        List<V> vos = BeanUtil.copyToList(records, voClass);
        // 3.封装返回
        return new PageDTO<>(p.getTotal(), p.getPages(), vos);
    }

    /**
     * 将MybatisPlus分页结果转为 VO分页结果，允许用户自定义PO到VO的转换方式
     * @param p MybatisPlus的分页结果
     * @param convertor PO到VO的转换函数
     * @param <V> 目标VO类型
     * @param <P> 原始PO类型
     * @return VO的分页对象
     */
    public static <V, P> PageDTO<V> of(Page<P> p, Function<P, V> convertor) {
        // 1.非空校验
        List<P> records = p.getRecords();
        if (records == null || records.size() <= 0) {
            // 无数据，返回空结果
            return empty(p);
        }
        // 2.数据转换
        List<V> vos = records.stream().map(convertor).collect(Collectors.toList());
        // 3.封装返回
        return new PageDTO<>(p.getTotal(), p.getPages(), vos);
    }
}

最终，业务层的代码可以简化为：

@Override
public PageDTO<UserVO> queryUserByPage(PageQuery query) {
    // 1.构建条件
    Page<User> page = query.toMpPageDefaultSortByCreateTimeDesc();
    // 2.查询
    page(page);
    // 3.封装返回
    return PageDTO.of(page, UserVO.class);
}

如果是希望自定义PO到VO的转换过程，可以这样做：

@Override
public PageDTO<UserVO> queryUserByPage(PageQuery query) {
    // 1.构建条件
    Page<User> page = query.toMpPageDefaultSortByCreateTimeDesc();
    // 2.查询
    page(page);
    // 3.封装返回
    return PageDTO.of(page, user -> {
        // 拷贝属性到VO
        UserVO vo = BeanUtil.copyProperties(user, UserVO.class);
        // 用户名脱敏
        String username = vo.getUsername();
        vo.setUsername(username.substring(0, username.length() - 2) + "**");
        return vo;
    });
}
A仔不会笑
关注
专栏目录
Mybatis Plus代码生成器 IDEA 插件版 （版本v0.0.6）
06-28
Mybatisplus 代码生成器提供 Windows Desktop 和 IDEA Plugin 两个版本。 我的IDEA是2019.2版本的，没有问题，如果你是其他版本，不知道有没有问题，有问题可以给我反馈。 Windows & Mac Desktop 桌面版下载地址：https://download.csdn.net/download/qq_25166683/12559129 主要功能 1.Mybatis Plus代码生成器 1.1.自定义配置模板 1.2.自定义表-实体映射信息 1.3.多数据源管理 1.4.操作记忆功能 1.5.操作化繁为简 2.工程化（maven,spring boot） 2.1.生成maven工程 2.2.生成springboot工程，集成常用框架，快速开发 3.导出XMind思维导图 4.导出Excel数据库设计文档 5.励志提示
mybatis-mate 简介
热门推荐
逸轩
11-06 1万+
简介 mybatis-mate 为 mp 企业级模块，支持分库分表，数据审计、数据敏感词过滤（AC算法），字段加密，字典回写（数据绑定），数据权限，表结构自动生成 SQL 维护等，旨在更敏捷优雅处理数据。 主要功能 字典绑定 字段加密 数据脱敏 表结构动态维护 数据审计记录 数据范围（数据权限） 数据库分库分表、动态据源、读写分离、数据库健康检查自动切换。 使用 1.依赖导入 Spring Boot 引入自动依赖注解包 ..
IDEA 2018.2 mybatis_plus插件，可以直接使用。
08-09
我使用的是 idea 2018.2 版本，可以使用，其他的目前不清楚，可以试试。下载下来先解压出来一个 zip文件，安装方法：在IDEA中 File -> setting-> Plugins->Install plugin from disk... 选择这个zip文件， 点击 apply -> 点击Ok 。重启idea 即可使用
MyBatis-Plus 实战教程四 idea插件
个人博客，记录了本人学习的各种有趣的技术。
10-29 2138
在未引入分页插件的情况下，MybatisPlus是不支持分页功能的，IService和BaseMapper中的分页方法都无法正常起效。其中缺少的仅仅是分页条件，而分页条件不仅仅用户分页查询需要，以后其它业务也都有分页查询的需求。在刚才的代码中，从PageQuery到MybatisPlus的Page之间转换的过程还是比较麻烦的。这里用到了分页参数，Page，即可以支持分页参数，也可以支持排序参数。在查询出分页结果后，数据的非空校验，数据的vo转换都是模板代码，编写起来很麻烦。
idea2018.1版本mybatis plus插件
06-29
mapper和mapper.xml之间可以来回跳转，亲测可用。适用idea2018.1版本
IntelliJ IDEA2018安装mybatis_plus插件
10-10
（一）Mybatis plugin插件主要功能有： 提供Mapper接口与配置文件中对应SQL的导航 编辑XML文件时自动补全 根据Mapper接口, 使用快捷键生成xml文件及SQL标签 ResultMap中的property支持自动补全，支持级联(属性A.属性B.属性C) 快捷键生成@Param注解 XML中编辑SQL时, 括号自动补全 XML中编辑SQL时, 支持参数自动补全(基于@Param注解识别参数) 自动检查Mapper XML文件中ID冲突 自动检查Mapper XML文件中错误的属性值 支持Find Usage 支持重构从命名 支持别名 自动生成ResultMap属性 快捷键: Option + Enter(Mac) | Alt + Enter(Windows)
idea mybatisplus 插件_10分钟学习mybatisplus
weixin_39693662的博客
11-27 891
mybatis plus 是一款mybatis增强插件，可以在mybatis基础上来进行灵活的单表操作，不用再写SQL语句(仅限于单表)，是一款简单易用的工具，本文结合SpringBoot来对Mybatis plus进行一个详细的讲解。1、初始化1.1 选择一个数据库，然后创建表CREATE TABLE `student` ( `id` bigint(20) NOT NULL, ...
MybatisPlus——插件(MybatisPlus学习该专栏就够啦)，2024年最新java面试结果多长时间出
2401_84434926的博客
04-21 724
小编在这里分享些我自己平时的学习资料，由于篇幅限制，pdf文档的详解资料太全面，细节内容实在太多啦，所以只把部分知识点截图出来粗略的介绍，每个小节点里面都有更细化的内容！程序员代码面试指南 IT名企算法与数据结构题目最优解这是” 本程序员面试宝典!书中对IT名企代码面试各类题目的最优解进行了总结，并提供了相关代码实现。针对当前程序员面试缺乏权威题目汇总这一-痛点， 本书选取将近200道真实出现过的经典代码面试题，帮助广“大程序员的面试准备做到万无一失。“刷”完本书后，你就是“题王”!
MyBatisPlus————条件构造器，AR，代码生成器以及插件扩展
qq_2533491534的博客
07-15 809
1，MyBatisPlus 的使用 1.1，MyBatisPlus的介绍 1.2，通用 CRUD 1.3， MP 启动注入 SQL 原理分析 2，条件构造器 AbstractWrapper 3，ActiveRecord（活动记录） 简介 1，MyBatisPlus的介绍 MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。 愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基
MybatisPlus——基本使用
ouyangkq666的博客
02-25 2106
MyBatisPlus可以节省我们大量的时间,所有CRUD代码都可以自动完成 一、快速入门 1、简介 特性 支持数据库 框架结构 2、快速开始 3、配置日志 4、CRUD扩展 1.插入数据 2.主键生成策略 3.更新数据 4.自动填充 5.乐观锁&悲观锁 6. 查询操作、批量查询 7. 分页查询 属性介绍 8、批量删除 9. 逻辑删除 5、代码生成器（新）
mybatis-plus IDEA常用插件
03-01
mybatis-plus.jar mybatis mybatis-plugin.jar IDEA常用插件 很实用的
Mybatis-Plus插件
04-24
Mybatis-Plus（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
mybatisplus的idea插件2.9
06-23
mybatisplus的idea插件2.9版本，需要导入到idea，直接替换c:user\用户名\.IntelliJIdea2016.3\config\plugins\mybatis_plus\lib下面的jar即可。记得重启idea
MybatisPlus快速上手1——MybatisPlus插件的介绍和整合
卓汶的博客
09-24 733
(opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
大神带你玩转后端开发神器MybatisPlus——一篇文章精通MybatisPlus的使用，高效开发Java后端，节省编写sql的时间，分页，自动生成代码工具详解等
JAVA求生之路——博主406766467
01-24 395
文章目录知识资源共享，一起交流怎么学习高效开发一、什么是MybatisPlus？二、MybatisPlus有什么特性？三、支持的数据库？四、引入maven依赖五、配置数据库5.1 dao层接口的实现（继承BaseMapper<对象>）5.2 ServiceImpl层的实现5.2 Controller层的实现5.3 测试接口 /api/v1/banner/list六、单元测试@Test的使用6.1 编写测试类，结合@Slf4j日志使用6.2 查看控制台是否打印6.3 控制台打印日志6.3.1 添加
idea mybatisplus 插件使用
努力学习，努力爱你！
07-11 4588
因业务需求，表中可能会时不时增加一些字段，大多情况下实体类中不会添加表中没有的字段，因此可以直接重新生成实体类并进行覆盖即可。
IDEA神级插件：MybatisPlus代码生成器
最新发布
小林的博客
08-15 1344
虽然网上有许多关于MybatisPlus代码生成的教程,但大多需要手动添加各种依赖,配置模板引擎,步骤繁琐。今天,我们将为您介绍一款既简单又实用,能完美满足需求的IDEA插件。它无需额外依赖,无需复杂配置,只需简单几步操作,即可生成完整的MybatisPlus风格代码。通过使用这款强大的IDEA插件,我们可以显著提高开发效率,减少重复劳动,降低错误率。在软件开发过程中,我们经常遇到这样的情况:新需求涌现,需要添加多个数据库表。这些传统方法不仅耗时费力,还容易出错,更谈不上代码的优雅性。
Ideal2023新UI——MybatisPlus插件的使用，MybatisPlus 超好用的idea代码生成插件
m0_65324703的博客
03-27 2318
设置插件。
mybatisplus idea插件
05-09
MybatisPlus Idea插件是一款针对Java开发者，基于IntelliJ IDEA开发的MybatisPlus增强插件。 该插件的出现，旨在为Java开发者提供更加便捷、高效的MybatisPlus使用体验。 MybatisPlus是基于Mybatis进行一系列增强，比如自动生成基础代码，更加丰富的查询、更新、删除操作等。这使得MybatisPlus在实际开发中被广泛应用。MybatisPlus Idea插件的出现，让Java开发者在使用MybatisPlus时，无需手动编写基础代码。通过简单的配置，即可轻松生成Mapper、Entity、Service、Controller等基础代码，节省了大量时间和精力。 MybatisPlus Idea插件的功能非常丰富，具有如下特点： 1、快速生成基础代码，为Java开发者提供生成Mapper、Entity、Service、Controller等基础代码的功能，省去了重复劳动。 2、提供高级代码生成模版，能够自定义生成模板。通过模板，用户可以自定义生成的代码，满足不同的需求。 3、具有智能提示功能，通过智能提示功能，用户可以快速获取Mapper、Entity、Service、Controller等类及其方法，并快速但准确地编写代码。 4、自动注入配置信息，可以自动注入MybatisPlus的配置文件，进一步提高开发效率。 总之，MybatisPlus Idea插件极大提高了开发人员的工作效率，让开发者更加专注于业务逻辑的开发。如果您正在使用MybatisPlus开发Java项目，那么这是一款不可错过的插件。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值