转载

SpringBoot整合MyBatis-Plus

MyBatis-Plus

官方网址： https://mp.baomidou.com/

简介

MyBatis-Plus （简称 MP）是一个 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

快速入门

步骤

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（乐观锁）、delete（逻辑删除）、gmt_create、gmt_modified

3、插入数据

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

4、编写项目， Spring Initializer 快速初始化一个 Spring Boot 工程

5、导入依赖

<!-- 数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

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

6、连接数据库！这一步和 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

==7、传统方式pojo-dao（连接mybatis，配置mapper.xml文件）-service-controller==

7、使用了 mybatis-plus 之后

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操作有已经编写完成了
    // 你不需要像以前配置一大堆文件了
}

@MapperScan("com.zwk.mapper")

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMybatisPlusApplicationTests {

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

    @Test
    public void contextLoads() {
        // 参数是一个 Wrapper ，条件构造器，这里我们先不用 null
        // 查询全部用户

        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
        
    }
    
}

结果

SpringBoot整合MyBatis-Plus

思考问题?

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

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

配置日志

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

开发时需要看日志，上线时需要把日志去掉，因为日志是浪费时间的！

#配置日志     这个是mybatis-plus自带的查看日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

SpringBoot整合MyBatis-Plus

配置完毕日志后，就需要注意这个自动生成的SQL，我们就会喜欢上 MyBatis-Plus ！

CRUD扩展

插入操作

Insert 插入

// 测试插入
@Test
public void testInsert(){
    User user = new User();
    user.setName("iu");
    user.setAge(18);
    user.setEmail("66668888@qq.com");

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


}

SpringBoot整合MyBatis-Plus

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

主键生成策略

默认 ID_WORKER 全局唯一id

分布式系统唯一id生成方案汇总： https://www.cnblogs.com/haoxi...

雪花算法：

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

主键自增

我们需要配置主键自增

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

2、数据库字段一定要是自增

SpringBoot整合MyBatis-Plus

3、再次测试插入即可！

其余的源码解释

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

更新操作

// 测试更新
@Test
public void testUpdate(){
    // 通过条件自动拼接动态sql
    User user = new User();
    user.setId(9L);
    user.setName("就这样吧");
    user.setAge(3);

    //  注意：updateById 但是参数是一个 对象 ！
    int i = userMapper.updateById(user);
    System.out.println(i);
}

SpringBoot整合MyBatis-Plus

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

自动填充

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

阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified 几乎所有的表都要配置上！而且需要自动化！

方式一：数据库级别(工作用不允许你修改数据库)

1、在表中新增字段 create_time, update_time

SpringBoot整合MyBatis-Plus

2、同步实体类

private Date creatTime;
private Date updateTime;

3、测试插入方法，查看更新结果

SpringBoot整合MyBatis-Plus

方式二：代码级别

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

SpringBoot整合MyBatis-Plus

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

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

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

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

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

    }
}

4、测试插入

5、测试更新、观察时间即可！

乐观锁

在面试过程中，我们经常会被问道乐观锁，悲观锁！这个其实非常简单！

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

我们这里主要讲解乐观锁机制！

乐观锁实现方式：

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

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

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

测试一下MyBatis-Plus的乐观锁插件

1、给数据库增加 verison 字段！设置默认值为1

SpringBoot整合MyBatis-Plus

2、实体类加对应的字段

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

3、注册组件

@MapperScan("com.zwk.mapper") //扫描我们的 mapper 文件夹
@EnableTransactionManagement // 开启事务（默认）
@Configuration // 配置类
public class MyBatisPlusConfig {

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

4、测试一下

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

    // 测试乐观锁失败！多线程下
    @Test
    public void testOptimisticLocker2(){

        // 线程 1
        User user = userMapper.selectById(2L);
        user.setName("mingrenyu111");
        user.setEmail("66668888@qq.com");

        // 模拟另外一个线程执行了插队操作
        User user2 = userMapper.selectById(2L);
        user2.setName("mingrenyu222");
        user2.setEmail("66668888@qq.com");
        userMapper.updateById(user2);

        // 解决思路：使用自旋锁来多次尝试提交！
        userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！
    }

SpringBoot整合MyBatis-Plus

查询操作

// 测试查询-单个
@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
}

