Mybatis-plus 笔记

mybatis 的概述
Mybatis-plus 是一个Mybatis 的增强工具,在Mybatis 的基础只做增强不做改变,为简化开发、提高效率而生。
特性(官网的)
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速开始
数据库官网有
导入依赖

<!--        mybatis-plus 依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>
        <!--Lombok引入-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

写配置文件

#数据库的配置
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT
    username: root
    password: 123456

接口

package com.jj.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.jj.demo.pojo.User;
import org.springframework.stereotype.Repository;

/**
 * @author fjj
 * @date 2021/1/29 16:08
 */
//加入注解
    @Repository
public interface UserMapper extends BaseMapper<User> {
}

测试类

package com.jj.demo;

import com.jj.demo.mapper.UserMapper;
import com.jj.demo.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 DemoApplicationTests {
    //注入
    @Autowired
    UserMapper userMapper;

    @Test
    void contextLoads() {
//        /测试的
        List<User> list = userMapper.selectList(null);
        for (User user : list) {
            System.out.println("user = " + user);
        }
    }

}

结果
Mybatis-plus 笔记

可以看到我们接口什么也没有写,都是mybatis -plus 帮我们做的,帮我们实现了简单的crud 的操作
我们也可以配置一些日志来方便我们可以看到我sql 的过程

    #mybatis-plus 日志配置.
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

效果
Mybatis-plus 笔记
插入的
Mybatis-plus 笔记结果里有
Mybatis-plus 笔记雪花算法

snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。 其核心思想是:使用41 bit作为毫秒数, 10bit作为机器的
ID ( 5个bit是数据中心, 5个bit的机器ID ) , 12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生4096个ID ) , 最后还
有一个符号位,永远是0。可以保证几乎全球唯一!
我们也可以自己设置数据库字段主键自增
1,在实体类字段上加入@TableId(type = IdType.AUTO)
2,数据库必须也要是主键自增加
其他的解释
Mybatis-plus 笔记更新的,会自动的帮我们动态拼接sql

    @Test
    void demo2(){
        //获取实体类
        User user = new User();
        user.setId(1355076603522801665L);
        user.setAge(21);
        user.setEmail("1782579163@qq.com");
        user.setName("冯娇娇");
   //更新的
        userMapper.updateById(user);
    }

自动填充功能
我们在更新或者插入的时候可以填充一下时间
在实体类加上字段一级注解
Mybatis-plus 笔记
写自定义的策略类

package com.jj.demo.Handler;

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

import java.util.Date;

/**
 * @author fjj
 * @date 2021/1/29 20:12
 */
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入的策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("开始插入的哦!");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("开始更新的哦!");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

测试类
Mybatis-plus 笔记
乐观锁
乐观锁是相对悲观锁而言的,乐观锁假设数据一般情况下不会造成冲突,所以在数据进行提交更新的时候,才会正式对数据的冲突与否进行检测,如果发现冲突了,则返回给用户错误的信息,让用户决定如何去做。乐观锁适用于读操作多的场景,这样可以提高程序的吞吐量。
在数据库中加入字段
Mybatis-plus 笔记
在实体类加上
Mybatis-plus 笔记
写config类

package com.jj.demo.config;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * @author fjj
 * @date 2021/1/30 13:41
 */
@Configuration
@EnableTransactionManagement
public class MybatisPlusConfig {
    /**
     * 乐观锁插件
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

测试类

    @Test
    public void demo3(){
        //查询
        User user = userMapper.selectById(3L);
        System.out.println("user = " + user);
        //修改
         user.setName("AMY");
        user.setId(3L);
        user.setEmail("dddd");
        userMapper.updateById(user);
    }

查询的

    //批量查询的
    @Test
    public void demo4(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2,3));
        for (User user : users) {
            System.out.println("user = " + user);
        }
    }
    //按条件查询
    @Test
    public void demo5(){
        //获取Map
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","娇娇");
        List<User> list = userMapper.selectByMap(map);
        System.out.println("list = " + list);
    }

分页的

//分页的
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();

        return paginationInterceptor;
    }

测试类

    @Test
    public void demo6(){
        //获取page
        Page<User> userPage = new Page<>(1,2);
        IPage<User> userIPage = userMapper.selectPage(userPage, null);
        System.out.println("userIPage = " + userIPage);
        System.out.println(userPage.getClass());
    }

Mybatis-plus 笔记
删除的
简单删除

   //简单删除
    @Test
    public void demo7(){
        userMapper.deleteById(1L);
    }
    @Test
    public void demo8(){
        userMapper.deleteBatchIds(Arrays.asList(2,3));
    }
    @Test
    public void demo9(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("age","21");
        userMapper.deleteByMap(map);
    }

逻辑删除
逻辑删除其实不是真的删除
实体类

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

配置yml

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

config

    //逻辑删除的
    @Bean
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }

测试

   @Test
    public void demo7(){
        userMapper.deleteById(5L);
    }

Mybatis-plus 笔记
是更新语句而不是删除语句
Mybatis-plus 笔记
数据库变成了1
性能分析插件
配置环境
Mybatis-plus 笔记
编写config 类

    //开启SQL性能分析插件
    @Bean
    @Profile({"dev","test"})    //设置dev和test环境开启,生产不开启
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(30); //设置sql执行的最大时间,单位为毫秒。超过最大时间则为慢sql
        performanceInterceptor.setFormat(true); //是否格式化代码
        return performanceInterceptor;
    }

Mybatis-plus 笔记
代码生成器
导入依赖

      <!-- 2、MyBatis-Plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.1</version>
        </dependency>

        <!--代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.1</version>
        </dependency>

        <!--使用freemark模板引擎-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>
        <!--Lombok引入-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

代码

package com.jj;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.*;

public class 生成代码{


    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + ":");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("fjj");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.jj");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();


        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类

        // 写于父类中的公共字段

        strategy.setInclude(scanner("user").split(","));
        strategy.setControllerMappingHyphenStyle(true);

        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

上一篇:若依前后端分离版本集成Mybatis-plus


下一篇:代码模板生成