MybaitsPlus笔记

MyBatisPlus

学习MyBatis-Plus之前要先学MyBatis–>Spring—>SpringMVC

为什么要学它?MyBatisPlus可以节省我们大量的时间,所有CRUD代码都可以自动完成

JPA, tk-mapper ,MyBatisPlus

总之就是偷懒用的!

1.简介

1.1Mybatisplus是什么?

官网:https://baomidou.com/

2.MybatisPlus的特性

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

2.快速入门

地址:
https://baomidou.com/guide/quick-start.html#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B

使用第三方插件:

1. 导入对应的依赖
2. 研究依赖如何配置
3. 代码如何编写
4. 提高扩展技术能力

2.1快速配置环境和需要的文件

1.创建数据库 mybatis_plus

2.创建user表

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（逻辑删除），gmt_create、gmt_modified

插入数据：

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.导入pom依赖：

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

说明：尽量不要同时导入mybaits和mybaits-plus，可能会存在版本的差异

4.在对应的Dao层继承BaseMapper接口

public interface UserDao extends BaseMapper<User> {
}

5.基本操作

userDao.selectList(null)		#查询所有
userDao.selectById(id)			#根据id查询
userDao.selectBatchIds(ids)		#根据ids(集合)批量查询
userDao.selectByMap(map)		根据条件查询   Map<String, Object>,map.put("key", value)
userDao.selectPage(page, null);	分页查询 Page<User> page = new Page<>(current,size);

6.配置文件中配置一下数据库的连接：

spring:
  datasource:
    username: root
    password: "000000"
    #?serverTimezone=UTC解决时区的报错
    url: jdbc:mysql://localhost:3306/mybaits_plus?serverTimezone=GMT%2B8&useSSL=false&useUnicode=true&characterEncoding=UTF-8&allowPublicKeyRetrieval=true
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource

传统方式：pojo-dao(连接mybatis，配置一下) 然后是service 层，controller层

使用mybatisplus后：

• pojo

  @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操作都已经基本完成了
      // 你不需要像以前的配置一大堆文件了
  }
  

可以点进去看一下BaseMapper的源码，他为我们封装了我们需要的CRUD的一些方法

• 注意点：我们需要在主启动类上去扫描我们的mapper包下的所有接口

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

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

2.2测试一下我们的CRUD

@SpringBootTest
class MybatisPlusApplicationTests {

    // 继承了BaseMapper,所有的方法都来自父类
    // 我们也可以编写自己的扩展方法
    @Autowired
    UserMapper userMapper;

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

执行结果：

2.3思考问题

1、SQL是谁帮我们写的？
答：MyBatis-Plus都写好了

2、方法哪里来的？
答：MyBatis-Plus 都写好了

2.4配置日志

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.CRUD扩展

3.1insert

@Test
public void testInsert() {
    User user = new User();
    user.setName("guoshuai");
    user.setAge(3);
    user.setEmail("guoshuai@alibaba.com");

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

数据库插入的id默认值为：全局唯一的id

主键生成策略：

分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法：

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

设置主键自增：

我们需要配置主键自增：

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

• 数据库字段上一定是自增的

• 再次测试即可

其余的源码解释

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

3.2更新操作update

//测试更新
@Test
public void testUpdate(){
    User user = new User();
    // 通过条件自动拼接动态sql
    user.setId(6L);
    user.setName("guoshuai-new");
    user.setAge(18);
    // 注意： updateById 但是参数是一个 对象
    int i = userMapper.updateById(user);
    System.out.println(i);
}

所有的sql都是自动帮你动态配置的！

自动填充

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

**阿里巴巴开发手册：**所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化！
因为我们要追踪这个表是什么时候创建，什么时候修改的

3.2.1方式一：数据库级别

1.在表中新增字段create_time,update_time(新增两列)

2.再次测试插入方法，我们需要先把实体类同步

private Date createTime;
private Date updateTime;

3.再次查看更新结果即可

3.2.2方式二：代码级别

1.删除数据库中的默认值、更新操作

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

//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;

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

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

package com.guo.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);
    }

}

3.3查询操作

直接测试查询操作：

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

// 批量查询,查询前三个用户
@Test
public void testSelectByBatchIds(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

// 按照条件查询之一使用 使用map封装
@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","Dainel");
    map.put("age","6");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

3.4分页查询

1.原始的:limit分页

2.Pagehelper第三方插件

3.mybatisplus也内置了分页插件

使用mybatisplus：

①配置拦截器组件：

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

②直接使用Page对象即可

// 测试分页查询
@Test
public void testPage(){
    // 参数一: 当前页
    // 参数二： 每个页面的内容数量
    // 使用了分页插件之后，所有的分页操作变得简单了
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page, null);

    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());
}

3.5删除操作

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

// 测试批量删除
@Test
public void testdeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1287326823914405893L,1287326823914405894L));
}

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

3.6逻辑删除

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

逻辑删除：在数据库中没有被移除，而是通过一个变量让他生效！deleted=0 --> deleted=1

管理员可以查看被删除的记录！防止数据的丢失！类似于回收站！

测试：

①在数据库表中增加一个deleted字段

②实体类中增加属性

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

③配置逻辑删除组件

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

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)

④测试删除功能

注意事项，视频课中用的是mybatisplus3.0.5版本，我这里测试的用的是3.4.0，因此不需要进行配置类的配置，直接调用即可。

这样一来虽然我们测试的是删除，但是数据实际执行的是update操作。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-SFBNHXZP-1620964956172)(C:\Users\GuoSheng\AppData\Roaming\Typora\typora-user-images\image-20210513154600617.png)]

