MyBatisPlus快速入门

标签：mapper MyBatisPlus 入门 com id user import 快速 public

MyBatisPlus

需要的基础：

• MyBatis
• Spring
• SpringMVC

一. MyBatisPlus概述

1.介绍 

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

2.特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

3.框架结构 

 总结：扫描实体类型,分析数据库的表和字段直接把sql注入到mybatis的容器中不用写sql

(不用写mapper.xml 秀儿))，简化了mybatis的开发。

二.快速入门

创建一个数据库

create database mybatis_plus;

use mybatis_plus;

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

)engine=innodb;

INSERT INTO USER (id, NAME, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

如果从零开始用 MyBatis-Plus 来实现该表的增删改查我们需要做什么呢？ 

• 导入对应的依赖

• 研究依赖如何配置

• 代码如何编写

• 提高扩展技术能力

创建一个空的 Spring Boot 工程（工程将以 H2 作为默认数据库进行演示）

导入依赖，引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、h2 依赖：

    <dependencies>
        <!--    数据库驱动    -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--    lombok    -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--    springboot    -->
        <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>
        <!--    mybatis-plus  版本很重要3.0.5    -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
        <!--    h2    -->
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
    </dependencies>

说明：我们使用 mybatis-plus 可以节省我们大量的代码，尽量不要同时导入 mybatis 和 mybatis plus！版本的差异

连接数据库！这一步和 mybatis 相同！

# 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

传统方式pojo-dao（连接mybatis，配置mapper.xml文件）-service-controller，使用了mybatis-plus 之后：

• pojo

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

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

• mapper接口

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

@Repository // 持久层
public interface UserMapper extends BaseMapper<User> {
    // 无需添加CRUD操作
}

• 在 Spring Boot 启动类中添加 @MapperScan 注解，扫描Mapper包下的所有接口：

@SpringBootApplication
@MapperScan("com.example.demo.mapper")
public class DemoApplication {

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

}

• 测试类中测试：

@SpringBootTest
class Mybatisplus01ApplicationTests {

    //  继承了 BaseMapper ，所有的方法都来自己父类
    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        // 参数是一个wrapper，条件是构造器，先使用null
        // 查询全部用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

提示：UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件。

思考问题：

1. sql谁帮我们写的?—mybatis-plus
2. 方法谁帮我们写的?—mybatis-plus

三.配置日志 

 所有的sql现在是不可见的，如果我想知道它是怎么执行的，所以我必须要看日志！

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

四.CRUD

 1.插入操作

    @Test
    public void insertTest(){
        User user = new User();
        user.setName("frank");
        user.setAge(22);
        user.setEmail("[email protected]");
        // 自动生成id
        Integer insert = mapper.insert(user);
        // 受影响的行数
        System.out.println(insert);
        // 通过日志发现id会自动回填
        System.out.println(user);
    }

数据库插入的id的默认值为:全局的唯—id

2.主键生成策略 

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private String email;
    private Integer age;
}

public enum IdType {
    AUTO(0),	// 数据库id自增
    NONE(1),	// 未设置主键
    INPUT(2),	// 手动输入
    ID_WORKER(3),	// 默认的全局唯一id
    UUID(4),	// 全局唯一id uuid
    ID_WORKER_STR(5);	// ID_WORKER 字符串表示法
}

默认 ID_WORKER 全局唯一id

• 分布式系统唯一id生成：查看博客园
• 分布式id生成算法的有很多种，Twitter的SnowFlake就是其中经典的一种。

雪花算法：

• snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。SnowFlake算法生成id的结果是一个64bit大小的整数。
• 其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！

 

算法实现：

Twitter官方给出的算法实现 是用Scala写的，这里不做分析，可自行查看。

Java版算法实现：搬运自犀牛饲养员

主键自增

实体类字段上 @TableId(type = IdType.AUTO)

数据库字段一定要是自增！

3.更新操作 

 // 更新操作
    @Test
    public void UpdateTest(){
        User user = new User();
        // 通过条件自动拼接SQL
        user.setId(6L);
        user.setName("frank");
        user.setAge(26);
        // 注意：updateById的参数是一个对象！
        Integer i = mapper.updateById(user);
        System.out.println(i);
    }

• 所有的sql都是自动帮我们动态配置的！

 4.自动填充

创建时间、更改时间！ 这些操作一般都是自动化完成，我们不希望手动更新。

阿里巴巴开发手册︰几乎所有的表都要配置 gmt_create、gmt_modified ！而且需要自动化。

方式一：数据库级别（工作中不允许修改数据库级别）

在表中增加字段：create_time,update_time

 再次测试插入或更新方法，需要在实体类中同步

private Date createTime; // 驼峰命名
private Date updateTime;

查看结果

方式二：代码级别 

删除数据库的默认值，更新操作！

 实体类字段属性上需要增加注解

@TableField(fill = FieldFill.INSERT)
private Date createTime;   // 驼峰命名
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

public enum FieldFill {
    DEFAULT,
    INSERT,
    UPDATE,
    INSERT_UPDATE;

编写处理器来处理这个注解即可！

package com.example.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;

@Slf4j  // 日志
@Component  // 不要忘记把处理器加到IOC容器中！
public class MyMetaObjectHandler implements MetaObjectHandler {
    // 插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill......");
//         setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        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);
    }
}

测试插入/更新，观察时间

5.乐观锁和悲观锁

乐观锁：顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不上锁!如果出现了问题,再次更新值测试。

悲观锁：顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!

 这里主要讲解：乐观锁机制!

乐观锁实现方式:

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

乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "哇哈哈", version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成，这个时候 version = 2，会导致 A 修改失败！
update user set name = "哇哈哈", version = version + 1
where id = 2 and version = 1

测试一下Mybatis-Plus乐观锁插件 

给数据库中增加version字段

实体类加对应的字段

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

 注册组件

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

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

测试一下：

    // 测试乐观锁
    @Test
    public void testOptimisticLocker(){
        // 1.查询用户信息
        User user = mapper.selectById(1L);
        // 2.修改用户信息
        user.setName("");
        user.setEmail("[email protected]");
        // 3.执行更新操作
        mapper.updateById(user);
    }

    // 测试乐观锁失败！多线程下
    @Test
    public void testOptimisticLocker2(){
        // 线程 1
        User user = mapper.selectById(1L);
        user.setName("one");
        user.setEmail("[email protected]");
        // 模拟另外一个线程执行了插队操作
        User user2 = mapper.selectById(1L);
        user2.setName("two");
        user2.setEmail("[email protected]");
        mapper.updateById(user2);
        // 自旋锁来多次尝试提交！
        mapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！
    }

6.查询操作

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

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

    // 按条件查询之一使用map操作
    @Test
    public void SelectByBatchIds(){
        HashMap<String, Object> map = new HashMap<>();
        // 自定义查询
        map.put("name","frank");
        map.put("age",22);

        List<User> users = mapper.selectByMap(map);
        users.forEach(System.out::println);
    }

7.分页查询

分页在网站使用的十分之多！

1. 原始的 limit 进行分页
2. pageHelper 第三方插件
3. MP 其实也内置了分页插件！

具体使用：

配置拦截器组件即可！

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

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

}

