Mybatis-Plus

Mybatis-Plus

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

快速开始

1、创建数据库

CREATE DATABASE `Mybatis_Plus` CHARACTER SET 'utf8' COLLATE 'utf8_unicode_ci';

use `Mybatis_Plus`;

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)
);

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[e-mail]'),
(2, 'Jack', 20, '[e-mail]'),
(3, 'Tom', 28, '[e-mail]'),
(4, 'Sandy', 21, '[e-mail]'),
(5, 'Billie', 24, '[e-mail]');

2、创建SpringBoot项目

• 创建一个空 SpringBoot项目

• 导入以下依赖 尽量不要同时导入mybatis和mybatis-plus

  mysqlmysql-connector-javaorg.projectlomboklombokcom.baomidoumybatis-plus-boot-starter3.4.2

3、向 application.yaml 添加数据库数据源配置

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&charterEncoding=utf8&serverTimezone=GMT%2B8
    password: 970699
    username: root
    driver-class-name: com.mysql.cj.jdbc.Driver

4、创建实体类

package com.wyx.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    // 注意点， 不能写成 long 不然在后面的主键调用雪花算法会出错
    private Long id;
    
    private String name;
    private Integer age;
    private String email;

}

5、编写Mapper接口

这里编写 UserMapper 接口只需要继承 BaseMapper 这个类

BaseMapper 需要给它传一个泛型，也就是你创建这个类的实体类

package com.wyx.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.wyx.pojo.User;

// 这里编写 UserMapper 接口只需要继承 BaseMapper 这个类
// BaseMapper 需要给它传一个泛型，也就是你创建这个类的实体类 User

@Repository		//代表它是持久层
public interface UserMapper extends BaseMapper{

}

6、在主启动类上添加MapperScan的包扫描

package com.wyx;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@MapperScan("com.wyx.mapper")
@SpringBootApplication
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }

}

7、开始测试

package com.wyx;

import com.wyx.mapper.UserMapper;
import com.wyx.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class MybatisPlusApplicationTests {

	//将容器的东西注入类中
    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
		// userMapper 有很多方法都继承于 BaseMapper类，这里参数属于一个 Wrapper对象后面会说到
        ListuserList = userMapper.selectList(null);
		//新更新的Lambda表达式写法
        userList.forEach(System.out::println);
    }
}

测试结果

通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。

但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续往下看吧！

配置日志

在我们开发过程中，我们可以查看可以调用日志功能查看它到底是如何给我们写 SQL

在 Mybatis-Plus 中我们如何编写配置日志功能呢？

我们只需要在配置文件中添加如下配置即可

mybatis-plus:
  configuration:
    # 喜欢什么日志功能都可以自行添加，比如 log4j
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

添加后再次运行测试

CRUD的使用

Insert

方法：

// 插入一条记录,参数是实体类实例化的对象int insert(T entity);