在接下里的查询操作中，也会自动添加deleted字段的条件是否为0：

4.乐观锁

在面试过程中，我们经常会被问到乐观锁，悲观锁。

乐观锁：顾名思义，它总是认为不会出现问题，无论干什么都不去上锁！如果出现了问题，再次更新值测试！

悲观锁：顾名思义，它总是认为总是出现问题，无论干什么都上锁！再去操作！

乐观锁实现方式：

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

举个例子：

乐观锁：1.先查询获得版本号 version = 1
-- A
update user set name = "guoshuai",version = version + 1
where id = 2 and version = 1

--B
此时又有一个线程B，抢先完成的话，这时候version = 2，会导致A的修改失败
这样一来可以实现线程之间的安全，因为version这个字段被修改后就不会进行一些相关的操作了
update user set name = "guoshuai",version = version + 1
where id = 2 and version = 1

测试一下MyBatisPlus的乐观锁插件

①数据库中增加一个version字段

②需要实体类加上对应的字段

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

③注册组件

// 扫描我们的 mapper文件夹
@MapperScan("com.guo.mapper")
@EnableTransactionManagement //自动管理事务
@Configuration		//配置类
public class MyBatisPlusConfig {

    // 注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

④测试一下

    // 测试乐观锁成功案例
    @Test
    public void testVersionSuccess(){
        // 1. 查询用户信息
        User user = userMapper.selectById(1L);
        // 2. 修改用户信息
        user.setName("fan");
        user.setAge(24);
        // 3. 执行更新操作
        userMapper.updateById(user);
    }

    // 测试乐观锁失败案例!多线程下
    @Test
    public void testVersionFall(){
        // 线程1
        User user1 = userMapper.selectById(1L);
        user1.setName("guoshuai");
        user1.setAge(14);

        // 线程2
        User user2 = userMapper.selectById(1L);
        user2.setName("guoshuai222");
        user2.setAge(24);
        userMapper.updateById(user2);
        
        //自旋锁来多次尝试提交！
        userMapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值
    }
}

⑤测试结果

方法一的测试结果在执行update的时候已经把version加上了

5.性能分析插件

我们在平时的开发中，会遇到一些慢sql。解决方案：测试，或者通过druid监控…

作用：性能分析拦截器，用于输出每条SQL语句及其执行时间

MyBatisPlus也提供性能分析插件，如果超过这个时间就停止运行！

使用性能分析插件可以提高效率，新版本MP已经移除该拆件了，可以使用druid

6.条件构造器

https://baomidou.com/guide/wrapper.html#abstractwrapper

十分重要：wrapper

主要就是对wrapper进行设置条件然后用mapper来进行查询

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

1.测试一：

    @Test
    void contextloads(){
        QueryWrapper<User> wrapper =new QueryWrapper<>();

        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",13);

        userMapper.selectList(wrapper).forEach(System.out::println);
    }

2.测试二：根据姓名查询

    @Test
    void contextloads(){
        QueryWrapper<User> wrapper =new QueryWrapper<>();
        wrapper
                .eq("name","guoshuai");

        System.out.println(userMapper.selectOne(wrapper));
    }

3.测试三：查询根据区间内容查询

    @Test
    void contextloads(){
        QueryWrapper<User> wrapper =new QueryWrapper<>();
        wrapper
                .between("age",20,30);

        System.out.println(userMapper.selectCount(wrapper));
    }

4.测试四模糊查询：

    @Test
    void contextloads(){
        QueryWrapper<User> wrapper =new QueryWrapper<>();
        wrapper
                .notlike("name","e")
            	.likeRight("email","t");

        System.out.println(userMapper.selectCount(wrapper));
    }

• 例: likeRight("name", "王")—>name like '王%'

5.测试五（嵌套查询）：

    @Test
    void contextloads(){
        QueryWrapper<User> wrapper =new QueryWrapper<>();
        wrapper
                .inSql("id","select id from user where id<3");

        System.out.println(userMapper.selectCount(wrapper));
    }

6.测试六(查询排序，通过id排序)

 wrapper.orderByDesc("id");
 usermapper.selectObjs(wrapper);

7.代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity（pojo）、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
首先需要导入pom依赖：

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.0</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.31</version>
        </dependency>
        <dependency>
            <groupId>com.ibeetl</groupId>
            <artifactId>beetl</artifactId>
            <version>3.3.2.RELEASE</version>
        </dependency>

测试：(以后直接调用即可)

注意代码中会出现的问题，GlobalConfig在包中有同名类，注意不要导错类

public class GuoAutoCode {
    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("郭帅");
        //是否打开资源管理器
        gc.setOpen(false);
        // 是否覆盖
        gc.setFileOverride(false);
        //去除service的I前缀
        gc.setServiceName("%sService");

        // 去Service的I前缀
        gc.setIdType(IdType.ID_WORKER);

        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybaits_plus?serverTimezone=GMT%2B8&useSSL=false&useUnicode=true&characterEncoding=UTF-8&allowPublicKeyRetrieval=true");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("000000");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        //3、包的配置,需要生成哪些包
        PackageConfig pc = new PackageConfig();
        //只需要改实体类名字 和包名 还有 数据库配置即可
        pc.setModuleName("blog"); //设置模块名
        pc.setParent("com.guo");//放在com.guo下
        pc.setEntity("entity");//实体类
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 设置要映射的表名
        strategy.setInclude("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 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);

        //开启后链接请求变为： localhost:8080/hello_id_2
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);
        mpg.execute(); //执行
    }
}

之后直接执行main方法就可以看到新生成的文件了！