buguge - Keep it simple,stupid

知识就是力量,但更重要的,是运用知识的能力why buguge?

导航

mybatis-plus的in,是传Array还是传List?仔细一看方法签名,瞬间秒懂

引子

先看个技术题吧。

下面两段代码,执行testFoo,结果分别是什么?

@Test
public void testFoo() {
    foo(Arrays.asList(1, 2, 3));
}

void foo(Object... args) {
    System.out.println(args);
}
@Test
public void testFoo() {
    foo(Arrays.asList(1, 2, 3));
}

void foo(Object... args) {
    System.out.println(args);
}
void foo(List list){
    System.out.println(list);
}

 

一眼看出来结果的同学,恭喜你,本文内容可以略过。

 

下面是正文。

 

springboot项目通常配合mybatisplus来做数据CRUD。

我们在查询或更新数据的时候,有时要用到in来过滤数据。比如
SELECT * FROM emax_scbg_order WHERE order_no IN (1305679009380433922,1305405259472830465)


mybatisplus中关于in方法的使用,在传多个字段值的时候,我们经常搞不清是传Array呢还是ArrayList呢?
其实,细心的同学,看一下in方法的签名定义,就明白了。

mybatisplus中有4个in方法的重载。

所有Wrapper的超类是AbstractWrapper,AbstractWrapper实现了Func<Children, R>接口。in方法主要在Func<Children, R>接口中定义。

 

 下面是Func<Children, R>接口中in方法的4个重载:

//mybatis-plus-core-3.1.2.jar
package com.baomidou.mybatisplus.core.conditions.interfaces;

/**
 * 查询条件封装
 *
 * @author hubin miemie HCL
 * @since 2017-05-26
 */
@SuppressWarnings("unchecked")
public interface Func<Children, R> extends Serializable {
    /**
     * ignore
     */
    default Children in(R column, Collection<?> coll) {
        return in(true, column, coll);
    }
    
    /**
     * ignore
     */
    default Children in(R column, Object... values) {
        return in(true, column, values);
    }    

    /**
     * 字段 IN (v0, v1, ...)
     * <p>例: in("id", 1, 2, 3, 4, 5)</p>
     *
     * <li> 如果动态数组为 empty 则不会进行 sql 拼接 </li>
     *
     * @param condition 执行条件
     * @param column    字段
     * @param values    数据数组
     * @return children
     */
    default Children in(boolean condition, R column, Object... values) {
        return in(condition, column, Arrays.stream(Optional.ofNullable(values).orElseGet(() -> new Object[]{}))
            .collect(toList()));
    }
    
    /**
     * 字段 IN (value.get(0), value.get(1), ...)
     * <p>例: in("id", Arrays.asList(1, 2, 3, 4, 5))</p>
     *
     * <li> 如果集合为 empty 则不会进行 sql 拼接 </li>
     *
     * @param condition 执行条件
     * @param column    字段
     * @param coll      数据集合
     * @return children
     */
    Children in(boolean condition, R column, Collection<?> coll);

}


单从方法签名以及清晰的javadoc注释,我们可以看到,in方法接收字段值的方式有两种,一种是Object...,一种是Collection<?>。
■ Collection<?>不用说了,是集合,比如List<E>、Set<E>、Queuet<E>等。
■ Object...是可变长参数(可变参数),可变长参数本质上就是一个数组,既可以接收一个或多个离散的值,也可以接收数组对象。
也就是说,in方法同时支持传入数组和集合。当我们入参是List时,调用的是重载的in(Collection<?>),其他入参方式则是调用重载的in(Object...)。由此看来,调用mybatis-plus的in时,是传Array还是传List?就见分晓了。

现在,我们来做一个假设:假设这些in重载方法里没有in(Collection<?>),只有in(Object...),那么,我们应用程序在调用的时候,当需要in的参数值是一个集合时,如果我们把集合直接传给in(Object...),那就是bug。因为在可变长参数里,集合是作为一个参数值的(不是多个)。也就是说,在这种假设下,程序生成的SQL会是 SELECT * FROM table1 WHERE state IN ('[SUCCESS,FAIL]') ,我们的程序为规避这个bug,就要先把集合转换为数组再调用in(Object...)。显然,这样会给我们的开发带来额外的工作,更糟糕的是,这样的bug很难彻底规避。

mybatis-plus框架的研发团队显然意识到了这个“假设”,故而增加了重载的in(Collection<?>),毋庸置疑是非常优秀的设计。

下面详细列举使用in的姿势。

 

使用in的姿势

🍀正确姿势一(List集合):

List<Long> ids = Arrays.asList(122L,23L);;
new QueryWrapper<Driver>().lambda().in(Driver::getServiceId,ids);

 

