SpringBooti集成MybatisPlus

涛哥

2023-3-14

SpringBoot

本文最后更新于2023.04.22-13:08，某些文章具有时效性，若有错误或已失效，请在下方留言或联系涛哥。

前言

我们需要了解什么是MybatisPlus？

那么首先我们就要先了解什么是Mybatis？

什么是Mybatis？

那么什么是Mybatis呢？

可以这么理解？我们chuant操作数据库是先打开一个数据库连接，然后通过jdbc的包的工具类进行一系列的数据库操作；而Mybatis就是简化了对传统ORM形成的一个框架？就像传统java 然后用Spring框架以后更加容易对实体类的管理

说了这么多那到底什么是MybatisPlus呢？很简单和Mybatis一样就是对原有的Mybatis的功能进行保留在这基础上去增加更多扩展

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

官方有这么一句话：我们的愿景是成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。

我们为什么要用MybatisPlus？

官方给出的特性：

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

自己使用得到的：

MybatisPlus相较于Mybatis而言操作起来更简单
MybatisPlus内部封装了多个对Entity的实体类进行一系列的crud的方法
自定义模板进行代码自动生成提高开发效率
主键自动生成提供多种算法
支持多种数据库

使用

1，先去官网查询看文档说明地址：https://baomidou.com/

2，我们创建一个SpringBoot工程

3，导入我们需要的依赖（安装）

SpringBoot project：

maven

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

Gradle

compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '最新版本'

Spring project：
Maven

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

Gradle

compile group: 'com.baomidou', name: 'mybatis-plus', version: '最新版本'

4，配置yml 和添加MybatisPlus插件配置开启包扫描

mybatis:
    mapper-locations: classpath:mapper/*xml
    type-aliases-package: com.tg.admin.mybatis.entity
    configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus:
    configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Program: admin
 * @ClassName MybatisPlusConfig
 * @Author: liutao
 * @Description: Mybatisplus插件
 * @Create: 2023-03-12 13:07
 * @Version 1.0
 **/

@Configuration
@MapperScan("com.tg.admin.mapper")
public class MybatisPlusConfig {

    /**
     * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }

}

6，创建一个Mapper接口并继承于 BaseMapper这个接口

public interface UserMapper extends BaseMapper<User> {

}

7，创建一个Service 去实现 MybatisPlus 提供的ServiceImpl 的方法，需要什么拿什么；当然你也可以自定义自己的接口并实现

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User>  implements UserService  {
@Override
  public boolean saveOrUpdate(User user) {
    return super.saveOrUpdate(user);
  }
}

8，在我们需要的地方调用

package com.tg.admin.controlle

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.poi.excel.ExcelReader;
import cn.hutool.poi.excel.ExcelUtil;
import cn.hutool.poi.excel.ExcelWriter;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.tg.admin.common.Constants;
import com.tg.admin.common.Result;
import com.tg.admin.dto.UserDto;
import com.tg.admin.entity.User;
import com.tg.admin.service.impl.UserServiceImpl;
import com.tg.admin.utils.JwtUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.net.URLEncoder;
import java.util.List;

/**
 * @Program: admin
 * @ClassName UserController
 * @Author: liutao
 * @Description: 用户web接口
 * @Create: 2023-03-12 07:11
 * @Version 1.0
 **/
@Api(value = "用户接口",basePath = "/user")
@RequestMapping("/user")
@RestController
public class UserController {
    @Autowired
    private UserServiceImpl userService
    
   @ApiOperation("根据id查询用户信息")
   @GetMapping("/person")
   public Result findOne(){
      User currentUser = JwtUtil.getCurrentUser();
      return Result.success(userService.getById(currentUser.getId()));
   }
}

9，我们查看一下数据，按F12 ，找到network 然后我们刷新看一下请求