MyBatisPlus

1.MyBatisPlus概述

需要的基础：MyBatis、Spring、SpringMVC

为什么要学它呢？

MyBatisPlus可以节省大量的工作时间，所有的CRUD代码都快可以自动化完成

JPA、tk-mapper、MyBatisPlus

简介

是什么?MyBatis本来就是简化JDBC操作的

官网：https://baomidou.com/

MyBatisPlus简化MyBatis

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

2.快速入门

地址：https://baomidou.com/pages/226c21/#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B

使用第三方组件：

1、导入对应的依赖

2、研究依赖如何配置

3、代码如何编写

4、提高扩展技术能力

步骤

创建数据库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)
);
--真实开发环境中,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');

编写项目,初始化项目! 使用SpringBoot初始化!

导入依赖

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

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

    <!--mysql-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.25</version>
    </dependency>

    <!--lombok-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.22</version>
    </dependency>

    <!--mybatis-plus-->
    <!--mybatis-plus是自己开发的，不是官方的！-->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.3.4</version>
    </dependency>

</dependencies>

说明:我们使用mybatis-plus 可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus因为版本有差异!

连接数据库!这一步和mybatis相同!

# mysql 5 驱动不同  com.mysql.jdbc.Driver

# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver . 需要增加时区的配置 serverTimezone=GMT%2B8
spring.datasource.username=zhwroot
spring.datasource.password=zhwroot
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

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

使用了mybatis-plus之后

pojo

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;
}

mapper接口

@Repository//代表持久层
public interface UserMapper extends BaseMapper<User> {

    //所有CRUD操作都已经编写完成了
    //你不需要向以前一样配置一大堆文件了!

}

注意点:需要在主启动类MybatisPlusApplication上扫描我们Mapper包下的所有接口

@MapperScan("com.pomeloisland.mapper")

测试类中测试

@SpringBootTest
class MyBatisPlusDemoApplicationTests {

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

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

}

查询结果测试

思考问题

sql谁帮我们写—>mybatis-plus
方法谁帮我们写—>mybatisplus

3.配置日志

我们所有的sql是不可见的,我们希望知道他是怎么执行的,所以我们必须看日志!

1 2	# 配置日志 (默认控制台输出) mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

配置完日志之后你会喜欢上mybatis-plus!

4.CRUD扩展

1.插入数据

@Test
public void testInsert(){
    User user = new User();
    user.setName("pomeloisland");
    user.setAge(3);
    user.setEmail("1005297142@qq.com");
    int result = userMapper.insert(user);  //自动生成id
    System.out.println(result); //受影响的行数
    System.out.println(user); //id会自动回填
}

注意点:数据库插入的id默认值为:全局的唯一id

2.主键生成策略

默认 ID_WORKER 全局唯一id

对应数据库中的主键(uuid.自增id.雪花算法.redis.zookeeper)

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

(雪花算法😦Twitter的snowflake算法)

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

主键自增

我们需要配置主键自增:

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

数据库字段一定要是自增的

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    //对应数据库中的主键(uuid.自增id.雪花算法.redis.zookeeper)
    @TableId(type = IdType.AUTO)
    private Long id;

    private String name;

    private Integer age;

    private String email;
}

其余源码解释

public enum IdType {
    AUTO(0),// 数据库id自增
    NONE(1),// 未设置主键
    INPUT(2),// 手动输入
    ASSIGN_ID(3),
    ASSIGN_UUID(4);

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

3.更新数据

动态sql

注意:updateById()参数是一个对象!

@Test
public void testUpdate(){
    User user = new User();
    user.setName("柚屿");
    user.setId(2L);
    int i = userMapper.updateById(user);
    System.out.println(i);
}

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

4.自动填充

创建时间 . 修改时间! 这些个操作都是自动化完成的,我们不希望手动更新!

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

方式一：数据库级别(工作中不允许)

在表中新增字段 create_time , update_time
再次测试插入方法,我们需要先把实体类同步
1
2
private Date createTime;
private Date updateTime;

再次更新查看结果即可

方式二:代码级别

删除数据库默认值

实体类字段属性上添加注解

@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;

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

@Component // 一定不要忘记把处理器加到IOC容器中！
@Slf4j
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 insert fill......");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

测试插入
测试更新,观察时间即可!

5.乐观锁&悲观锁

乐观锁: 顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不去上锁!如果出现了问题,再次更新值测试

悲观锁;顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!

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

乐观锁实现方式:

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

乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "pomeloisland",version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成，这个时候version = 2，会导致 A 修改失败！
update user set name = "pomeloisland",version = version + 1
where id = 2 and version = 1

测试一下MP的乐观锁插件

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

2、实体类上加上相应的字段

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

3、注册组件

@MapperScan("com.pomeloisland.mapper")//扫描mapper文件夹
@EnableTransactionManagement
@Configuration// 配置类
public class MyBatisPlusConfig {

