Jedis源码分析

2016/06/07 3 分钟阅读

简介

简介
简单实现
- set 命令实例
shard jedis 实现
Pipeline
pool实现
Jodis - Java client for codis

Intro to Jedis – the Java Redis Client Library

阅读前建议参看 Redis 学习对Redis 通信协议以及五种数据类型有所了解

简单实现

从下到上，是一个复杂功能需求如何被逐步分解的过程，比如JedisCommands 的void set(String key,String value) 和BinaryJedisCommands 的void set(byte[] key,byte[] value)

JedisPool 池化了 Jedis，是Jedis 池的操作入口。池化的不是“连接”，而是整个Jedis 对象。
Jedis 作为单连接操作入口，提供了操作API
BinaryJedis 实际干活儿，聚合了Client、Transaction、Pipeline 等能力对象，Client 基于Socket 负责实际的网络访问。

jedis协议支持的操作，称为Command，反映在代码中，抽象出了一系列的Command接口，负责不同的操作。

BasicCommands，比如ping，save，bgsave等，方法一般没有参数，或参数跟数据内容无关
BinaryJedisCommands，负责各种数据结构的set和get

MultiKeyBinaryCommands，参数为多个key的命令

  Long del(String... keys);
  List<String> blpop(int timeout, String... keys);

AdvancedJedisCommands

    List<Slowlog> slowlogGet();
    String clientList();

其它的Command类一般用不着

在网络通信层面，jedis与其它rpc组件是一样一样的

set 命令实例

client负责数据io，command定义业务接口，jedis负责整合两者。command没有XXXCommand实现类，其最终由jedis实现，jedis实现几个Command，该jedis就支持几种操作，比如ShardedJedis就没有支持所有的Command。

//jedis
public String set(String key, String value) {
    this.checkIsInMultiOrPipeline();
    this.client.set(key, value);
    return this.client.getStatusCodeReply();
}
// Client
public void set(String key, String value) {
    this.set(SafeEncoder.encode(key), SafeEncoder.encode(value));
}
// BinaryClient
public void set(byte[] key, byte[] value, byte[] nxxx, byte[] expx, long time) {
    this.sendCommand(Command.SET, new byte[][]{key, value, nxxx, expx, Protocol.toByteArray(time)});
}
Connection sendCommand(Command cmd, byte[]... args) {
    try {
        this.connect();
        // 协议层
        Protocol.sendCommand(this.outputStream, cmd, args);
        ++this.pipelinedCommands;
        return this;
    }catch(Exception e){...}
}
// Protocol，提供了一些额外的write方法，将command变成符合redis协议的二进制数据，并发送
private static void sendCommand(RedisOutputStream os, byte[] command, byte[]... args){        
    try {
        os.write((byte)42);
        os.writeIntCrLf(args.length + 1);
        os.write((byte)36);
        os.writeIntCrLf(command.length);
        os.write(command);
        os.writeCrLf();
        byte[][] e = args;
        int len$ = args.length;
        for(int i$ = 0; i$ < len$; ++i$) {
            byte[] arg = e[i$];
            os.write((byte)36);
            os.writeIntCrLf(arg.length);
            os.write(arg);
            os.writeCrLf();
        }

    } catch (IOException var7) {
        throw new JedisConnectionException(var7);
    }
}

整个代码看下来，真是太流畅了，类似的client-server工具程序可以借鉴下。

shard jedis 实现

这里主要用到了一致性哈希，完成key ==> 虚拟节点 ==> 实际节点的映射

涉及到的类: ShardedJedis extends BinaryShardedJedis，Sharded，ShardInfo

// ShardedJedis
public String set(String key, String value) {
    Jedis j = this.getShard(key);
    return j.set(key, value);
}
// Sharded，先在TreeMap中找到对应key所对应的ShardInfo，然后通过ShardInfo在LinkedHashMap中找到对应的Jedis实例。
public R getShard(byte[] key) {
    return this.resources.get(this.getShardInfo(key));
}

Sharded<R, S extends ShardInfo<R>> {
    private TreeMap<Long, S> nodes;                  hash(虚拟shardinfo)与shardinfo的映射
    private final Hashing algo;    					 // 哈希算法
    private final Map<ShardInfo<R>, R> resources;    // shardInfo与Jedis的映射
}

虚拟节点的生成以及与实际节点的映射在系统初始化时完成，至于key到虚拟节点的映射：treemap.tailMap(hash(key))，会返回所有大于hash(key)的key-value,选择第一个即可。

Pipeline

pipeline的简单实例

Jedis jedis = new Jedis(host, port);
jedis.auth(password);
Pipeline p = jedis.pipelined();
p.get("1");
p.get("2");
p.get("3");
List<Object> responses = p.syncAndReturnAll();
System.out.println(responses.get(0));
System.out.println(responses.get(1));
System.out.println(responses.get(2));

