MyBatis-Plus

1.简介

MybatisPlus可以节省我们大量工作时间，所有的CRUD都可以自动化完成，用来偷懒！

JPA、tk-mapper、MybatisPlus这三是相同的工具。

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

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

 

特性：

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
• 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

 
 

2.快速入门

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');
-- 真实开发中，version（乐观锁）、deleted(逻辑删除)、gmt_create、gmt_modified是必须的字段

2.创建一个空的 Spring Boot 工程，导入依赖

<!--数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus：这个starter是自己开发的，并非官方的-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version>
</dependency>

注意：尽量不要同时导入mybatis和mybatisplus，存在版本差异。

3.在idea中连接数据库

#数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=1234

#日志配置
#所有的sql现在是不可见的，我们希望知道它是怎么执行的，所以我们要看日志！
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

4.编写实体类 User.java

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

5.编写 Mapper 包下的 UserMapper接口

@Repository//代表持久层
//在mapper上面继承基本的类即可---BaseMapper
public  interface UserMapper extends BaseMapper<User> {
    //至此CRUD已经完成
    //之后需要什么别的方法可以自己写
}

6.在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@MapperScan("com.moli.mapper")

7.测试成功

@Autowired
UserMapper userMapper;
@Test
void contextLoads() {
    //所有的方法都来自于父类
    //参数是Wrapper，条件构造器，可以为null
    List list = userMapper.selectList(null);
    list.forEach(System.out::println);
}

原本的过程：pojo、dao—mapper、mapper.xml—service—controller

现在的过程：pojo、mapper

运行结果，查看日志：

 
 
 

3.CRUD扩展

insert

@Test
public void insert(){
    User user = new User();
    user.setAge(3);
    user.setEmail("qwer");
    user.setName("啦啦啦");
    int insert = userMapper.insert(user);
    System.out.println(insert);
    System.out.println(user);
}

 

主键生成

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

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

主键自增AUTO

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

• 数据库字段主键一定要是自增的！

• 再次测试插入即可

其他主键策略

//该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT),雪花算法
NONE
//用户输入ID，该类型可以通过自己注册自动填充插件进行填充，如果没有输入则id=null
INPUT
// 以下2种类型、只有当插入对象ID 为空，才自动填充。
//分配ID (主键类型为number或string）,默认实现类(雪花算法)
ASSIGN_ID
//分配UUID (主键类型为 string),默认实现类(UUID.replace("-",""))
ASSIGN_UUID

 

update

@Test
public void update(){
    User user = new User();
    //可以动态拼接sql
    user.setId(6);
    user.setName("hhh");
    user.setAge(2);
    int i = userMapper.updateById(user);
    System.out.println(i);
}

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

 

自动填充

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

阿里巴巴开发手册：所有的数据库表：gmt_create(创建时间)、gmt_modifified(修改时间)几乎所有的表都要配置上！而且需要自动化！

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

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

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

private Date createTime;
private Date updateTime;

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

方式二：代码级别

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

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

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

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

新建包handler，新建类MyMetaObjectHandler

@Slf4j//开启日志
@Component//一定不要忘记添加此注解，成为spring的组件
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入时的自动填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
       log.info("insertfill");
       //三个参数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("updatefill");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

4.测试插入和更新

 

乐观锁

• 乐观锁 : 故名思意十分乐观，它总是认为不会出现问题，无论干什么不去上锁！如果出现问题，再次更新值测试。

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

乐观锁实现方式：

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

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

-- B:此线程抢先完成，这个时候version=2，导致A线程的version不对，就会失败
update user set name="h",version=version+1
where id=2 and version=1

 

测试：

1.在数据库中添加乐观锁字段，实体类同步

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

2.配置组件

@MapperScan("com.moli.mapper")
@EnableTransactionManagement//自动管理事务注解
@Configuration//配置类
public class MyBatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

3.测试

乐观锁查询成功，单线程

@Test
public void testOptimisticLocker(){
    //1.查询用户，得到乐观锁
    User user = userMapper.selectById(6);
    //2.更改用户信息
    user.setName("p");
    //3.执行更新
    userMapper.updateById(user);
}

乐观锁查询失败，多线程

//乐观锁，多线程
@Test
public void testOptimisticLocker1(){
    //线程1
    User user = userMapper.selectById(6);
    user.setName("ee");
    //模拟线程2：插队
    User user1 = userMapper.selectById(6);
    user1.setName("g");
    userMapper.updateById(user1);
    userMapper.updateById(user);
}

执行结果：线程2更新成功，线程1更新失败；如果没有乐观锁最终结果应该时线程1的值覆盖线程2。

 

select

//查询
@Test
public void selectById(){
    User user = userMapper.selectById(1);
    System.out.println(user);
}
//批量查询
@Test
public void selectuser(){
    System.out.println(userMapper.selectBatchIds(Arrays.asList(1, 2, 3)));
}
//按条件查询之一map
@Test
public void selectmap(){
    HashMap<String,Object> map = new HashMap<>();
    map.put("name","tom");
    List list = userMapper.selectByMap(map);
    list.forEach(System.out::println);
}

 

分页查询

分页在网站上使用的相当多！

1、原始的 limit 进行分页

2、pageHelper 第三方插件

3、MP 其实也内置了分页插件

使用

1、配置分页的拦截器组件即可

//添加分页
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));

