MyBatis-Plus的快速开始

今天开始接触了MyBatis-Plus，所以来简单记录下是如何使用的。

一、快速开始

1.导入依赖

 <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--lombok用来简化实体类-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

2.创建实体类

@Data
public class User {
    /*
     @TableId(type = IdType.ID_WORKER) mybatis-plus自带的id生成策略，生成19位的值，适用于数值类型的主键
     @TableId(type = IdType.ID_WORKER_STR) mybatis-plus自带的id生成策略，生成19位的值，适用于字符串类型的主键
     若是使用mybatis-plus且没有指定主键生成策略，会自动根据主键类型选择生成策略
     */
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

该实体类中使用了lembok,所以会自动生成set,get方法

3.创建dao层
因为只是先简单演示下MyBatis-Plus的用法，所以这里直接先创建DAO层，用于单元测试

package com.atguigu.mpdemo1010.mapper;

import com.atguigu.mpdemo1010.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.springframework.stereotype.Repository;

/**
 * @Author su mingxin
 * @Date 2020/9/15 11:12
 *
 * IDEA在@Autowried userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。
 * 为了避免报错，可以在 dao 层 的接口上添加 @Repository
 */
@Repository
public interface UserMapper extends BaseMapper<User> {
}

这里的DAO层接口直接继承BaseMapper,类型为User,这样，就直接可以使用MyBatis-Plus所提供的CRUD。

4.单元测试

package com.atguigu.mpdemo1010;

import com.atguigu.mpdemo1010.entity.User;
import com.atguigu.mpdemo1010.mapper.UserMapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import javax.jws.soap.SOAPBinding;
import java.util.Arrays;
import java.util.List;

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

    @Autowired
    private UserMapper userMapper;

    //查询
    @Test
    public void selectUser() {
        List<User> users = userMapper.selectList(null);
        for (User user:users){
            System.out.println(user);
        }
    }

    //添加
    @Test
    public void insertUser(){
        User user = new User();
        user.setName("岳不群");
        user.setAge(56);
        user.setEmail("Dava@qq.com");
        userMapper.insert(user);
    }

    //修改
    @Test
    public void updateUser(){
        User user = new User();
        user.setId(1305766050880610306L); //因为id是Long类型
        user.setAge(110);
        userMapper.updateById(user);
    }

    //删除
    @Test
    public void deleteUser(){
        userMapper.deleteById(1305787376383143938L);
    }
}

5.数据库


image.png

二、自动填充

当我们在插入或修改一条数据时，某种情境下，我们可能希望在插入或修改之后，能够自动往数据库中填充该条记录的创建或修改时间。

此时有两种常用的方法：
1.在进行insert或update前，手动set记录的创建或修改时间

user.setCreateTime(new Data());
user.setUpdateTime(new Data());

2.若你使用了mybatis-plus，我们就可以使用其提供的自动填充功能。
首先，在实体类中添加相应字段，并添加@TableField注解

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;

    //该注解为mybatis-plus的自动填充（与MetaObjectHandler配合使用）
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

然后，创建一个handler，设置自动填充的内容和和填充字段

/**
 * @Author su mingxin
 * @Date 2020/9/15 15:03
 * 该类实现MetaObjectHandler接口，设置createTime和updateTime的值，用于在添加或修改操作时进行自动填充
 * 不要忘记@Component注解，将该类交给spring管理
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    //使用mybatis-plus进行insert操作时才会起作用
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
    //使用mybatis-plus进行update操作时才会起作用
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

这样，我们在新添加一条记录或者修改一条记录时，就会往数据库中自动填充创建时间或修改时间。
若想自动填充其他字段，也可这样设置。

三、乐观锁

乐观锁我在这里就不多说了。MyBatis-Plus也为我们提供了乐观锁。
1.往表中添加一个version属性，目的是为了对记录的修改操作进行控制。当多人同时对同一记录进行操作时，若version不对，则不允许修改。

image.png

2.往实体类中添加version属性，并添加@Version注解

@Data
public class User {
    /*
     @TableId(type = IdType.ID_WORKER) mybatis-plus自带的id生成策略，生成19位的值，适用于数值类型的主键
     @TableId(type = IdType.ID_WORKER_STR) mybatis-plus自带的id生成策略，生成19位的值，适用于字符串类型的主键
     若是使用mybatis-plus且没有指定主键生成策略，会自动根据主键类型选择生成策略
     */
    private Long id;
    private String name;
    private Integer age;
    private String email;

    //该注解为mybatis-plus的自动填充（与MetaObjectHandler配合使用）
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @Version
    @TableField(fill = FieldFill.INSERT)
    private Integer version;//版本号 用于乐观锁
}

这里我使用了mybatis-plus的自动填充，让每次新增一条记录时，数据库中对应记录的version都为1。当然，若是不想这样用的话，也可以在数据库中设置该字段的默认值。
3.新建一个配置类MyConfig，添加乐观锁插件