// 测试查询-批量
@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","iu");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页在网站使用的非常多！

1、原始的 limit 进行分页

2、第三方插件 pageHelper

3、MyBatis-Plus 内置了分页插件！

如何使用！

1、配置拦截器组件即可

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

2、直接使用Page对象即可

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

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

删除操作

基本的删除操作

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

// 通过id批量删除
@Test
public void testDeleteBatchId() {
    userMapper.deleteBatchIds(Arrays.asList(1279694588429324352L, 1279694588429324353L, 1279694588429324354L));
}

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

在工作中会遇到一些问题：逻辑删除！

逻辑删除

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

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

测试一下：

1、在数据库中增加一个delete字段

SpringBoot整合MyBatis-Plus

2、实体类中增加属性

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

3、配置！

//逻辑删除组件
@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

4、测试逻辑删除

SpringBoot整合MyBatis-Plus

记录依旧在数据库，但是值确已经变化了

SpringBoot整合MyBatis-Plus

以上所有的CRUD及其扩展操作，会大大提高工作和写项目的效率！

性能分析插件

我们在平时的开发中，会遇到一些慢sql。

MyBatis-Plus也提供了性能分析插件，如果超过这个时间就报错，停止运行！

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

==注意：==该插件在3.2.0以上版本以移除，推荐使用第三方扩展执行SQL分析打印功能！

1、导入插件

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

2、配置开发环境为 dev 或者 test

开发环境（dev)：是程序猿们专门用于开发的服务器，配置可以比较随意，为了开发调试方便，一般打开全部错误报告。

测试环境(test)：一般是克隆一份生产环境的配置，一个程序在测试环境工作不正常，那么肯定不能把它发布到生产机上。

生产环境（prod）：是值正式提供对外服务的，一般会关掉错误报告，打开错误日志。

三个环境也可以说是系统开发的三个阶段：开发->测试->上线，其中生产环境也就是通常说的真实环境。

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

3、测试使用！

SpringBoot整合MyBatis-Plus

使用性能分析插件，可以帮助我们提高效率！

条件构造器

十分重要：Wrapper

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

1、测试一，记住查看输出的SQL进行分析

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

2、测试二，记住查看输出的SQL进行分析

@Test
void test2(){
    // 查询名字 鸣人语
    QueryWrapper<User> Wrapper = new QueryWrapper<>();
    Wrapper.eq("name","鸣人语");
    User user = userMapper.selectOne(Wrapper); // 查询一个数据，出现多个结果使用List 或者 Map
    System.out.println(user);
}

3、测试三，记住查看输出的SQL进行分析

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

}

4、测试四，记住查看输出的SQL进行分析

@Test
void test4(){
    // 模糊查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
            .notLike("name","e")
            .likeRight("email","t");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

5、测试五，记住查看输出的SQL进行分析

@Test
void test5() {
    // id 在子查询中查出来
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id","select id from user where id<4");
    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

6、测试六，记住查看输出的SQL进行分析

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

余下很多方法可以查看 https://mp.baomidou.com/guide...

代码生成器

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

1、添加代码生成器依赖

<!-- mybatis-plus 代码生成器的 模板引擎 -->
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
    </dependency>

2、进行配置

// 代码自动生成器
public class MyAutoGenerator {
    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); // 是否覆盖
        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/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=Hongkong");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 3、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.zwk");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        // 4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user"); // 设置要映射的表名（重要）
        //strategy.setInclude("user","user_record","user_say"); // 设置要映射的表名（重要） 生成多表！！！
        strategy.setNaming(NamingStrategy.underline_to_camel); // 下划线 转 驼峰命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true); // 自动Lombok
        strategy.setLogicDeleteFieldName("deleted");

        // 自动填充配置
        TableFill gmtCreat = new TableFill("gmt_creat", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreat);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);
        // 乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true); // Localhost:8080/hello_id_2
        mpg.setStrategy(strategy);

        mpg.execute(); // 执行
    }

}

3、测试结果如下

SpringBoot整合MyBatis-Plus