您现在的位置是：首页 > 后台技术 > MyBatisMyBatis

MyBatisPlus简介(图文)

第十三双眼睛2021-06-30【MyBatis】人已围观

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

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

快速入门：
在数据库中执行以下语句，生成用户表并且插入数据：

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年龄',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
	PRIMARY KEY (id)
);

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

为了方便，创建一个springboot项目，结构如下：

导入依赖：

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>

</exclusions>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.10</version>
   <scope>provided</scope>
</dependency>
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <version>5.1.40</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.6</version>
</dependency>
<dependency>
   <groupId>javax.servlet</groupId>
   <artifactId>javax.servlet-api</artifactId>
   <version>3.1.0</version>
   <scope>provided</scope>
</dependency>
<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>druid</artifactId>
   <version>1.0.14</version>
</dependency>

</dependencies>

在导入依赖的时候，不要同时导入MyBatis和MyBatis-Plus.
然后创建Dao继承BaseMapper

package com.xinchen.mybatis.plus.dao;

import org.apache.ibatis.annotations.Mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.xinchen.mybatis.plus.entity.User;
@Mapper
public interface UserMapper extends BaseMapper<User>{

   //这里继承了BaseMapper 就继承了很多功能
   //如果又自定义的方法,自己定义即可
}

至此，所有的CRUD都已经编写完成
写个测试方法：测试查询

@RequestMapping("/test")
   public List<User> test(){
       List<User> userList = userMapper.selectList(null);
       System.out.println(userList);
       return userList;
}

结果为：

配置日志输出：现在所有的SQL语句都是看不到的。
只需要在application.properties中增加如下配置即可
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

数据插入：

@RequestMapping("/test1")
   public void test1(){
       User user = new User();
       user.setName("zhangsan");
       user.setAge(14);
       user.setEmail("aaa@qq.com");
       int insert = userMapper.insert(user);
       System.out.println("insert："+insert);
       System.out.println("user:"+user);
}

数据已经插入了
主键生成策略
雪花算法：
雪花算法生成的最终结果其实就是一个long类型的Java长整型数字，这是一个大前提！
算法所有的内容都是针对这个数字进行运算的。Java基础类型相信都很熟悉，有32位的整型int类型，和64位的长整型long类型。我们单说long类型，64位说的是数字转换为二进制形式时候的表现，其中第一位表示的是正负，也就是符号，剩下的63位表示的是字面数字。
针对每个公司，随着服务化演进，单个服务越来越多，数据库分的越来越细，有的时候一个业务需要分成好几个库，这时候自增主键或者序列之类的主键id生成方式已经不再满足需求，分布式系统中需要的是一个全局唯一的id生成规则。既然号称在全局分布式系统中唯一，那么主键的生成规则必然要复杂一些，以前看过很多资料，都对雪花的生成一知半解，最后才发现是对Java的位运算没有彻底了解，这里想针对雪花算法，以一种浅显的的方式来进行学习，去除以前的一知半解和对雪花算法的神秘感。
如果想指定主键的生成策略，可以在主键属性上配置注解@TableId(type = IdType.AUTO)。
测试更新

@RequestMapping("/test2")
   public void test2(){
       User user = new User();
       user.setId(1L);
       user.setName("zhangsan1");
       user.setAge(15);
       user.setEmail("aaab@qq.com");
       int insert = userMapper.updateById(user);
       System.out.println("insert："+insert);
       System.out.println("user:"+user);
}

看看结果，已经修改。
数据库字段中的创建时间和修改时间，我们希望它自动生成
方式1：数据库级别
将数据库的对应字段的默认值和是否自动更新进行设置（不建议这么干）
插入一条数据，看下面的图，已经起作用了

修改一条数据，也起作用了

方式2：代码级别
字段上加注解@TableField(fill = FieldFill.INSERT) @TableField(fill = FieldFill.UPDATE)
然后编写一个处理器来处理注解

package com.xinchen.mybatis.plus.handler;

import java.util.Date;

import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@Component
public class MyObjectHandler implements MetaObjectHandler{

   @Override
   public void insertFill(MetaObject metaObject) {
       log.info("start set default value");
       //this.setFieldValByName(fieldName, fieldVal, metaObject);
       this.setFieldValByName("createTime", new Date(), metaObject);
   }

   @Override
   public void updateFill(MetaObject metaObject) {
       log.info("start set default value");
       this.setFieldValByName("updateTime", new Date(), metaObject);
   }
}

插入一条数据

可以看到，创建时间已经帮我们生成了
再来看看更新

可以看到，更新时间已经自动帮我们更新了。
乐观锁问题的处理
我们用MyBatis处理乐观锁的时候，需要自己去处理，而MyBatis-Plus可以帮我们自动处理
乐观锁实现方式：
取出记录时，取出当前version
更新时，带上这个version update xxx set version = newVersion where version=newVersion
如果version和newVersion不一致，则更新不成功
第一步：给数据库中增加version字段并设置默认值为1 实体类也要加对应的属性version 并加对应的注解@Version
第二不：编写配置类