@Configuration
@MapperScan("com.atguigu.mpdemo1010.mapper")
public class MyConfig {
    /**
     * 乐观锁插件
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4.单元测试

//测试乐观锁
    @Test
    public void testOptimisticLock(){
        User user = userMapper.selectById(1305774986337775617L);
        user.setAge(180);
        userMapper.updateById(user);
    }

四、SQL性能分析

MyBatis-Plus还提供了有关SQL性能分析插件

需要在自定义配置类MyConfig中进行插件的添加

    /**
     * SQL 执行性能分析插件
     * 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长
     * dev:开发环境
     * test:测试环境
     * prod:生产环境
     */
    @Bean
    @Profile({"dev","test"})// 设置 dev test 环境开启
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

添加该插件后，当执行SQL时，就可以在控制台中看见插件对SQL执行的监控

五、逻辑删除

逻辑删除就是将记录从项目中移除不再显示，但是数据库中依旧保有该记录
1.在表中添加deleted字段，用来标记逻辑删除状态。

image.png

2.在实体类中添加该字段，并使用@TableLogic注解，标记该字段为逻辑删除的标记。

@Data
public class User {
    /*
     @TableId(type = IdType.ID_WORKER) mybatis-plus自带的id生成策略，生成19位的值，适用于数值类型的主键
     @TableId(type = IdType.ID_WORKER_STR) mybatis-plus自带的id生成策略，生成19位的值，适用于字符串类型的主键
     若是使用mybatis-plus且没有指定主键生成策略，会自动根据主键类型选择生成策略
     */
    private Long id;
    private String name;
    private Integer age;
    private String email;

    //该注解为mybatis-plus的自动填充（与MetaObjectHandler配合使用）
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @Version
    @TableField(fill = FieldFill.INSERT)
    private Integer version;//版本号 用于乐观锁

    @TableLogic
    private Integer deleted;//逻辑删除标记
}

3.在自定义配置类中，添加逻辑删除插件

 /**
     * 逻辑删除插件
     */
    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }

4.单元测试

//删除（逻辑删除）
    @Test
    public void deleteUser(){
        userMapper.deleteById(1305787376383143938L);
    }
image.png

被逻辑删除的记录的deleted字段就会改变为非默认值，随后再在项目中进行查询时除非添加查询条件外，mybatis-plus的默认查询语句是不会查询被逻辑删除的字段。
（这里，我在数据库中将deleted属性默认值设为0）

六、mybatis-plus复杂条件查询

  //mp实现复杂查询操作
    @Test
    public void testSelectQuery(){
        //创建QueryWrapper对象
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        //通过QueryWrapper设置条件
        //ge,gt,le,lt
        //查询age>=30记录
//        wrapper.ge("age",30);

        //eq,ne
        //查询名字不为Lucy的记录
//        wrapper.ne("name","Lucy");


        //between
        //查询年龄在15-30之间的记录
//        wrapper.between("age",15,30);


        //like
        //模糊查询
//        wrapper.like("name","J");

        //orderByDesc
        //根据id进行排序(Desc降序,ASC升序)
//        wrapper.orderByDesc("id");


        //last
        //在SQL语句最后拼接SQL
//        wrapper.last("limit 1");


        //指定要查询的列
        wrapper.select("id","name");
        List<User> users = userMapper.selectList(wrapper);
        System.out.println(users);
    }

七、mybatis-plus的分页实现

 @Test
    public void testPage(){
        /*
        1.创建page对象，传入两个参数:当前页 和 每页显示记录数
        2.调用mp分页查询方法；调用mp分页查询过程中，底层封装  分页用到的所有数据都封装到page对象里面
         */
        Page<User> page = new Page<>(1,3);
        userMapper.selectPage(page,null);

        //通过page对象获取分页数据
        System.out.println(page.getCurrent());//当前页
        System.out.println("======================================");
        System.out.println(page.getRecords());//每页数据list集合
        System.out.println("======================================");
        System.out.println(page.getSize());//每页显示记录数
        System.out.println("======================================");
        System.out.println(page.getTotal());//总记录数
        System.out.println("======================================");
        System.out.println(page.getPages());//总页数

        System.out.println(page.hasNext());//表示是否有下一页
        System.out.println(page.hasPrevious());//表示是否有上一页
    }

八、自动生成代码

自动生成代码的教程可以参考官方介绍
这里我转载了其他大哥的技术博客，以供学习，感谢分享

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 219,635评论 6赞 508
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,628评论 3赞 396
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 165,971评论 0赞 356
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,986评论 1赞 295
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 68,006评论 6赞 394
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,784评论 1赞 307
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,475评论 3赞 420
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,364评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,860评论 1赞 317
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,008评论 3赞 338
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,152评论 1赞 351
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,829评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,490评论 3赞 331
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,035评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1赞 272
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,428评论 3赞 373
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 45,127评论 2赞 356