MyBatisPlus 的 CRUD 接口使用

小灰灰 2023-02-14 02:20 14阅读 0赞

## 一、引言 ##

这篇文章来学习一下`MybatisPlus`的`CRUD`接口具体使用，其中还是有几个比较重要的点，当然你也可以查看官网进行学习。

如何搭建一个MybatisPlus项目，可以参考前一篇文章：

`MybatisPlus初使用`：

> https://blog.csdn.net/zxd1435513775/article/details/106432694

`MybatisPlus`官网：

> http://mp.baomidou.com/guide/quick-start.html

`MybatisPlus`官方示列:

> https://github.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-quickstart

## 二、插入主键生成策略 ##

###### 1、insert插入操作 ######

向`user`表中添加一条数据。

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class CRUDTests { 
        @Autowired
        private UserMapper userMapper;
        @Test
        public void testInsert(){ 
            User user = new User();
            user.setName("kobe");
            user.setAge(42);
            user.setEmail("xxxxkobe@gmail.com");
            int result = userMapper.insert(user);
            System.out.println(result); // 影响的行数
            System.out.println(user); // id自动回填
        }
    }

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

###### 2、主键策略 ######

上面向数据库中插入一条记录时，并没有指定`主键id`的值，但数据库中该字段有值，这是由于`MybatisPlus`提供了主键生成策略，当我们在类的属性上添加`@TableId`注解时，表明该字段为主键，下面来看一下主键生成策略有哪些？  
此处MybatisPlus版本为3.0.5，在3.3.0版本中，主键生成策略已改变，可以参考官方文档。

> \#注解@tableId  
> https://mp.baomidou.com/guide/annotation.html\#tableid

@TableId(value = "id", type = IdType.ID_WORKER_STR)
    private Long id;

（1）、ID\_WORKER

MyBatis-Plus默认的主键策略是：ID\_WORKER 全局唯一ID

（2）、自增策略  
要想主键自增，需要在创建实体字段中配置 `@TableId(type = IdType.AUTO)`

@TableId(type = IdType.AUTO)
    private Long id;

要想影响所有实体的配置，可以在`application.properties`中设置全局主键配置

> \#全局设置主键生成策略  
> mybatis-plus.global-config.db-config.id-type=auto

其它主键策略：分析 IdType 源码可知：

@Getter
    public enum IdType { 
    	//数据库ID自增
        AUTO(0),
        //该类型为未设置主键类型
        NONE(1),
        //用户输入ID
        //该类型可以通过自己注册自动填充插件进行填充
        INPUT(2),
    
        /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
        // 全局唯一ID (idWorker)
        ID_WORKER(3),
        //全局唯一ID (UUID)
        UUID(4),
        // 字符串全局唯一ID (idWorker 的字符串表示)
        ID_WORKER_STR(5);
    
        private int key;
    
        IdType(int key) { 
            this.key = key;
        }
    }

## 三、update属性自动填充 ##

此部分，对应官方文档如下：

> https://mp.baomidou.com/guide/auto-fill-metainfo.html

###### 1、自动填充 ######

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。我们可以使用`MyBatis Plus`的自动填充功能，完成这些字段的自动赋值工作：

###### （1）、数据库表中添加自动填充字段 ######

在`User`表中添加`datetime`类型的新的字段 `create_time`、`update_time`

###### （2）、实体上添加注解 ######

@Data
    public class User { 
        ......
        // 插入时，自动填充
        @TableField(fill = FieldFill.INSERT)
        private Date createTime;
        
    	// 更新时，自动填充
        //@TableField(fill = FieldFill.UPDATE)
    	
    	// 插入和更新时，自动填充
        @TableField(fill = FieldFill.INSERT_UPDATE)
        private Date updateTime;
    }

###### （3）、实现元对象处理器接口 ######

使用属性自动填充时，要自定义实现类 `MyMetaObjectHandler`  
注意：不要忘记添加 @Component 注解

@Component
    public class MyMetaObjectHandler implements MetaObjectHandler { 
    
        private static final Logger LOGGER = 
        	LoggerFactory.getLogger(MyMetaObjectHandler.class);
    
    	// 属性字段插入时，会执行此方法
        @Override
        public void insertFill(MetaObject metaObject) { 
            LOGGER.info("start insert fill ....");
            this.setFieldValByName("createTime", new Date(), metaObject);
            this.setFieldValByName("updateTime", new Date(), metaObject);
        }
    
    	// 属性字段更新时，会执行此方法
        @Override
        public void updateFill(MetaObject metaObject) { 
            LOGGER.info("start update fill ....");
            this.setFieldValByName("updateTime", new Date(), metaObject);
        }
    }

## 四、select查询及分页 ##

###### 1、根据id查询记录 ######

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

###### 2、通过多个id批量查询 ######

