Mybatis-Plus的使用！

Mybatis-Plus

感谢B站up主【狂神说Java】原文，有学习的伙伴能够看这位up主！

1、特性

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

2、使用步骤

一、建立数据库 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, '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');
-- 真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modified

二、建立SpringBoot项目！

三、导入依赖

<!-- 数据库驱动 -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是本身开发，并不是官方的！ -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.0.5</version>
</dependency>

四、配置

# mysql 5 驱动不一样 com.mysql.jdbc.Driver
# mysql 8 驱动不一样com.mysql.cj.jdbc.Driver、须要增长时区的配置
serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?
useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

五、建实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User { 
  private Long id;
  private String name;
  private Integer age;
  private String email;
}

六、mapper接口

// 在对应的Mapper上面继承基本的类 BaseMapper
@Repository // 表明持久层
public interface UserMapper extends BaseMapper<User> { 
  // 全部的CRUD操做都已经编写完成了
  // 你不须要像之前的配置一大堆文件了！
}

七、入口类扫描dao

在主启动类上去扫描咱们的mapper包下的全部接口java

@MapperScan("com.yn.mapper")

3、配置日志

咱们全部的sql如今是不可见的，咱们但愿知道它是怎么执行的，因此咱们必需要看日志！mysql

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

配置完毕日志以后，后面的学习就须要注意这个自动生成的SQL，大家就会喜欢上 MyBatis-Plus！
spring

4、CRUD扩展

一、插入操做

@Autowired
    private UserMapper userMapper;

    @Test
    public void testInsert() { 
        User user = new User();
        user.setName("张三");
        user.setAge(23);
        user.setEmail("163.com");

        int result = userMapper.insert(user);//帮咱们自动生成id
        System.out.println(result);// 受影响的行数
        System.out.println(user);// 发现id会自动回填
    }

二、主键生成策略

在实体类字段上 @TableId(type = IdType.xxx)，一共有六种主键生成策略sql

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User { 
/* @TableId(type = IdType.AUTO) // 1.数据库id自增 注意：在数据库里字段必定要设置自增！ @TableId(type = IdType.NONE) // 2.未设置主键 @TableId(type = IdType.INPUT) // 3.手动输入 @TableId(type = IdType.ID_WORKER) // 4.默认的全局惟一id @TableId(type = IdType.UUID) // 5.全局惟一id uuid @TableId(type = IdType.ID_WORKER_STR) // 6.ID_WORKER 字符串表示法 */
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

三、更新操做

@Test
    public void testUpdate() { 
        User user = new User();
        user.setId(6L);
        user.setName("李四");
        user.setAge(29);
        user.setEmail("qq.com");

        int result = userMapper.updateById(user);
    }

四、自动填充

建立时间、修改时间！这些个操做一遍都是自动化完成的，咱们不但愿手动更新！
阿里巴巴开发手册：全部的数据库表：gmt_create、gmt_modified几乎全部的表都要配置上！并且须要自动化！
数据库

1. 方式一：数据库级别（工做中不容许你修改数据库）

在表中新增字段 create_time, update_time，
实体类同步
apache

private Date createTime;
private Date updateTime;

如下为操做后的变化

mybatis

2. 方式二：代码级别

一、删除数据库的默认值、更新操做！

多线程

二、实体类字段属性上须要增长注解app

// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)//插入的时候操做
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)//插入和更新的时候都操做
private Date updateTime

三、编写处理器来处理这个注解便可！分布式

@Slf4j
@Component//加入spring容器
public class MuMetaObjecHandler implements MetaObjectHandler { 
    // 插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) { 
    log.info("start insert fill.....");
    // setFieldValByName(String 字段名, Object 要插入的值, MetaObject meateObject);
    this.setFieldValByName("createTime",new Date(),metaObject);
    this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    // 更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) { 
        log.info("start update fill.....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

四、测试插入、更新后观察时间！

五、乐观锁

乐观锁 : 故名思意十分乐观，它老是认为不会出现问题，不管干什么不去上锁！若是出现了问题，再次更新值测试，给全部的记录加一个version
悲观锁：故名思意十分悲观，它老是认为老是出现问题，不管干什么都会上锁！再去操做！

乐观锁实现方式：

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

乐观锁：1、先查询，得到版本号 version = 1
-- A  线程
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1

-- B 线程抢先完成，这个时候 version = 2，会致使 A 修改失败！
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1

测试一下MP的乐观锁插件

一、给数据库中增长version字段！

二、实体类加对应的字段

@Version //乐观锁Version注解
private Integer version;

三、注册组件

// 扫描的 mapper 文件夹
@MapperScan("com.yn.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig { 
    // 注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() { 
        return new OptimisticLockerInterceptor();
    }
}

三、测试

// 测试乐观锁成功！
    @Test
    public void testOptimisticLocker() { 
        // 一、查询用户信息
        User user = userMapper.selectById(1L);
        // 二、修改用户信息
        user.setName("kuangshen");
        user.setEmail("24736743@qq.com");
        // 三、执行更新操做
        userMapper.updateById(user);
    }

    // 测试乐观锁失败！多线程下
    @Test
    public void testOptimisticLocker2() { 
        // 线程 1
        User user = userMapper.selectById(1L);
        user.setName("kuangshen111");
        user.setEmail("24736743@qq.com");
        // 模拟另一个线程执行了插队操做
        User user2 = userMapper.selectById(1L);
        user2.setName("kuangshen222");
        user2.setEmail("24736743@qq.com");
        userMapper.updateById(user2);

        // 自旋锁来屡次尝试提交！
        userMapper.updateById(user); // 若是没有乐观锁就会覆盖插队线程的值！
    }

六、查询操做

// 测试查询
    @Test
    public void testSelectById() { 
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    // 测试批量查询！
    @Test
    public void testSelectByBatchId() { 
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);
    }