package com.xinchen.mybatis.plus.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;

@Configuration
@EnableTransactionManagement
public class MyBatisPlusConfig {

   @Bean
   public OptimisticLockerInterceptor optimisticLockerInterceptor(){
       return new OptimisticLockerInterceptor();
   }
}

已经被成功更行了，并且version字段被自动加了1

来个失败的情况

@RequestMapping("/test2")
   public void test2(){
       User user = userMapper.selectById(2L);
       user.setName("zhangsan1");
       user.setAge(15);
       user.setEmail("aaab@qq.com");

       User user2 = userMapper.selectById(2L);
       user.setName("zhangsan2");
       user.setAge(16);
       user.setEmail("aaac@qq.com");
       userMapper.updateById(user2);

       int insert = userMapper.updateById(user);
       System.out.println("insert："+insert);
       System.out.println("user:"+user);
}

看上图的结果，更新成功了一次，被插队的那一次是失败的。
条件查询，用Map

@RequestMapping("/test3")
   public void test3(){
       Map<String,Object> map = new HashMap<String,Object>();
       map.put("name", "zhangsan1");
       List<User> list = userMapper.selectByMap(map);
       System.out.println(list);
}

结果如下：

可以看到，查询出来两条数据
分页查询
第一种：自己写，limit
第二种：第三方插件如：pageHelper
第三种：自带的
添加配置

@Bean
public PaginationInterceptor mybatisPlusInterceptor() {
return new PaginationInterceptor();
}

结果如下图：

可以看到，框架自动的帮我们做了分页操作
删除

@RequestMapping("/test5")
   public void test5(){
       int deleteById = userMapper.deleteById(1L);
       System.out.println(deleteById);
   }

可以看到，id为1的数据已经被删除了
上面的删除时物理删除，是从硬盘上把数据删除，可以实现逻辑删除
首先在数据库种增加一个字段 is_delete 默认值为0 表示没有被删除
类中也增加一个属性 isDelete 并增加注解 @TableLogic
在application.properties中配置
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
测试结果

自动生成的SQL语句中也加上了逻辑删除字段

数据库中的数据is_delete状态也确实发生了改变
性能分析工具
平时的项目运行过程中，会产生一些慢SQL,也提供了此功能，可以输出每条SQL及执行时间
配置一个对象

@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
//ms,超过此处设置的ms则sql不执行
performanceInterceptor.setMaxTime(1);
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}

在application.peroperties配置文件中配置如下项spring.profiles.active=dev
执行以下查询所有用户的功能，果然，控制台报错了

条件构造器 Wrapper

@RequestMapping("/test7")
   public void test7(){
       QueryWrapper<User> wrapper = new QueryWrapper<>();
       wrapper.isNotNull("name").eq("age", 15);
       List<User> selectList = userMapper.selectList(wrapper);
       System.out.println(selectList);
   }

结果如下：

代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

package com.xinchen.mybatis.plus;

import java.util.ArrayList;
import java.util.List;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

public class XinChenCode {

   public static void main(String[] args) {
       AutoGenerator generator = new AutoGenerator();
       //配置策略
       GlobalConfig config = new GlobalConfig();
       String path = System.getProperty("user.dir");
       config.setOutputDir(path +"/src/main/java");
       config.setAuthor("十三");
       config.setOpen(false);
       config.setFileOverride(false);
       config.setServiceName("%sService");
       config.setIdType(IdType.AUTO);
       config.setDateType(DateType.ONLY_DATE);
       generator.setGlobalConfig(config);

       //设置数据源
       DataSourceConfig dataSource = new DataSourceConfig();
       dataSource.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf-8");
       dataSource.setDriverName("com.mysql.jdbc.Driver");
       dataSource.setUsername("root");
       dataSource.setPassword("123456");
       dataSource.setDbType(DbType.MYSQL);
       generator.setDataSource(dataSource);

       //包的配置
       PackageConfig packageConfig = new PackageConfig();
       packageConfig.setModuleName("blog");
       packageConfig.setParent("com.xinchen.mybatis.plus");
       packageConfig.setEntity("entity");
       packageConfig.setMapper("dao");
       packageConfig.setController("controller");
       generator.setPackageInfo(packageConfig);

       //策略配置
       StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setInclude("blog");
strategy.setControllerMappingHyphenStyle(true);
TableFill createFill = new TableFill("create_time", FieldFill.INSERT);
TableFill upadteFill = new TableFill("update_time", FieldFill.UPDATE);
List<TableFill> fillList = new ArrayList<TableFill>();
fillList.add(createFill);
fillList.add(upadteFill);
strategy.setTableFillList(fillList);
generator.setStrategy(strategy);

       generator.execute();
   }
}