mybatis-plus使用

Mybatis-plus开发

快速入门

1、创建数据库、数据表

CREATE DATABASE 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)
);
#真实开发中还需要version(版本)、deleted(逻辑删除)等等

2、数据表中添加数据

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

3、创建springboot项目

4、导入mybatis-plus依赖

# 引入 Spring Boot Starter 父工程
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
   	<version>2.6.0</version>
    <relativePath/>
</parent>

#引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、h2 依赖
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
     <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3.4</version>
        </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

5、配置文件中添加数据源配置

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serveTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

6、pojo-dao(链接mybatis，配置mapper文件)

6、使用mybatis-plus后，不需要进行那些繁琐操作

• pojo

  package com.wl.mybatis_plus.pojo;
  
  import lombok.AllArgsConstructor;
  import lombok.Data;
  import lombok.NoArgsConstructor;
  
  @Data
  @AllArgsConstructor
  @NoArgsConstructor
  public class User {
      private Integer id;
      private String name;
      private Integer age;
      private String email;
  }
  

• mapper

  package com.wl.mybatis_plus.mapper;
  import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  import com.wl.mybatis_plus.pojo.User;
  import org.springframework.stereotype.Repository;
  
  @Repository
  public interface UserMapper extends BaseMapper<User> {
  }
  
  

• 在启动时定义mapper扫描

  @SpringBootApplication
  @MapperScan("com.wl.mybatis_plus.mapper")
  public class MybatisPlusApplication {
  
      public static void main(String[] args) {
          SpringApplication.run(MybatisPlusApplication.class, args);
      }
  
  }
  

• 测试

  package com.wl.mybatis_plus;
  
  import com.wl.mybatis_plus.mapper.UserMapper;
  import com.wl.mybatis_plus.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
      UserMapper userMapper;
      @Test
      void contextLoads() {
      }
  
      @Test
      void testSelect(){
          List<User> users = userMapper.selectList(null);
          users.forEach(System.out::println);
      }
  }
  

配置日志

为了查看sql的执行语句，需要配置日志信息

#将日志输出到控制台
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

CRUD扩展

主键生成策略

数据表中设置主键的生成策略，可以通知在主键上设置@TableId(type=IdType.AUTO)，以下是id其他几种生成方式。

public enum IdType {
    /**
     * 数据库ID自增
     * <p>该类型请确保数据库设置了 ID自增 否则无效</p>
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
     */
    NONE(1),
    /**
     * 用户输入ID
     * <p>该类型可以通过自己注册自动填充插件进行填充</p>
     */
    INPUT(2),

    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 分配ID (主键类型为number或string）,
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
     *
     * @since 3.3.0
     */
    ASSIGN_ID(3),
    /**
     * 分配UUID (主键类型为 string)
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
     */
    ASSIGN_UUID(4);

    private final int key;

    IdType(int key) {
        this.key = key;
    }
}

自动填充

创建时间、修改时间~这些操作都应该是自动完成，不希望手动更新！

方式一：数据库级别

方式二：代码级别

1、添加createTime和updateTime字段，添加 @TableField(fill = FieldFill.INSERT)

@TableField(fill = FieldFill.INSERT)
private Date createTime;    
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

2、添加处理时间的组件

package com.wl.mybatis_plus.handler;

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

import java.util.Date;

@Component
public class MyMetaHandler implements MetaObjectHandler {
    //插入时自动填充数据
    @Override
    public void insertFill(MetaObject metaObject) {
        setFieldValByName("createTime",new Date(),metaObject);
        setFieldValByName("updateTime",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        setFieldValByName("updateTime",new Date(),metaObject);
    }
}

乐观锁

乐观锁：顾名思义十分乐观，总是认为不会出现问题，无论干什么都不去上锁！，如果出现问题，再次更新值测试
悲观锁：顾名思义非常悲观，总是认为总会出问题，无论干什么都会上锁!再去操作！

乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

实现乐观锁的步骤

1、数据表中添加version字段，默认设置初始版本号1

2、在实体类中添加version，并添加@version注解

@Version
private Integer version;

3、配置插件

springboot 注解配置方式

package com.wl.mybatis_plus.config;

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

//开启事务自动管理
@EnableTransactionManagement
@MapperScan("com.wl.mybatis_plus.mapper")
@Configuration
public class MyBatisConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

spirng xml配置方式

<bean class="com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor" id="optimisticLockerInnerInterceptor"/>

<bean id="mybatisPlusInterceptor" class="com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor">
    <property name="interceptors">
        <list>
            <ref bean="optimisticLockerInnerInterceptor"/>
        </list>
    </property>
</bean>

4、测试，加上乐观锁后会在sql后面拼上version字段