直接使用Page对象即可！

    // 分页查询
    @Test
    public void testPage(){
        // 参数一 current：当前页   
        // 参数二 size：页面大小
        // 使用了分页插件之后，所有的分页操作都变得简单了
        Page<User> page = new Page<>(2,3);
        mapper.selectPage(page,null);
        page.getRecords().forEach(System.out::println);
        System.out.println("总页数==>"+page.getTotal());
    }

8.删除操作

    // 基本删除操作
    @Test
    public void DeleteTest(){
       mapper.deleteById( 1811659380471390210L);
    }

    // 通过id批量删除
    @Test
    public void DeleteByIdTest(){
       mapper.deleteBatchIds(Arrays.asList(14993819200199L,6));
    }

    // 通过Map删除
    @Test
    public void DeleteMapTest(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","frank");
        mapper.deleteByMap(map);
    }

9.逻辑删除

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

逻辑删除 ：再数据库中没有被移除，而是通过一个变量来让他失效！ 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。测试！ druid,,,,,
• 作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间
• MP也提供性能分析插件，如果超过这个时间就停止运行！

导入插件

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

注意：要在SpringBoot中配置环境为dev或者 test 环境

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

测试一下！

    @Test
    void contextLoads() {
        // 参数是一个wrapper，条件是构造器，先使用null
        // 查询全部用户
        List<User> users = mapper.selectList(null);
        users.forEach(System.out::println);
    }

