Mybatis-Plus入门

Mybatis-Plus

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

特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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. 导入对应的依赖
  2. 研究依赖如何配置
  3. 代码如何编写
  4. 提高···

步骤

  1. 创建数据库mybatis_plus

  2. 创建User表,插入数据

    CREATE DATABASE mybatis_plus
    
    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');
    
  3. 创建Springboot项目,初始化

  4. 添加相应依赖

    <!--mysql-->
    <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>
    
  5. 使用配置文件配置数据库连接

    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    #注意,mysql5 的driver为:com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&userUnicode=true&characterEncoding=utf-8
    spring.datasource.username=root
    spring.datasource.password=cxy0920.
    
  6. 编写pojo

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

    编写mapper接口

    //在对应的mapper接口上继承BaseMapper,其中的范型代表返回的对象类型
    @Repository//注册到Spring管理,@Repository代表持久层
    public interface UserMapper extends BaseMapper<User> {
        //现在基本的CRUD已经完成,不需要再编写UserMapper.xml
    }
    

    在启动类配置mapper扫描注解@MapperScan("com.zhiyu.mapper")

    //扫描mapper包,以便Spring接管mapper接口
    @MapperScan("com.zhiyu.mapper")
    @SpringBootApplication
    public class MybatisPlusStudyApplication {
        public static void main(String[] args) {
            SpringApplication.run(MybatisPlusStudyApplication.class, args);
        }
    }
    
  7. 开始测试

    @SpringBootTest
    class MybatisPlusStudyApplicationTests {
        @Autowired
        UserMapper userMapper;//自动注入
        @Test
        void contextLoads() {
            //userMapper.selectList();参数是一个wrapper,构造器,
            // 代表查询条件,null代表没有条件,即查询全部
            List<User> userList = userMapper.selectList(null);
            for (User user : userList) {
                System.out.println(user);
            }
        }
    }
    

配置日志

在application.properties中配置

#日志实现
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

日志将会输出在控制台

image-20200522103505933

CRUD扩展

插入操作

Insert测试