完成了动态sql的foreach的功能

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

###### 3、简单的条件查询 ######

通过map封装查询条件

@Test
    public void testSelectByMap(){ 
    
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "Helen");
        map.put("age", 18);
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

注意：map中的key对应的是数据库中的列名。例如数据库user\_id，实体类是userId，这时map的key需要填写user\_id

###### 4、分页 ######

> \#官方介绍  
> https://mp.baomidou.com/guide/page.html

`MyBatis Plus`自带分页插件，只要简单的配置即可实现分页功能

###### （1）、创建配置类 ######

// 分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() { 
        return new PaginationInterceptor();
    }

###### （2）、测试selectPage分页 ######

测试：最终通过page对象获取相关数据

@Test
    public void testSelectPage() { 
    
        Page<User> page = new Page<>(1,5);
        userMapper.selectPage(page, null);
    
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getCurrent());
        System.out.println(page.getPages());
        System.out.println(page.getSize());
        System.out.println(page.getTotal());
        System.out.println(page.hasNext());
        System.out.println(page.hasPrevious());
    }

控制台sql语句打印：

> SELECT id,name,age,email,create\_time,update\_time FROM user LIMIT 0,5

###### （3）、测试selectMapsPage分页：结果集是Map ######

@Test
    public void testSelectMapsPage() { 
    
        Page<User> page = new Page<>(1, 5);
    
        IPage<Map<String, Object>> mapIPage = 
        		userMapper.selectMapsPage(page, null);
    
        //注意：此行必须使用 mapIPage 获取记录列表，否则会有数据类型转换错误
        mapIPage.getRecords().forEach(System.out::println);
        System.out.println(page.getCurrent());
        System.out.println(page.getPages());
        System.out.println(page.getSize());
        System.out.println(page.getTotal());
        System.out.println(page.hasNext());
        System.out.println(page.hasPrevious());
    }

## 五、delete ##

###### 1、根据id删除记录 ######

@Test
    public void testDeleteById(){ 
        int result = userMapper.deleteById(8L);
        System.out.println(result);
    }

###### 2、批量删除 ######

@Test
    public void testDeleteBatchIds() { 
        int result =
        	 userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
        System.out.println(result);
    }

###### 3、简单的条件查询删除 ######

@Test
    public void testDeleteByMap() { 
    
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "Helen");
        map.put("age", 18);
    
        int result = userMapper.deleteByMap(map);
        System.out.println(result);
    }

###### 4、逻辑删除 ######

> \#官方文档介绍  
> https://mp.baomidou.com/guide/annotation.html\#tablelogic

物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据

逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

###### （1）、数据库中添加 deleted字段 ######

ALTER TABLE `user` ADD COLUMN `deleted` boolean

###### （2）、实体类添加 deleted 字段 ######

并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解

@TableLogic
    @TableField(fill = FieldFill.INSERT)
    private Integer deleted;

###### （3）、元对象处理器接口添加deleted的insert默认值 ######

@Override
    public void insertFill(MetaObject metaObject) { 
        ......
        this.setFieldValByName("deleted", 0, metaObject);
    }

###### （4）application.properties 加入配置 ######

此为默认值，如果你的默认值和mp默认的一样，该配置可无

mybatis-plus.global-config.db-config.logic-delete-value=1
    mybatis-plus.global-config.db-config.logic-not-delete-value=0

###### （5）在 MybatisPlusConfig 中注册 Bean ######

@Bean
    public ISqlInjector sqlInjector() { 
        return new LogicSqlInjector();
    }

注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作，MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断

## 六、性能分析 ##

> \#官方文档介绍  
> https://mp.baomidou.com/guide/performance-analysis-plugin.html

性能分析拦截器，用于输出每条 SQL 语句及其执行时间，SQL 性能执行分析，在开发环境使用，超过指定时间，停止运行，有助于发现问题。

###### 1、配置插件 ######

（1）、参数说明  
参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。  
参数：format： SQL是否格式化，默认false。  
（2）、在 MybatisPlusConfig 中配置

@Bean
    @Profile({ "dev","test"})// 设置 dev test 环境开启
    public PerformanceInterceptor performanceInterceptor() { 
        PerformanceInterceptor performanceInterceptor = 
        	new PerformanceInterceptor();
        // ms，超过此处设置的ms则sql不执行
        performanceInterceptor.setMaxTime(100);
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

（3）、Spring Boot 中设置dev环境

#环境设置：dev、test、prod
    spring.profiles.active=dev

可以针对各环境新建不同的配置文件  
application-dev.properties、  
application-test.properties、  
application-prod.properties

## 七、小结 ##

如果想进行复杂条件查询，那么需要使用条件构造器 Wapper，涉及到如下方法

delete、selectOne、selectCount、
    selectList、selectMaps、selectObjs、update

参考下一篇吧。