2.直接使用page对象查询

@Test
public void selectpage(){
    Page<User> page = new Page<>(2,5);
    userMapper.selectPage(page,null);
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());
}

查询结果：

 

删除

//通过id删除
@Test
public void deleteById(){
    userMapper.deleteById(750870530);
}
//通过id批量删除
@Test
public void deleteBatchById(){
    userMapper.deleteBatchIds(Arrays.asList(750870529,402714625,192983042));
}
//条件删除map
@Test
public void deletemap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","啦啦啦");
    userMapper.deleteByMap(map);
}

 

逻辑删除

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

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

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

本质：走的更新操作

 

测试：

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

2、实体类中增加属性和注解

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

3.配置文件

#逻辑删除配置
# 全局逻辑删除的实体字段名
mybatis-plus.global-config.db-config.logic-delete-field=flag
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0

4.测试

//通过id删除
@Test
public void deleteById(){
    userMapper.deleteById(96534529);
}
//查询
@Test
public void selectById(){
    User user = userMapper.selectById(96534529);
    System.out.println(user);
}

删除操作，数据库中并没有删除，但是delete值已经改变：

查询操作，查不出数据：
 

总结：

• 插入: 不作限制
• 查找: 追加 where 条件过滤掉已删除数据,且使用 wrapper.entity 生成的 where 条件会忽略该字段
• 更新: 追加 where 条件防止更新到已删除数据,且使用 wrapper.entity 生成的 where 条件会忽略该字段
• 删除: 转变为 更新

 
扩展：

执行sql分析打印：在平时的开发中，会遇到一些慢sql，我们可以进行测试， druid……把它揪出来。

MP推荐使用p6spy，详情看链接：https://baomidou.com/pages/833fab/

 

4.条件构造器wrapper

十分重要，写一些复杂的sql就可以使用它来替代！

@Autowired
UserMapper userMapper;

// 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
@Test
void select(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();//wrapper可以和map进行对比
    //wrapper时链式编程
    wrapper
            .isNotNull("name")
            .isNotNull("email")
            .ge("age",12);
    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

//名字等于g的，可以用map来做，这里使用wrapper
@Test
void selectname(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","g");
    System.out.println(userMapper.selectOne(wrapper));//只有一个数据用one，多个用list、map
}

// 查询年龄在 20 ~ 30 岁之间的用户
@Test
void selectbetween(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",10,20);
    System.out.println(userMapper.selectCount(wrapper));
}

//模糊查询，名字里带e的，email以t开头
@Test
void selectLike(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
            .notLike("name","e")
            .likeRight("email","t");//likeRight百分号在右边---t%
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

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

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

 

5.代码自动生成器

1.导入依赖：

<!--代码自动生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.2</version>
</dependency>

2.编写配置

//代码自动生成器
public class AutoGenerator {
    public static void main(String[] args) {
        List<String> tables = new ArrayList<>();
        tables.add("user");
        // 项目路径
        String projectPath = System.getProperty("user.dir");
        // 代码生成器
        FastAutoGenerator.create("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC", "root", "1234")
                // 全局配置
                .globalConfig(builder -> {
                    // 作者
                    builder.author("moli")
                            // 输出路径
                            .outputDir(projectPath + "/src/main/java")
                            // 禁止打开输出目录
                            .disableOpenDir()
                            // 开启swagger
                            .enableSwagger()
                            // 注释日期
                            .commentDate("yyyy/MM/dd HH:mm")
                            // 开启覆盖之前生成的文件
                            .fileOverride();
                })
                .packageConfig(builder -> {
                    builder.parent("com.moli")//放到这里
                            .moduleName("generator")//模块名称
                            .entity("pojo")
                            .service("service")
                            .serviceImpl("service.impl")
                            .controller("controller")
                            .mapper("mapper")
                            .xml("mapper")
                            .pathInfo(Collections.singletonMap(OutputFile.mapper, projectPath + "/src/main/resources/mapper/"));
                })
                .strategyConfig(builder -> {
                    //设置要映射的表名
                    builder.addInclude(tables)
                            // 增加过滤表前缀
                            //.addTablePrefix("t_")
                            // service策略配置
                            .serviceBuilder()
                            .formatServiceFileName("%sService")//去Service的I前缀
                            .formatServiceImplFileName("%sServiceImpl")
                            // entity策略配置
                            .entityBuilder()
                            // 数据库表映射到实体的命名策略
                            .naming(NamingStrategy.underline_to_camel)
                            // 数据库表字段映射到实体的命名策略
                            .columnNaming(NamingStrategy.no_change)
                            // 开启lombok模型
                            .enableLombok()
                            // controller策略设置
                            .controllerBuilder()
                            .formatFileName("%sController")
                            .enableRestStyle()
                            .enableHyphenStyle()
                            // mapper策略设置
                            .mapperBuilder()
                            // 生成通用的resultMap
                            .enableBaseResultMap()
                            .enableBaseColumnList()
                            .superClass(BaseMapper.class)
                            .formatMapperFileName("%sMapper")
                            .enableMapperAnnotation()
                            .formatXmlFileName("%sMapper");

                })
                // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .templateEngine(new FreemarkerTemplateEngine())
                .execute();

    }
}

3.执行结果

 

学习来源：b站狂神

https://www.bilibili.com/video/BV17E411N7KN?p=17&spm_id_from=pageDriver