    // 按条件查询之一使用map操做
    @Test
    public void testSelectByBatchIds() { 
        HashMap<String, Object> map = new HashMap<>();
        // 自定义要查询
        map.put("name", "狂神说Java");
        map.put("age", 3);
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

七、分页查询

1.配置拦截器组件

// 扫描的 mapper 文件夹
@MapperScan("com.yn.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig { 
    // 注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() { 
        return new OptimisticLockerInterceptor();
    }

    //分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() { 
        return new PaginationInterceptor();
    }
}

2.直接使用Page对象便可

// 测试分页查询
    @Test
    public void testPage() { 
        // 参数一：当前页
        // 参数二：页面大小
        // 使用了分页插件以后，全部的分页操做也变得简单的！
        Page<User> page = new Page<>(2, 3);
        userMapper.selectPage(page, null);
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());
    }

八、删除操做

// 测试删除
    @Test
    public void testDeleteById() { 
        userMapper.deleteById(1240620674645544965L);
    }

    // 经过id批量删除
    @Test
    public void testDeleteBatchId() { 
        userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L, 1240620674645544962L));
    }

    // 经过map删除
    @Test
    public void testDeleteMap() { 
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "狂神说Java");
        userMapper.deleteByMap(map);
    }

九、逻辑删除

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

逻辑删除：再数据库中没有被移除，而是经过一个变量来让他失效！ deleted = 0 => deleted = 1

管理员能够查看被删除的记录！防止数据的丢失，相似于回收站！

逻辑删除步骤：
一、在数据表中增长一个 deleted 字段

二、实体类中增长属性

@TableLogic //逻辑删除
    private Integer deleted;

三、配置！

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

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

三、查看！

十、性能分析插件

咱们在平时的开发中，会遇到一些慢sql。
做用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间
MP也提供性能分析插件，若是超过这个时间就中止运行！

一、导入插件

/** * * SQL执行效率插件 * */
    @Bean
    @Profile({ "dev", "test"})// 设置 dev test 环境开启，保证咱们的效率
    public PerformanceInterceptor performanceInterceptor() { 
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100); // ms设置sql执行的最大时间，若是超过了则不执行
        performanceInterceptor.setFormat(true); // 是否格式化代码
        return performanceInterceptor;
    }

记住，要在SpringBoot中配置环境为dev或者 test 环境！

#设置开发环境
spring.profiles.active=dev

二、测试使用！

@Test
    void contextLoads() { 
        // 参数是一个 Wrapper ，条件构造器，这里咱们先不用 null
        // 查询所有用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

十一、条件构造器

咱们写一些复杂的sql就可使用它来替代！

@SpringBootTest
public class WrapperTest { 

    @Autowired
    private UserMapper userMapper;

    //一、测试一，记住查看输出的SQL进行分析
    @Test
    void test1() { 
        // 查询name不为空的用户，而且邮箱不为空的用户，年龄大于等于12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age", 12);
        userMapper.selectList(wrapper).forEach(System.out::println); // 和咱们刚才学习的map对比一下
    }

    //二、测试二
    @Test
    void test2() { 
        // 查询名字狂神说
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", "狂神说");
        User user = userMapper.selectOne(wrapper); // 查询一个数据，出现多个结果使用List或者 Map
        System.out.println(user);
    }

    //三、区间查询
    @Test
    void test3() { 
        // 查询年龄在 20 ~ 30 岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age", 20, 30); // 区间
        Integer count = userMapper.selectCount(wrapper);// 查询结果数
        System.out.println(count);
    }

    //四、模糊查询
    @Test
    void test4() { 
        // 查询年龄在 20 ~ 30 岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 名字中不包含e的 和 邮箱t%
        wrapper
                .notLike("name", "e")
                .likeRight("email", "t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

    //五、模糊查询
    @Test
    void test5() { 
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // id 在子查询中查出来
        wrapper.inSql("id", "select id from user where id<3");

        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

    //排序
    @Test
    void test6() { 
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 经过id进行排序
        wrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

}

十二、代码自动生成器

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

测试：

package com.yn;

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;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;


public class Code { 

    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("王六六");//做者
        gc.setOpen(false);//是否打开资源管理器
        gc.setFileOverride(false); // 是否覆盖原来生成的
        gc.setServiceName("%sService"); // 去Service的I前缀，生成的server就没有前缀了
        gc.setIdType(IdType.ID_WORKER); //id生成策略
        gc.setDateType(DateType.ONLY_DATE);//日期的类型
        gc.setSwagger2(true);//自动配置Swagger文档
        mpg.setGlobalConfig(gc);
        //二、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
        //三、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");//模块的名字
        pc.setParent("com.yn");//放在哪一个包下
        pc.setEntity("entity");//实体类的包名字
        pc.setMapper("mapper");//dao的包字
        pc.setService("service");//server的包名
        pc.setController("controller");//controller的包名
        mpg.setPackageInfo(pc);
        //四、策略配置
        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 gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);
        // 乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);//开启驼峰命名
        strategy.setControllerMappingHyphenStyle(true); //controller中连接请求：localhost:8080/hello_id_2
        mpg.setStrategy(strategy);

        mpg.execute(); //执行
    }
}

报错的能够导一下这个包

<dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>