mybatis_plus

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 操作智能分析阻断，也可自定义拦截规则，预防误操作

快速入门

地址：https://baomidou.com/pages/226c21/

使用第三方组件：

1、导入对应依赖

2、研究依赖如何配置

3、代码如何编写

4、扩展

步骤

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

3、编写项目、初始化项目！使用SpringBoot初始化！

4、导入依赖

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.27</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

说明：使用mybatis-plus可以节省大量代码，尽量不要同时导入mybatis和mybatis-plus

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

# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver 需要增加时区配置 serverTimezone=GMT%2B8 （东八区）
spring.datasource.username=root
spring.datasource.password=root
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

6、传统方式 pojo-dao(连接mybatis,配置mapper.xml)-service-controller

6、使用了mybatis-plus之后

• pojo

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

• mapper

//在对应的Mapper上面继承基本的类BaseMapper
@Mapper/@Repository  //代表持久层
public interface UserMapper extends BaseMapper<User>{
    
}

• 使用
• 注意点，在Spring Boot中我们需要在主启动类上去扫描我们的mapper包下的所有接口@MapperScan("com.stone.mapper")

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

配置日志

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

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

CRUD扩展

插入操作

insert插入

    //测试插入
    @Test
    public void insertTest(){
        User user = new User();
        user.setName("stone");
        user.setAge(23);
        user.setEmail("1547320290@qq.com");
        int result  = userMapper.insert(user);
        System.out.println(result);
        System.out.println(user);
    }

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

主键生成策略

默认ID_WORKER全局唯一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。

主键自增

我们需要配置主键自增：

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

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

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 updateTest(){
        User user = new User();
        user.setId(6L);
        user.setName("疏影横斜水清浅");
        user.setAge(22);
        //注意：updateById 但是参数是一个对象！
        int rows = userMapper.updateById(user);
        System.out.println(rows);
    }

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

自动填充

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

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

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

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

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

private Data createTime;
private Data updateTime;

3、再次更新查看结果

方式二：代码级别

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

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

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

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

package com.stone.handler;

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

import java.util.Date;


@Component  //一定不要忘记把处理器加到ioc容器中
public class MyMetaObjectHandler implements MetaObjectHandler {

    //插入时填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        //MetaObjectHandler 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) {
        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 = "stone",sersion=version + 1
where id = 2 and version = 1
-- B线程抢先完成，这个时候 version = 2，会导致A修改失败！
update user set name = "stone",sersion=version + 1
where id = 2 and version = 1

测试一下MyBatisPlus的乐观锁插件

1、给数据库中增加version字段

2、我们肢体类加对应字段

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

3、注册组件

//扫描mapper文件夹
@MapperScan("com.stone.mapper")
@EnableTransactionManagement  //管理事务
@Configuration  //配置类
public class MyBatisPlusConfig {
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4、测试一下

//测试乐观锁成功
@Test
public void testOptimisticLocker(){
    //1、查询用户信息
    User user = userMapper.selectById(6L);
    //2、修改用户信息
    user.setName("test");
    user.setEmail("stone@163.com");
    //3、执行更新操作
    userMapper.updateById(user);
}
//测试乐观锁失败
@Test
public void testOptimisticLocker2(){
    //线程 1
    User user = userMapper.selectById(6L);
    user.setName("test1111");
    user.setEmail("stone@163.com");
    //模拟另一个线程执行插队操作
    User user2 = userMapper.selectById(6L);
    user2.setName("test2222");
    user2.setEmail("stone@163.com");

    userMapper.updateById(user);
    //自旋锁来多次提交
    userMapper.updateById(user2); //如果没有乐观锁就会覆盖插队线程的值
}

查询操作

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

}
//条件查询 map
@Test
public void testSelectByBatchIds(){
    Map<String ,Object> map = new HashMap<>();
    map.put("name","stone");
    map.put("age",23);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

1、原始的limit进行分页

2、pageHelper第三方插件

3、MP内置分页插件

如何使用

1、配置拦截器组件

@Bean
public PaginationInterceptor paginationInterceptor(){
    return new PaginationInterceptor();
}

2、测试分页插件

//测试分页查询
@Test
public void testPageOld(){
    //参数一：当前页
    //参数二：页面大小
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page, null);
    System.out.println(page.getPages()+"\t"+page.getCurrent()+"\t"+page.getSize()+"\t"+page.getTotal()+"\t"+page.getRecords());
}

删除操作

1、根据id删除记录

//测试删除
@Test
public void testDeleteById(){
    userMapper.deleteById(6L);
}
//通过id批量删除
@Test
public void testDeleteByBathId(){
    userMapper.deleteBatchIds(Arrays.asList(1,2,3));
}
//通过map删除
@Test
public void testDeleteByMap(){
    Map<String,Object> map = new HashMap<>();
    map.put("name","stone");
    userMapper.deleteByMap(map);
}

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

逻辑删除

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

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

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

测试一下：

1、在数据表中增加一个deleted字段

2、实体类中增加属性

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

3、配置！

@Bean
public ISqlInjector injector(){
    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、测试

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

性能分析插件

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

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

1、导入插件

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

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

2、测试使用

@Test
void contextLoads() {
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}

条件构造器

十分重要：Wrapper

我们写一些复杂的sql就可以它替代

1、测试一

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

2、测试二

@Test
void test2(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","Tom");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}

3、测试三

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

4、测试四，查看输出的sql进行分析

@Test
void test04(){
    //模糊查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //左和右 t%
    wrapper
            .notLike("name","a")
            .likeRight("email","t");
    userMapper.selectMaps(wrapper).forEach(System.out::println);
}

5、测试五 内查询

@Test
void test05(){
    //内查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id","select id from user where id>3");
    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

5、测试六 排序

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

代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、

Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

测试：

package com.stone;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
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;
// 代码自动生成器
public class stoneCode {
    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("stone");
    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=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);
    //3、包的配置
    PackageConfig pc = new PackageConfig();
    pc.setModuleName("blog");
    pc.setParent("com.kuang");
    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("blog_tags","course","links","sys_settings","user_record","
    user_say"); //多表
                        
    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); //
    localhost:8080/hello_id_2
    mpg.setStrategy(strategy);
    mpg.execute(); //执行
    }
}             

本栏目推荐文章
• Mybatis之TypeHandler使用教程
• 简单说一下mybatis的多表映射的使用
• mybatis-generator:generate生成器将另外的数据库内同名表生成
• 一些Mybatis的知识点&易错点总结
• mybatis一级缓存的实现及其问题
• Mybatis
• 提升Windows Server环境安全性：ADAudit Plus的五大关键优势
• mybatis提示com.microsoft.sqlserver.jdbc.SQLServerException: 列名 'xxxx' 无效。
• MyBatis-1
• mybatis的foreach标签初使用

mybatis_plus mybatis plusmybatis_plus mybatis_plus mybatis plus mybatis_plus mybatis crud plus mybatis_plus mybatis plus 02 mybatis-plus mybatis-plus mybatis plus mybatis plus mybatis-plus springboot mybatis mapper mybatis-plus springboot mybatis plus mybatis-plus-join