六.条件构造器Wrapper

 

 测试一

    @Test
    void contextLoads2() {
        // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12);
      mapper.selectList(wrapper).forEach(System.out::println); // 与map对比一下
    }

测试二

    @Test
    void test2(){
        // 查询名字Jack
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","Lisa");
        User user = mapper.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 = mapper.selectCount(wrapper); // 查询结果数
        System.out.println(count);
    }

测试四

    // 模糊查询
    @Test
    void test4(){
        // 查询年龄在 20 ~ 30 岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 左和右 t%
        wrapper
                .notLike("name","o")
                .likeRight("email","t");
        List<Map<String, Object>> maps = mapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

测试五

    @Test
    public void testWrapper5() {
        //模糊查询
        // SELECT id,name,age,email,version,deleted,create_time,update_time
        // FROM user
        // WHERE deleted=0 AND id IN
        // (select id from user where id<5)
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // id 在子查询中查出来
        wrapper.inSql("id","select id from user where id<5");
        List<Object> objects = mapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

测试六

    @Test
    public void testWrapper6() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 通过id进行降序排序
        wrapper.orderByDesc("id");
        List<User> userList = mapper.selectList(wrapper);
        userList.forEach(System.out::println);
    }

 

七.代码自动生成器

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

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

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 java.util.ArrayList;

/**
 * 代码自动生成器
 * @author base
 */
public class WskCode {
    public static void main(String[] args) {
        // 构建一个代码生成器对象
        AutoGenerator mpg = new AutoGenerator();
        // 如何去执行，配置策略
        // 1、全局配置
        GlobalConfig gc = new GlobalConfig();
        // 获取当前目录
        String projectPath = System.getProperty("user.dir");
        // 输出到哪个目录
        gc.setOutputDir(projectPath+"/src/main/java");
        gc.setAuthor("com");
        gc.setOpen(false);
        // 是否覆盖
        gc.setFileOverride(false);
        // 去Service的I前缀
        gc.setServiceName("%sService");
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);
        // 2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setUrl("jdbc:mysql://localhost:3306/mysql1?useSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
        // 3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("study");
        pc.setParent("com");
        pc.setEntity("pojo");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);
        // 4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 设置要映射的表名,只需改这里即可
        strategy.setInclude("db","user"); 
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 是否使用lombok开启注解
        strategy.setEntityLombokModel(true);
        strategy.setLogicDeleteFieldName("deleted");
        // 自动填充配置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtUpdate = new TableFill("gmt_update", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtUpdate);
        strategy.setTableFillList(tableFills);
        // 乐观锁配置
        strategy.setVersionFieldName("version");
        // 开启驼峰命名
        strategy.setRestControllerStyle(true);
        // localhost:8080/hello_id_2
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);
        mpg.execute(); // 执行
    }
}

标签：mapper,MyBatisPlus,入门,com,id,user,import,快速,public
From： https://blog.csdn.net/2301_76556912/article/details/140332389