    @Test
    void testUpdate() {
        User user = userMapper.selectById(1);
        user.setName("mary");
        user.setAge(28);
        userMapper.updateById(user);
    }

分页查询

1、配置分页插件

//配置分页插件
@Bean
public MybatisPlusInterceptor  paginationInterceptor() {

   MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }

2、测试分页

@Test
void testPagination(){
    Page<User> page= new Page<>(1,3);
    userMapper.selectPage(page,null);
    System.out.println(page.getRecords());
    System.out.println(page.getTotal());
}

逻辑删除

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

逻辑删除：数据库中没有真正移除，而是通过一个属性让它失效 deleted 0/1

1、在数据表中添加deleted字段，默认为0

2、在实体类中添加deleted属性，并添加@TableLogic注解

@TableLogic
private Integer deleted;

3、添加插件，新版已不需要配置插件

4、在配置文件中添加注解

mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

5、测试，实际执行的是update操作

@Test
void testDelete(){
    userMapper.deleteById(1);
}

@Test
void testSelectById(){
   User user = userMapper.selectById(1);
   System.out.println(user);
}

性能分析插件

作用：打印sql执行时间，找出慢sql

新版已去掉通过插件的方式，改用添加配置的方式

1、pom.xml引入依赖

 <dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.1</version>
</dependency>

2、在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

3、修改application.properties数据源配置

spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serveTimezone=GMT%2B8

4、测试

sql性能分析是比较耗性能的，所以一般在测试环境中使用

条件构造器

wrapper，参考官网

代码生成器

3.5.1以下版本使用如下

1、在pom.xml中添加依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>

</dependency>

2、在一个java类中编写生成代码

package com.wl.mybatis_plus;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
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.NamingStrategy;
import com.mysql.cj.jdbc.Driver;

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

public class MyCodeGenerator {

    public static void main(String[] args) {
//        创建代码生成器对象
        AutoGenerator generator = new AutoGenerator();
//        1、创建全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setAuthor("sunshey");
        globalConfig.setActiveRecord(true);
        globalConfig.setIdType(IdType.AUTO);
        globalConfig.setOpen(false);//设置生成后是否打开目录
        String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath + "/src/main/java");


        generator.setGlobalConfig(globalConfig);
//        2、设置数据源
        DataSourceConfig sourceConfig = new DataSourceConfig();
//        Driver
        sourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        sourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serveTimezone=GMT%2B8");
        sourceConfig.setUsername("root");
        sourceConfig.setPassword("123456");
//        sourceConfig.setDbType(DbType.DB2);

        generator.setDataSource(sourceConfig);

        //3、 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("user");
        pc.setParent("com.wl");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setController("controller");
        pc.setService("service");

        generator.setPackageInfo(pc);

//        4、设置策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
//        strategy.setRestControllerStyle(true);
        // 公共父类
//        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
//        strategy.setSuperEntityColumns("id");
        strategy.setInclude("user"); //设置关联的表名
        strategy.setControllerMappingHyphenStyle(true);
//        strategy.setTablePrefix(pc.getModuleName() + "_");
        strategy.setLogicDeleteFieldName("deleted");
        strategy.setVersionFieldName("version");
        TableFill createFill= new TableFill("create_time", FieldFill.INSERT);
        TableFill updateFill= new TableFill("update_time", FieldFill.INSERT_UPDATE);
        List<TableFill> fillList= new ArrayList<>();
        fillList.add(createFill);
        fillList.add(updateFill);
        strategy.setTableFillList(fillList);
        generator.setStrategy(strategy);
        generator.execute();
    }
}