🍀正确姿势二(数组对象):

Long[] ids={1305679009380433922,1305679009380433922};
LambdaQueryWrapper<Driver> queryWrapper = new QueryWrapper<Driver>().lambda().in(Driver::getServiceId,ids);

 

🍀正确姿势三(离散值):

new QueryWrapper<Driver>().lambda()
.in(Driver::getServiceId,1305679009380433922,1305679009380433922);

 

正确结果:

==>  Preparing: SELECT * FROM emax_scbg_order WHERE order_no IN (?,?)
==> Parameters: 1305679009380433922(String), 1305405259472830465(String)
<==      Total: 2

 

 

千万别传模棱两可的参数,这样jvm会给你意想不到的结果。

🍀错误姿势一:

.in(
    StringUtils.isNotBlank(vo.getOrderNumList()),
    ScbgOrder::getOrderNo,
    StringUtils.isNotBlank(vo.getOrderNumList()) ? vo.getOrderNumList().split(",") : "");

错误结果一:

==> Preparing: SELECT * FROM emax_scbg_order WHERE order_no IN (?)
==> Parameters: [Ljava.lang.String;@3eb6d7a9(String[])
<== Total: 0

调试程序可以看到values里的参数值:

 

 

🍀错误姿势二:

.in(StringUtils.isNotBlank(vo.getOrderNumList()),ScbgOrder::getOrderNo,"123,4566");

 错误结果二:

==> Preparing: SELECT * FROM emax_scbg_order WHERE order_no IN (?)
==> Parameters: 123,4566(String)
<== Total: 0

OK,那么not in怎么用呢?

在mybatisplus中,not in的用法与in是相同的。如下notIn方法签名的截图一看便知:

话外:调用in出现NullPointerException,why?

下面代码执行到第9行时,抛出空指针异常。可以看出来,这个in重载是public Children in(boolean condition, R column, Object... values)。开发同学疑惑:明明这个in的第一个参数判断vo.getOprationType()是否为空了呀,为空就不执行后面的第三个参数了,不为空才会执行后面的逻辑呀。那么,即使vo.getOprationType()为null,也不应该会抛空指针呀!

 1 private LambdaQueryWrapper<PayMerchantOpenFlow> getPayMerchantOpenFlowQueryWrapperByVO(PayMerchantOpenFlowDTO vo){
 2     LambdaQueryWrapper<PayMerchantOpenFlow> wrapper = new QueryWrapper<PayMerchantOpenFlow>().lambda()
 3             .eq(StringUtils.isNotBlank(vo.getMerchantCode()), PayMerchantOpenFlow::getMerchantCode,vo.getMerchantCode())
 4             .eq(null != vo.getRelationId(), PayMerchantOpenFlow::getRelationId,vo.getRelationId())
 5             .eq(StringUtils.isNotBlank(vo.getStatus()), PayMerchantOpenFlow::getStatus,vo.getStatus())
 6             .eq(StringUtils.isNotBlank(vo.getMerchantName()), PayMerchantOpenFlow::getMerchantName,vo.getMerchantName())
 7             .eq(StringUtils.isNotBlank(vo.getPayChannelCode()), PayMerchantOpenFlow::getPayChannelCode,vo.getPayChannelCode())
 8             .eq(StringUtils.isNotBlank(vo.getPayChannelName()), PayMerchantOpenFlow::getPayChannelName,vo.getPayChannelName())
 9             .in(StringUtils.isNotBlank(vo.getOprationType()), PayMerchantOpenFlow::getOprationType,vo.getOprationType().split(","))
10             .between(StringUtils.isNoneBlank(vo.getCreateTimeBegin(), vo.getCreateTimeEnd()), PayMerchantOpenFlow::getCreateTime, vo.getCreateTimeBegin() + " 00:00:01", vo.getCreateTimeEnd() + " 23:59:59")
11             .orderByDesc(PayMerchantOpenFlow::getCreateTime);
12     return wrapper;
13 }

答案是:上面的“第一个条件为true时才使用第三个参数执行sql处理”是in方法内部的逻辑,而不是调用方的逻辑。调用方所做的事情是把参数值传给in方法。所以, 当vo.getOprationType()#split时,由于vo.getOprationType()是null,所以导致了空指针。

话外:对比spring-data-redis,再次表扬一下mybatisplus这些优秀的in重载

spring-data-redis中的RedisTemplate类,提供了两个execute方法,用来允许我们执行LUA脚本。注意到了吧?这2个execute最后那个参数的类型是Object...。所以,在使用时,小心掉坑里,千万别直接传List哦。

 

EOF,感谢阅读!

posted on 2023-07-31 23:14  buguge  阅读(660)  评论(0编辑  收藏  举报