@Testvoid testInsert(){        User user = new User();    user.setName("啦啦啦");    user.setAge(17);    user.setEmail("[e-mail]");    userMapper.insert(user);    //插入后查询表    ListuserList = userMapper.selectList(null);    userList.forEach(System.out::println);    }

运行结果

我们并没有设置 id 在代码中，那么它是如何生成我们的 id 的呢？

主键自增策略

在 Mybatis-Plus 中，默认的 id 只要在设置数据类型为 Long 或者 String 类型就会利用 雪花算法 生成默认的 id 全球唯一

什么是雪花算法?

雪花算法是Twitter公司编写，主要用在分布式系统上的生成全球唯一 id 。 算法其核心思想：使用41bit作为毫秒数，10bit作为机器的ID（5bit数据中心，5bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每个毫秒可以产生4096个ID），最后还有一个符号位，永远是0。

如何使用主键自增策略？

在 Mybatis-Plus 中，主键默认使用雪花算法生成主键id，也可以手动修改，自需要在实体类中的主键上加入以下注解

package com.wyx.pojo;import com.baomidou.mybatisplus.annotation.IdType;import com.baomidou.mybatisplus.annotation.TableId;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;@Data@AllArgsConstructor@NoArgsConstructorpublic class User {    /*    *   IdType可以取得值如下：    *    public enum IdType {            AUTO(0),   自动递增，但前提是数据库必须是自增字段，否则出错            NONE(1),    没有主键            INPUT(2),   用户自己设置主键            ASSIGN_ID(3),   利用雪花算法，根据id类型（只能是Long或者String）生成对应的id,默认取值            ASSIGN_UUID(4),     uuid加强版，也是生成String类型id            ID_WORKER(3),       雪花算法生成Long类型的id 已过时            ID_WORKER_STR(3),   雪花算法生成String类型的id 已过时            UUID(4);    uuid生成String类型的id 已过时    *     * */    @TableId(type = IdType.ASSIGN_ID)    private Long id;    private String name;    private Integer age;    private String email;}

Update

方法：

// 根据 whereWrapper 条件，更新记录int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) WrapperwhereWrapper);// 根据 ID 修改int updateById(@Param(Constants.ENTITY) T entity);

Delete

方法：

// 根据 entity 条件，删除记录	根据wrapper来删除int delete(@Param(Constants.WRAPPER) Wrapperwrapper);// 删除（根据ID 批量删除）	传入一个Arrays.asList(1,2,3);的参数int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);// 根据 ID 删除 int deleteById(Serializable id);// 根据 columnMap 条件，删除记录   int deleteByMap(@Param(Constants.COLUMN_MAP) MapcolumnMap);

Select

方法：

// 根据 ID 查询T selectById(Serializable id);// 根据 entity 条件，查询一条记录  queryWrapper条件T selectOne(@Param(Constants.WRAPPER) WrapperqueryWrapper);// 查询（根据ID 批量查询）	传入一个Arrays.asList(1,2,3);的参数ListselectBatchIds(@Param(Constants.COLLECTION) Collection idList);// 根据 entity 条件，查询全部记录	queryWrapper条件ListselectList(@Param(Constants.WRAPPER) WrapperqueryWrapper);// 查询（根据 columnMap 条件）		ListselectByMap(@Param(Constants.COLUMN_MAP) MapcolumnMap);// 根据 Wrapper 条件，查询全部记录List<Map> selectMaps(@Param(Constants.WRAPPER) WrapperqueryWrapper);// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值ListselectObjs(@Param(Constants.WRAPPER) WrapperqueryWrapper);// 根据 entity 条件，查询全部记录（并翻页）// page参数是Page使用实体类实例化的一个对象其中第一个参数是第几页，第二个参数是页面大小	Pagepage = new Page(1,4);IPageselectPage(IPagepage, @Param(Constants.WRAPPER) WrapperqueryWrapper);// 根据 Wrapper 条件，查询全部记录（并翻页）	page// page参数是Page使用实体类实例化的一个对象其中第一个参数是第几页，第二个参数是页面大小	Pagepage = new Page(1,4);IPage<Map> selectMapsPage(IPagepage, @Param(Constants.WRAPPER) WrapperqueryWrapper);// 根据 Wrapper 条件，查询总记录数		queryWrapper条件Integer selectCount(@Param(Constants.WRAPPER) WrapperqueryWrapper);

自动填充

一般数据库在有关时间的操作，我们都是让它自动填充。那么我们如何自动填充呢？下面我们使用两种方法实现

在 user 表中添加创建时间（create_time），和修改时间（update_time）两个字段

1、数据库中设计  （一般不使用在公司中）

在 user 表中添加创建时间（create_time），和修改时间（update_time）两个字段并如下勾选并添加默认值 CURRENT_TIMESTAMP

同步 User 实体类

package com.wyx.pojo;import com.baomidou.mybatisplus.annotation.IdType;import com.baomidou.mybatisplus.annotation.TableId;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;import java.util.Date;@Data@AllArgsConstructor@NoArgsConstructorpublic class User {    @TableId(type = IdType.ASSIGN_ID)    private Long id;    private String name;    private Integer age;    private String email;    private Date createTime;    private Date updateTime;}

编写插入和更新代码测试

@Testvoid testInsert(){    //插入代码    User user = new User();    user.setName("啦啦啦");    user.setAge(17);    user.setEmail("[e-mail]");    System.out.println(user.toString());}

测试结果

@Testvoid testUpdate(){    //更新代码    User user = new User();    user.setName("小红花");    user.setId(5L);    userMapper.updateById(user);    System.out.println(user.toString());}

测试结果

2、代码修改 （常用）

去掉上一步表中的默认值和更新时间去掉

在实体类中添加注解

package com.wyx.pojo;import com.baomidou.mybatisplus.annotation.FieldFill;import com.baomidou.mybatisplus.annotation.IdType;import com.baomidou.mybatisplus.annotation.TableField;import com.baomidou.mybatisplus.annotation.TableId;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;import java.util.Date;@Data@AllArgsConstructor@NoArgsConstructorpublic class User {    @TableId(type = IdType.ASSIGN_ID)    private Long id;    private String name;    private Integer age;    private String email;    /*      *   @TableField(fill = FieldFill.INSERT)         自动填充注解    *       *   fill = FieldFill.DEFAULT            默认方式，不处理    *   fill = FieldFill.INSERT             插入时填充    *   fill = FieldFill.INSERT_UPDATE      插入或更新时    *   fill = FieldFill.UPDATE             更新时填充    * */    @TableField(fill = FieldFill.INSERT)    private Date createTime;    @TableField(fill = FieldFill.INSERT_UPDATE)    private Date updateTime;}

编写处理器来处理注解，就是编写一个类来实现MetaObjectHandler 接口，并将类注入到IOC容器中

package com.wyx.handler;import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;import org.apache.ibatis.reflection.MetaObject;import org.springframework.stereotype.Component;import java.util.Date;@Componentpublic class MyMetaObjectHandler implements MetaObjectHandler {    @Override    public void insertFill(MetaObject metaObject) {        //  执行插入操作时，查找对应的字段名，和给它更新的值，并将元数据带入        this.setFieldValByName("createTime",new Date(),metaObject);        this.setFieldValByName("updateTime",new Date(),metaObject);    }    @Override    public void updateFill(MetaObject metaObject) {        this.setFieldValByName("updateTime",new Date(),metaObject);    }}

编写插入代码：

@Testvoid testInsert(){    //插入代码    User user = new User();    user.setName("代码自动跟新");    user.setAge(19);    user.setEmail("[e-mail]");    userMapper.insert(user);    System.out.println(user.toString());}

测试结果：

编写更新代码：

@Testvoid testUpdate(){    User user = new User();    user.setName("哎呦喂");    user.setId(2L);    userMapper.updateById(user);    System.out.println(user.toString());}

测试结果：

乐观锁

乐观锁：执行之前总认为自己不会出错，出错了在进行处理。

悲观锁：每次执行都会先检查错误，没有错误才继续执行。

那么在Mybatis-Plus中我们如何使用乐观锁呢？

1、在数据库中添加一个 version 字段。

2、向实体类添加version字段   并添加 @Version注解

package com.wyx.pojo;import com.baomidou.mybatisplus.annotation.*;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;import java.util.Date;@Data@AllArgsConstructor@NoArgsConstructorpublic class User {    @TableId(type = IdType.ASSIGN_ID)    private Long id;    private String name;    private Integer age;    private String email;    @TableField(fill = FieldFill.INSERT)    private Date createTime;    @TableField(fill = FieldFill.INSERT_UPDATE)    private Date updateTime;    //向添加的字段添加 version字段    @Version    private Integer version;}

3、向IOC容器中注入，处理乐观锁的bean 使用配置文件注入，参考官网

package com.wyx.config;import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;import org.mybatis.spring.annotation.MapperScan;import org.springframework.context.annotation.Bean;import org.springframework.stereotype.Component;@Configuration@MapperScan("com.wyx.mapper")//@MapperScan("com.wyx.mapper") 开始时是配置在主启动类上，当我们创建Mybatis-Plus时，一般情况下把它移动到我们的配置类上public class MybatisPlusConfig {    /**     * 旧版    @Bean    public OptimisticLockerInterceptor optimisticLockerInterceptor() {        return new OptimisticLockerInterceptor();    }     */        /**     * 新版	乐观锁插件     */    @Bean    public MybatisPlusInterceptor mybatisPlusInterceptor() {        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());        return mybatisPlusInterceptor;    }}

3、模拟添加并发修改代码

@Testvoid testUpdate(){    //      查询第一个用户    User user = userMapper.selectById(1L);    user.setName("哎呦喂");    user.setEmail("[e-mail]");    //      模拟第二个线程也修改一号用户    User user2 = userMapper.selectById(1L);    user2.setName("啦啦啦");    user2.setEmail("[e-mail]");    //        2号线程抢先执行    userMapper.updateById(user2);    //        1号线程再执行    userMapper.updateById(user);	//如果没有乐观锁，就会覆盖插队线程的值    System.out.println(user.toString());}

查看测试结果

只有插入线程修改成功，一号线程没有修改成功

分页查询

向上面的 MybatisPlusConfig配置类中插入，分页拦截器

1、导入分页拦截器

// 旧版@Beanpublic PaginationInterceptor paginationInterceptor() {PaginationInterceptor paginationInterceptor = new PaginationInterceptor();// 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false// paginationInterceptor.setOverflow(false);// 设置最大单页限制数量，默认 500 条，-1 不受限制// paginationInterceptor.setLimit(500);// 开启 count 的 join 优化,只针对部分 left joinpaginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));return paginationInterceptor;}// 最新版 分页插件@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));return interceptor;}

2、编写分页查询代码

@Testvoid testPageLimit(){    //第一个参数代表显示第几页，第二个参数为页面大小    Pagepage = new Page<>(3,2);    //selectPage()方法，第一个参数为分页器对象，第二个参数为高级查询 wrapper对象，可以为null    userMapper.selectPage(page, null);    page.getRecords().forEach(System.out::println);}

测试结果

逻辑删除

物理删除：从数据库中移除

逻辑删除：再数据库中没有被移除，而是通过一个变量让它失效！ delete=0  -->   delete=1

逻辑删除常用于管理员查看被删除的记录，防止数据丢失，类似于回收站

1、在数据库中添加delete字段

2、实体类中添加字段

@TableLogic  //逻辑删除注解private Integer delete;

3、将逻辑删除配置到IOC容器中（3.1.1版本之后不需要这一步）

@Beanpublic ISqlInjector sqlInjector(){    return new LogicSqlInjector();}

4、在 application.yaml 中配逻辑删除参数

mybatis-plus:  global-config:    db-config:      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)      logic-delete-value: 1 # 逻辑已删除值(默认为 1)      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

5、 编写删除代码测试删除

@Testvoid testDelete(){    //删除用户,逻辑删除    userMapper.deleteById(1L);    // 查询用户    ListuserList = userMapper.selectList(null);    userList.forEach(System.out::println);}

没有 1 号用户

查看数据库

1号用户依然存在 ，只是逻辑删除值变成了 1。

性能分析插件

我们在平时的开发中，会遇到一些慢查询，会遇到一些慢sql，测试！druid…
Mybatis-Plus也提供了性能分析插件，如果超过了这个时间就停止运行。

那么我们如何使用呢？

1、导入以下依赖

p6spyp6spy3.9.1

2、修改数据库驱动和url

spring:  datasource:    url: jdbc:p6spy:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&charterEncoding=utf8&serverTimezone=GMT%2B8    password: 970699    username: root    driver-class-name: com.p6spy.engine.spy.P6SpyDriver

3、在resources  下新建 spy.properties 文件，内容如下

#3.2.1以上使用modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory#3.2.1以下使用或者不配置#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory# 自定义日志打印logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger#日志输出到控制台appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger# 使用日志系统记录 sql#appender=com.p6spy.engine.spy.appender.Slf4JLogger# 设置 p6spy driver 代理deregisterdrivers=true# 取消JDBC URL前缀useprefix=true# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.excludecategories=info,debug,result,commit,resultset# 日期格式dateformat=yyyy-MM-dd HH:mm:ss# 实际驱动可多个#driverlist=org.h2.Driver# 是否开启慢SQL记录outagedetection=true# 慢SQL记录标准 2 秒outagedetectioninterval=2

4、运行测试

条件构造器

条件构造器官网指南

非常重要，它代替了我们很多的复杂 SQL 语句

使用方法：

@Testvoid contextLoads() {    //获取一个 QueryWrapper 对象    QueryWrapperwrapper = new QueryWrapper<>();    //使用链式编程    wrapper.eq("name","啦啦啦")        .eq("age",18);    //将编写的 wrapper 对象传入查询，或修改的方法中    ListuserList = userMapper.selectList(wrapper);    userList.forEach(System.out::println);}

常用方法参见官网，或下图。

代码生成器

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

1、导入代码生成器需要的依赖

com.baomidoumybatis-plus-generator3.4.1org.apache.velocityvelocity-engine-core2.3

2、编写代码生成器

@Testvoid CodeGenerator(){    //配置代码生成器对象    AutoGenerator generator = new AutoGenerator();    // 配置策略    // 1、全局配置    GlobalConfig gc = new GlobalConfig();    String projectPath = System.getProperty("user.dir");    gc.setOutputDir(projectPath + "/src/main/java");    gc.setAuthor("王玉星");        //作者信息    gc.setOpen(false);      //是否打开资源管理器    gc.setFileOverride(false);  //生成文件是否覆盖    gc.setSwagger2(true);      //实体属性 Swagger2 注解    gc.setServiceImplName("%sService");     //去掉Service的I前缀    gc.setIdType(IdType.ASSIGN_ID);     //主键生成策略    gc.setDateType(DateType.ONLY_DATE);     //设置时间类型    //将全局配置放入代码生成器对象中    generator.setGlobalConfig(gc);    // 2、数据源配置    DataSourceConfig dsc = new DataSourceConfig();    //连接url    dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&charterEncoding=utf8&serverTimezone=GMT%2B8");    dsc.setDriverName("com.mysql.cj.jdbc.Driver");    //连接驱动    dsc.setUsername("root");      //连接名称    dsc.setPassword("970699");      //连接密码    dsc.setDbType(DbType.MYSQL);        //连接数据库类型    //将数据源配置放入代码生成器对象中    generator.setDataSource(dsc);    // 3、包配置    PackageConfig pc = new PackageConfig();    pc.setModuleName("CodeGenerator");  //生成的模块    pc.setParent("com.wyx");        //生成的父路径    pc.setEntity("pojo");       //实体类包    pc.setService("service");   //service层包    pc.setController("controller");     //controller 层包    pc.setMapper("mapper");     //mapper 层包    //将生成包规则放入代码生成器对象中    generator.setPackageInfo(pc);    // 4、配置策略    StrategyConfig strategy = new StrategyConfig();    strategy.setInclude("user");          //设置要映射的表，看数据库的表来(最重要)，多张数据库表，可以传递多个表名    strategy.setNaming(NamingStrategy.underline_to_camel);      //设置命名规则    strategy.setColumnNaming(NamingStrategy.underline_to_camel);    //设置命名规则    strategy.setEntityLombokModel(true);        //自动使用Lombok    strategy.setLogicDeleteFieldName("deleted");       //逻辑删除策略    // 自动填充配置    TableFill createTime = new TableFill("create_time", FieldFill.INSERT);      //自动填充策略配置    TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);   //自动更新策略配置    strategy.setTableFillList(Arrays.asList(createTime,updateTime));    //乐观锁    strategy.setVersionFieldName("version");    //设置乐观锁    strategy.setRestControllerStyle(true);      //生成 @RestController 控制器 @Controller -> @RestController    strategy.setControllerMappingHyphenStyle(true);      //驼峰转连字符 @RequestMapping("/managerUserActionHistory") -> @RequestMapping("/manager-user-action-history")    //将配置的策略放入代码生成器对象中    generator.setStrategy(strategy);    generator.execute();  //执行代码生成器方法}

运行代码查看自动生成的代码

报错是因为有一些依赖没有引入

Service层CURD