jedis的scan操作要注意cursor数据类型

环境

jedis3.0.0

背景

在使用jedis的"scan"操作获取redis中某些key时,发现总是出现类型转换的异常——"java.lang.ClassCastException: java.lang.String cannot be cast to [B"

其中,redis中存储的key是byte[]类型,用"scan"操作获取的所有key是封装到一个List中,获取结果后直接通过Set.addAll()存到一个HashSet中,就在用forEach遍历该HashSet时抛出了异常。

Debug

Why

经过debug发现这跟调用"scan(cursor,params)"时传的"cursor"的类型有关。
jedis的scan操作要注意cursor数据类型_第1张图片

如上两图所示:

  • 当cursor为String类型时,调用的是Jedis类中的scan方法;
  • 当cursor为byte[]类型时,调用的则是BinaryJedis中的scan方法。

Jedis类是BinaryJedis的子类

What

接下来看下两者的scan方法——
Jedis.scan(final String cursor, final ScanParams params):

@Override
  public ScanResult scan(final String cursor, final ScanParams params) {
    checkIsInMultiOrPipeline();
    client.scan(cursor, params);
    List result = client.getObjectMultiBulkReply();
    String newcursor = new String((byte[]) result.get(0));
    List results = new ArrayList();
    List rawResults = (List) result.get(1);
    for (byte[] bs : rawResults) {
      results.add(SafeEncoder.encode(bs));
    }
    return new ScanResult(newcursor, results);
  }

BinaryJedis.scan(final byte[] cursor, final ScanParams params):

public ScanResult scan(final byte[] cursor, final ScanParams params) {
    checkIsInMultiOrPipeline();
    client.scan(cursor, params);
    List result = client.getObjectMultiBulkReply();
    byte[] newcursor = (byte[]) result.get(0);
    List rawResults = (List) result.get(1);
    return new ScanResult(newcursor, rawResults);
}

可以发现,两者都是通过调用BinaryClient类的scan方法来获取数据,这些数据是一样的,只是两者在封装返回结果时的操作不同而已。BinaryJedis把byte[]类型的原始数据原封不动地返回,而Jedis则是用SafeEncode把原始数据encode成String类型返回。

How

一开始没意识到scan("0",params)scan("0".getBytes(),params)返回结果不同,直接用了前者,结果前者返回的是List类型的数据,直接用addAll(ScanResult.getResult())方法放到HashSet中,而编译器这时是没有提示的,所以自然而然,在遍历HashSet时就抛出了异常。

jedis的scan操作要注意cursor数据类型_第2张图片
注:ScanResult提供两个方法获取游标,分别是getCursor()getCursorAsBytes(),前者是String类型,后者是byte[]类型,使用时需要注意。

拓展

此时又产生了新的疑惑,会不会在ScanParams中也存在类似的问题?于是进ScanParams类查看
jedis的scan操作要注意cursor数据类型_第3张图片
发现这里对match方法进行了重载(Overload),传入byte[]和String类型的参数结果是一样的。所以ScanParams的pattern可以用String或者byte[]。

启发

在开发中,一定一定一定要注意变量类型,尤其是集合中的泛型。有必要的话,在类型转换前或者在集合类的操作中对变量进行类型检查。

你可能感兴趣的:(jedis的scan操作要注意cursor数据类型)