提供Queable接口，负责暂存响应结果

Queable {
    private Queue<Response<?>> pipelinedResponses =  new LinkedList<Response<?>>();
}

将model包装成response，然后提供从list上加入和取出response的操作接口

Response

Response<T> {
	T response = null;
	JedisDataException exception = null;
	boolean building = false;
	boolean built = false;
	boolean set = false;
	Builder<T> builder;
	Object data;
	Response<?> dependency = null; 
}

pipeline包含client成员，因此具备数据的收发能力，但在收发数据的逻辑上与jedis的不同。pipeline的基本原理是：在pipeline中的请求，会直接发出去，同时加一个response进入list（相当于约定好返回结果存这里）。网络通信嘛，返回的结果本质上是inputstream。等到syncAndReturnAll的时候集中解析inputstream。因为redis server端是单线程处理的，所以也不用担心get(“2”)的结果跑在get(“1”)的前面。

public List<Object> syncAndReturnAll() {
    if (getPipelinedResponseLength() > 0) {
        List<Object> unformatted = client.getMany(getPipelinedResponseLength());
        List<Object> formatted = new ArrayList<Object>();
        for (Object o : unformatted) {
            try {
                formatted.add(generateResponse(o).get());
            } catch (JedisDataException e) {
                formatted.add(e);
            }
        }
        return formatted;
    } else {
        return java.util.Collections.<Object> emptyList();
    }
}

pool实现

基于common pool2实现

Jodis - Java client for codis

Jodis - Java client for codis 功能特性

Use a round robin policy to balance load to multiple codis proxies.
Detect proxy online and offline automatically.

从目前看，主要是解决多codis proxy 的服务发现， codis 参见Codis源码分析

示例代码

JedisResourcePool jedisPool = RoundRobinJedisPool.create()
        .curatorClient("zkserver:2181", 30000).zkProxyDir("/jodis/xxx").build();
try (Jedis jedis = jedisPool.getResource()) {
    jedis.set("foo", "bar");
    String value = jedis.get("foo");
    System.out.println(value);
}

// RoundRobinJedisPool 构造方法
private RoundRobinJedisPool(CuratorFramework curatorClient, boolean closeCurator,
        String zkProxyDir, JedisPoolConfig poolConfig, int connectionTimeoutMs, int soTimeoutMs,
        String password, int database, String clientName) {
    ...
    watcher = new PathChildrenCache(curatorClient, zkProxyDir, true);
    watcher.getListenable().addListener(new PathChildrenCacheListener() {
        public void childEvent(CuratorFramework client, PathChildrenCacheEvent event)
                throws Exception {
            synchronized (RoundRobinJedisPool.this) {
                if (RESET_TYPES.contains(event.getType())) {
                    resetPools();
                }
            }
        }
    });
}
private volatile ImmutableList<PooledObject> pools = ImmutableList.of();
// 干掉offline 实例，为pools 赋值新的online 实例
private void resetPools() {
    ImmutableList<PooledObject> pools = this.pools;
    Map<String, PooledObject> addr2Pool = copy from pools
    ImmutableList.Builder<PooledObject> builder = ImmutableList.builder();
    // 根据活着的实例 构建builder，并从addr2Pool 移除活着的实例
    for (ChildData childData : watcher.getCurrentData()) {
        CodisProxyInfo proxyInfo = MAPPER.readValue(childData.getData(),
                CodisProxyInfo.class);
        if (!CODIS_PROXY_STATE_ONLINE.equals(proxyInfo.getState())) {
            continue;
        }
        String addr = proxyInfo.getAddr();
        PooledObject pool = addr2Pool.remove(addr);
        if (pool == null) {
            // 与传统JedisPool 的方式一样
            pool = new PooledObject(addr,new JedisPool(...));
        }
        builder.add(pool);
    }
    this.pools = builder.build();
    // 移除 offline 的实例
    for (final PooledObject pool: addr2Pool.values()) {
        jedisPoolClosingExecutor.schedule(new Runnable() {
            public void run() {
                pool.close();
            }
        }, DELAY_BEFORE_CLOSING_POOL, TimeUnit.MILLISECONDS);
    }
}

Jodis 采用依赖Jedis 的方式，将JedisPool 入口对象改为 RoundRobinJedisPool。整个jar 只有四五个类
RoundRobinJedisPool从zk 中拿到codis-proxy地址列表，重建pools。说白了就是 proxy list 从配置取改成从zk 取
synchronized + volatile + 先准备数据再赋值 this.pools = builder.build(); 来保护pools 的安全访问

李乾坤

Jedis源码分析

简介

简单实现

set 命令实例

shard jedis 实现

Pipeline

pool实现

Jodis - Java client for codis

留下评论

猜您还喜欢

Long-horizon Agent

next prompt工程——skill

从chatbot到clawbot

typescript学习