    //注册乐观锁插件
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

4、测试一下

成功

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

失败

//测试乐观锁失败！ 多线程下
@Test
public void testOptimisticLocker2(){
    //线程 1
    User user = userMapper.selectById(1L);
    user.setName("主角1号");
    user.setEmail("1656357263@qq.com");

    // 模拟另一个线程执行了插队操作
    User user1 = userMapper.selectById(1L);
    user1.setName("配角1号");
    user.setEmail("1656357264@qq.com");
    userMapper.updateById(user1);
    //自旋锁来多次尝试提交！
    userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！
}

6.查询操作

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

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

//按条件查询之--使用Map操作
@Test
public void testSelectBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","pomeloisland");
    map.put("age","18");

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

7.分页查询

分页查询在网站使用的十分之多！

1、原始的limit进行分页

2、pageHelper第三方插件

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

如何使用！

1、配置拦截器组件

// 旧版
@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
    // paginationInterceptor.setOverflow(false);
    // 设置最大单页限制数量，默认 500 条，-1 不受限制
    // paginationInterceptor.setLimit(500);
    // 开启 count 的 join 优化,只针对部分 left join
    paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
    return paginationInterceptor;
}

// 最新版
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
    return interceptor;
}

2、直接使用page对象即可

@Test
public void testPage(){
    // 参数1 当前页
    // 参数2 页面的大小
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page,null);

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

3、测试

8.删除操作

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

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

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

我们在工作中会遇见逻辑删除

9.逻辑删除

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

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

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

测试:

在数据表中增加一个deleted字段
实体类中增加属性
1
2
@TableLogic
private Integer deleted;

配置

# 逻辑删除
# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
mybatis-plus.global-config.db-config.logic-delete-field= flag 
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value= 0
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value= 1

走的是更新操作,不是删除操作

查询的时候会自动过滤删除的数据

以上的所有CRUD操作及其扩展,我们都必须精通掌握!会大大提好你的工作和写项目的效率

5.性能分析插件

==3.2.0之后性能分析插件被移除==

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

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

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

1、导入插件

@Bean
@Profile({"dev","test"}) //设置dev 和 test环境开启
public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    // 在工作中不允许用户等待
    performanceInterceptor.setMaxTime(1);// ms 设置sql执行的最大时间，如果超过了则不执行
    performanceInterceptor.setFormat(true);
    return performanceInterceptor;
}

记住在SpringBoot中配置环境为 dev或者test环境

application.properties中添加设置开发环境

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

2、测试使用

@Test
public void testSelectBatchId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

在这里插入图片描述

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

6.条件构造器

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

1、测试1

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

2、测试2

@Test
void test2(){
    //查询名字柚屿
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","柚屿");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}

3、测试三

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

4、测试四

//模糊查询
@Test
void test4(){
    // 查询年龄在20-30之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //左和右  1% 右  %1  左   %1%   中间
    wrapper.notLike("name","1")
        .likeRight("email","t%");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

5、测试五

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

5、测试六

@Test
void test6(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    // 通过id进行排序
    wrapper.orderByDesc("id");

    List<User> list = userMapper.selectList(wrapper);

    list.forEach(System.out::println);
}

7.代码自动生成器

dao、pojo、service、controller都给我自己去编写完成！

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

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

只需要改实体类名字和包名还有数据库配置即可

1、导入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>

2、测试

// 旧版
public class Code {
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/kuang_community? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
    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.kuang");
    pc.setEntity("entity"); pc.setMapper("mapper");
    pc.setService("service"); pc.setController("controller");
    mpg.setPackageInfo(pc);
    
    //4、策略配置
    StrategyConfig strategy = new StrategyConfig();
  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(); //执行 
    }
}

//新版
//代码自动生成器
public class Code {
    public static void main(String[] args) {
        //需要构建一个代码生成器对象
        String property = System.getProperty("user.dir");
        FastAutoGenerator.create("jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8","zhwroot","zhwroot")
                .globalConfig(builder -> {
                    builder.author("pomeloisland") //设置作者
                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已经生成的文件
                            .outputDir(property+"src/main/pomeloisland"); //指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("mapper")// 设置父包名
                            .moduleName("MyBatisPlusDemo")// 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml,"src/main/pomeloisland"));// 设置mapper生成路径
                })
                .strategyConfig(builder -> {
                    builder.addInclude("user"); // 设置需要生成的表名
                            // .addTablePrefix("t_", "c_"); 设置过滤表前缀
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();
    }
}

代码路径

Gitee：

https://gitee.com/lzjtuzhw/mybatisplus.git

Github：

https://github.com/pomeloisland/MyBatisPlus.git