@Test
public void testInsert(){
    User user = new User();
    user.setName("知雨");
    user.setAge(18);//没有给user对象设置id属性
    user.setEmail("1210240296@qq.com");

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

image-20200522110049473

在上面的代码中,插入user对象时并没有设置id属性,但是执行后通过日志发现,id属性被填充了

主键生成策略

(参考链接)

默认全局唯一id方案:ID_WORKER

public class User {
    @TableId(type = IdType.ID_WORKER)
    private Long id;

雪花算法:

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

主键自增:AUTO

如何实现

  1. 在id字段添加注解@TableId(type = IdType.AUTO)

  2. 在数据库中设置主键自动增长

    image-20200522111645619

插入测试:

image-20200522112314234

可以看到更改了主键生成策略为主键自增后,第二次插入时id自动增长1

主键生成策略为auto时的坑

主键生成策略为auto时的坑。理论上说设置生成策略为auto时,MybatisPlus会根据数据库自己的生成策略自动生成id,也就是自动增长。但是在数据库中有原本的数据时,有可能出现无法根据原有数据id自增,而是自己生成长id,再自增。

解决方案:关闭idea和数据库的连接,重新连接。

其余策略解释

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

更新操作

更新测试

测试1

@Test
public void testUpdate(){
    User user = new User();
    user.setId(5l);
    user.setName("小小雨");
    //注意:虽然方法名为updateById 但传入参数为user对象
    int i = userMapper.updateById(user);
}

image-20200522115927789

测试2

@Test
public void testUpdate(){
    User user = new User();
    user.setId(1l);
    user.setName("小雨");
    user.setAge(18);
    //注意:虽然方法名为updateById 但传入参数为user对象
    int i = userMapper.updateById(user);
}

image-20200522120100984

注意:两次测试中执行的sql语句不同,可以根据传入对象中的属性动态拼接sql

注意:对象中的属性类型必须和数据库中一致,否则无法识别完成动态sql

(坑:这里一开始age属性我设置为int属性,则无法实现动态sql)

image-20200522120409596

自动填充

创建时间、修改时间,自动完成

方式一:数据库级别

  1. 在数据库表中添加对应字段create_timeupdate_time

    update_time字段选中更新,两个字段都设置默认值为当前时间

    image-20200522124615161

  2. 将实体类中属性同步,添加上面两个属性(实体类驼峰命名对应数据库'_')

    private Date createTime;
    private Date updateTime;
    

再次执行insert 和 update方法

image-20200522125707626

方式二:代码级别

  1. 去掉数据库中两个字段的默认值和update_time的更新

    image-20200522130022328

  2. 在实体类对应属性上添加注解

    @TableField(fill = FieldFill.INSERT)//fill:填充字段,INSERT:在插入时填充
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)//INSERT_UPDATE:在插入和更新时填充
    private Date updateTime;
    
  3. 编写一个自定义的handle类用来实现字段填充

@Component//将该类交给Spring管理,注意!!不要忘记
public class MyHandler implements MetaObjectHandler {//实现MetaObjectHandler接口
    @Override
    public void insertFill(MetaObject metaObject) {//插入时的填充
        //setFieldValByName的三个参数,要填充的字段属性名,填充的数据,固定的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);
    }
}
  1. 执行insert测试方法,得到结果

    image-20200522132842759

坑:这里时间出现了错误,但是分钟数和秒数正确,推测为时区问题

由于这里生成时间使用的是Java的Date类,基本不会出现失去错误,查看日志验证了这一点

image-20200522133147386

由于我使用的为mysql8,则必须要在jdbc:url中设置时区serverTimezone

spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&userUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8

GMT%2B8代表东8区

添加时区设置后再测执行insert操作,时间正常

image-20200522133830689

  1. 执行更新测试,update_time字段已经被更新,而create_time字段保持不变

    image-20200522134225577

乐观锁

乐观锁与悲观锁

乐观锁实现方式:

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

测试MybatisPlus的乐观锁插件

  1. 给数据库中添加version字段

    image-20200522135921906

  2. 在实体类中同步该字段,并添加乐观锁注解

    @Version//乐观锁version注解
    private Integer version;
    
  3. 注册组件,编写一个mybatisPlus的配置类

    @Configuration//注册成为配置类
    @MapperScan("com.zhiyu.mapper")//将mapper扫描交由配置类
    @EnableTransactionManagement//开启事务管理(默认开启)
    public class MybatisPlusConfig {
        //注册乐观锁插件
        @Bean
        public OptimisticLockerInterceptor optimisticLockerInterceptor() {
            return new OptimisticLockerInterceptor();
        }
    }
    

    这里的@MapperScan("com.zhiyu.mapper")本来是由主配置类管理,现在有了mabatis配置类,可以将此配置交给mybatis配置类管理,提高代码可读性

官方提示:

特别说明:

  • 支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
  • 整数类型下 newVersion = oldVersion + 1
  • newVersion 会回写到 entity
  • 仅支持 updateById(id)update(entity, wrapper) 方法
  • update(entity, wrapper) 方法下, wrapper 不能复用!!!
  1. 测试乐观锁成功情况

    @Test
    public void testVersion(){//测试乐观锁
        //查询信息
        User user = userMapper.selectById(1l);
        //修改信息
        user.setName("乐观锁");
        //执行更新
        userMapper.updateById(user);
    }
    

image-20200522142324798

这里可以看到更新语句时加入了version查询,并且数据自动+1更新为2

image-20200522143717329

  1. 测试乐观锁失败情况

    @Test
    public void testVersion2(){//测试乐观锁失败情况
        User user = userMapper.selectById(1l);
        user.setName("乐观锁1");
    
        User user2 = userMapper.selectById(1l);
        user2.setName("乐观锁2");
        userMapper.updateById(user2);//抢先更新
    
        userMapper.updateById(user);//如果没有乐观锁,则数据被覆盖
    }
    

image-20200522144344873

可以看到第二次的update操作没有执行成功

image-20200522144441360

查询操作

  1. 单个查询

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

    image-20200522152916213

  2. 多个查询

    @Test
    public void testSelect2(){//测试多个查询
        //selectBatchIds()方法需要传入一个集合Collection
        List<User> userList = userMapper.selectBatchIds(Arrays.asList(1l, 2l, 3l));
        System.out.println(userList);
    }
    

    image-20200522153228369

  3. 条件查询

    @Test
    public void testSelect3(){//条件查询
        HashMap<String, Object> map = new HashMap<>();//注意集合的键值类型
        map.put("name","知雨");//放入查询条件
        List<User> userList = userMapper.selectByMap(map);//需要传入一个map集合
        userList.forEach(System.out::println);
    }
    

    image-20200522153834583

@Test
public void testSelect3(){//条件查询
    HashMap<String, Object> map = new HashMap<>();//注意集合的键值类型
    map.put("name","知雨");//自定义放入查询条件
    map.put("age",18);//当然是可以放入多个条件
    List<User> userList = userMapper.selectByMap(map);//需要传入一个map集合
    userList.forEach(System.out::println);
}

image-20200522154041045

分页查询

  1. 原始的limit进行分页
  2. pageHelper第三方插件
  3. MybatisPlus内置了分页插件

如何使用MybatisPlus的分页

  1. 在mybatis的配置类中配置分页拦截器组件

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
    
  2. 分页查询测试

    @Test
    public void testPage(){
        Page<User> page = new Page<>(1,2);//实例化一个page对象,并将实体类user传入
        userMapper.selectPage(page,null);
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());//获取总的数据行数
    }
    

    image-20200522202958100

