谷粒学院系列笔记之Mybatis_plus

谷粒学院系列笔记之Mybatis_plus

---

---

前言

mybatis-plus为你简化开发，少写或不写xml文件爽吗，真爽

---

一、简介

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

• 特性

1. 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，
2. 损耗小：启动既会自动注入基本CRUD，性能基本无损耗，直接面向对象操作
3. 强大的CRUD操作，更有强大的条件构造器，基本满足各类使用
4. 支持Lambda形式调用：通过Lambda表达式，方便的编写各类查询条件，无需在担心字段写错
5. 支持多种数据库：支持Mysql,MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer等多种数据库
6. 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
7. 支持XML热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML启动
8. 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
9. 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
10. 支持关键词自动转义：支持数据库关键词（order、key…）自动转义，还可自定义关键词
11. 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller层代码，支持模板引擎，更有超多自定义配置等您来使用
12. 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
13. 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
14. 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
15. 内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

二、使用步骤

快速开始参考

• 测试项目：mybatis_plus
• 数据库：mybatis_plus

1.创建并初始化数据库

• 创建数据库：mybatis_plus
• 创建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)
);


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

2.初始化工程

使用Spring Initializr 快速初始化一个 Spring Boot 工程，创建这里不再累赘。

3.添加依赖

• 引入依赖
  spring-boot-starter、spring-boot-starter-test
• 添加：mybatis-plus-boot-starter、MySQL、lombok、
• 在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写

<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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
            <!--mybatis-plus-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.0.5</version>
            </dependency>
            <!--mysql-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            <!--lombok用来简化实体类-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    </dependencies>

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring ，以避免因版本差异导致的问
题。

4.idea中lombok插件安装-我是2019版本

具体步骤:File- ->Settings(Ctr+Alt+S)- ->Plugins,然后入下图，没有装过的就点击Install然后重启，然后lombok安装大功告成

5.配置

• 在 application.properties 配置文件中添加 MySQL 数据库的相关配置

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

• 注意：driver和url的变化（8.0为分界线），上面的是8.0以上的配置文件
• 8.0以下的看下面

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=123456

说明两点：

• 这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，
  这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：
  java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or represents
  more
• 这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前
  的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

6.编写实体

• 创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

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

• Lombok使用参考

• 主类
  在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹
  注意：扫描的包名根据实际情况修改

package com.mybatisplus.mps;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.mybatisplus.mps.mapper")
public class MpsApplication {

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

}

• mapper
  创建包 mapper 编写Mapper 接口： UserMapper.java

package com.mybatisplus.mps.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mybatisplus.mps.entity.User;


/**
 * @author 晨曦
 * @date 2020/12/1 15:25
 */
public interface UserMapper extends BaseMapper<User> {
    
}

• 注意：
  IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执
  行。
  为了避免报错，可以在 dao 层 的接口上添加 @Repository 注
• 测试代码，查询所有

package com.mybatisplus.mps;

import com.mybatisplus.mps.entity.User;
import com.mybatisplus.mps.mapper.UserMapper;
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 MpsApplicationTests {

    @Autowired
    private UserMapper userMapper;
    
    @Test
    public void testSelectList(){
        System.out.println("----- 查询所有的数据 ------");
        //UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper
		//所以不填写就是无任何条件
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

-输出结果

• 通过以上几个简单的步骤，我们就实现了User表的CRUD功能，甚至都没有XML。系不系炒鸡简单呢

8.配置日志打印SQL语句

• #mybatis日志
  mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
  
• 插入操作----先上图
  

  @Test
    public void testInsert(){
        User user = new User();
        user.setName("test-1");
        user.setAge(18);
        user.setEmail("776390214@qq.com");

        int insert = userMapper.insert(user);
        System.out.println(insert); //影响的行数
        System.out.println(user);   //id自动填充
    }

注意：这里插入的id值默认为：全局唯一id

• 主键策略

1. ID_WORKER:MyBatis-Plus默认的主键策略是： ID_WORKER 全局唯一 ID参考资料：分布式系统唯一ID生成方案汇总
2. 自增策略：如果想主键自增需要配置如下主键策略

• 需要在创建数据库表的时候设置主键自增
• 实体字段中配置@TableId(type = IdType.AUTO)
• 
• 要想影响所有实体的配置，可以设置全局主键配置

#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto

• 其他主键策略，附上源码，有兴趣的可以了解下

@Getter
public enum IdType {
    /**
     * 数据库ID自增
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型
     */
    NONE(1),
    /**
     * 用户输入ID
     * 该类型可以通过自己注册自动填充插件进行填充
     */
    INPUT(2),

    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 全局唯一ID (idWorker)
     */
    ID_WORKER(3),
    /**
     * 全局唯一ID (UUID)
     */
    UUID(4),
    /**
     * 字符串全局唯一ID (idWorker 的字符串表示)
     */
    ID_WORKER_STR(5);

    private int key;

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

• 更新来波，老样子上图为敬
• 
  
• 代码也灰常简单

  @Test
    public void testUpdateById(){
        User user = new User();
        user.setId(2L); //long类型要加L
        user.setAge(200);

        int i = userMapper.updateById(user);
        System.out.println(i);
    }

9.自动填充

• 不管大小的项目经常会遇到一些数据，每次都使用相同的方式填充，如创建时间，更新时间等，在plus中我们可以使用自动填充功能，完成这些字段的复制工作：

• 数据库表中添加自动填充字段，在User表中添加datetime类型的新的字段 create_time、update_time
  

• 还要实现元对象处理器接口，不然是没办法填充的，注意：不要忘记添加@Component注解，上源码

package com.mybatisplus.mps.handler;

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

import java.util.Date;

/**
 * @author 晨曦
 * @date 2020/12/1 16:10
 */

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    private static final Logger LOGGER =
            LoggerFactory.getLogger(MyMetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        LOGGER.info("start insert fill ....");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        LOGGER.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

今天先写到这里，未完下篇见。