删除操作

直接测试

@Test
public void testDelete(){
    int i = userMapper.deleteById(1l);//通过id删除
    
    HashMap<String, Object> map = new HashMap<>();//通过map集合条件删除
    map.put("name","知雨");
    userMapper.deleteByMap(map);
    
    userMapper.deleteBatchIds(Arrays.asList(1,2,3));//通过id批量删除
}

过于顺利简单,不贴图了

逻辑删除

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

逻辑删除 :没有直接从数据库中移除数据,而是通过一个变量,使正常查询查询不到 delete=0 => delete=1

实际应用例如:

管理员可以看见被删除的记录

回收站

实现方法:

1、在数据库中增加一个deleted字段,默认值为0

image-20200522205109171

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

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

3、其他配置

  • 在mp 3.3.0以后的版本不在需要配置Bean组件

    @Bean//注册逻辑删除插件
    public ISqlInjector iSqlInjector(){
        return new LogicSqlInjector();
    }
    
  • application.yml 加入配置(如果你的默认值和mp默认的一样,该配置可无):

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  #全局逻辑删除字段值 3.3.0开始支持,详情看下面。
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
  • 全局逻辑删除: begin 3.3.0

    如果公司代码比较规范,比如统一了全局都是flag为逻辑删除字段。

    使用此配置则不需要在实体类上添加 @TableLogic。

    但如果实体类上有 @TableLogic 则以实体上的为准,忽略全局。 即先查找注解再查找全局,都没有则此表没有逻辑删除。

4、删除测试

删除方法同正常删除一样

结果:

image-20200522210855675

可以从日志看到,逻辑删除实际上执行的是update操作

image-20200522211008026

数据库中这条记录存在

数据库中的deleted字段被更新为1,代表已被逻辑删除

5、测试查询被逻辑删除的记录image-20200522211617210

可以看到查询条件已经改变,带上了deleted字段查询,因此是查不到的

性能分析插件

在工作中很可能遇到一些慢sql,如何找到它们?

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

MybatisPlus也提供性能分析插件,如果超过这个时间就抛出异常

1、导入插件==(该功能3.2.0已移除)==

/**
 * SQL执行效率插件。该功能3.2.0已移除
 */
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor interceptor = new PerformanceInterceptor();
    interceptor.setMaxTime(1);//设置超时时间
    interceptor.setFormat(true);//设置sql格式化,默认为false
    return interceptor;
}

2、在application.properties中设置环境为dev

spring.profiles.active=dev

3、执行一条sql,由于设置的超时时间为1ms,则一定会超时

image-20200522213402297

image-20200522213452782

条件构造器

重点:wrapper

可以使用wrapper写一些复杂sql

image-20200522215028203

查询1:复合条件查询

@Test
public void text1() {//复杂查询
    //查询name不为空,email不为空,age大于12
    QueryWrapper<User> wrapper = new QueryWrapper<>();//别忘了设置范型为User
    wrapper
            .isNotNull("name")
            .isNotNull("email")
            .ge("age",12);
    List<User> userList = userMapper.selectList(wrapper);
    userList.forEach(System.out::println);
}
image-20200522220228896

查询2:单个查询

@Test
public void test2() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","知雨");
    User user = userMapper.selectOne(wrapper);//查询一个
}

查询结果:

image-20200522221007450

注意:此方法只能查询一行,如果有多行符合条件就会抛出异常

image-20200522220857772

查询3:区间查询

@Test
public void test3() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,30);//区间
    Integer count = userMapper.selectCount(wrapper);//查询满足条件的行数
    System.out.println(count);
}
image-20200522221547129

查询4:模糊查询

@Test
public void test4() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
            .notLike("name","t")//name中不包含t
            .likeRight("email","1");//email中最右边为1,也就是以1开头
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}
image-20200522222152592

查询5:嵌套sql

@Test
public void test5() {//嵌套sql
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id","select id from user where id >3 ");
    List<Object> list = userMapper.selectObjs(wrapper);
    list.forEach(System.out::println);
}
image-20200522222750434

查询6:排序查询

@Test
public void test6() {//id降序查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.orderByDesc("id");
    List<User> list = userMapper.selectList(wrapper);
    list.forEach(System.out::println);
}
image-20200522223022638

代码自动生成器

官网教程

逆向工程··