Redis客户端(Jedis)

Redis的各种语言客户端列表,请参见Redis Client。其中Java客户端在github上start最高的是Jedis和Redisson。Jedis提供了完整Redis命令,而Redisson有更多分布式的容器实现。
使用Jedis客户端
首先通过maven引入Jedis的依赖:

redis.clients jedis 2.8.0

创建Jedis对象,调用set方法,并通过get方法获取到值并打印:
Jedis jedis = new Jedis("localhost", 6379); jedis.set("singleJedis", "hello jedis!"); System.out.println(jedis.get("singleJedis")); jedis.close();

注意Jedis对象并不是线程安全的,在多线程下使用同一个Jedis对象会出现并发问题。为了避免每次使用Jedis对象时都需要重新构建,Jedis提供了JedisPoolJedisPool是基于Commons Pool 2实现的一个线程安全的连接池。
JedisPoolConfig jedisPoolConfig = new JedisPoolConfig(); jedisPoolConfig.setMaxTotal(10); JedisPool pool = new JedisPool(jedisPoolConfig, "localhost", 6379); Jedis jedis = null; try{ jedis = pool.getResource(); jedis.set("pooledJedis", "hello jedis pool!"); System.out.println(jedis.get("pooledJedis")); }catch(Exception e){ e.printStackTrace(); }finally { //还回pool中 if(jedis != null){ jedis.close(); } }pool.close();

使用完后记得主动调一下close方法,将Jedis对象归还到连接池中。Jedis的close方法:
public void close() { //如果使用了连接池,检查客户端状态,归还到池中 if (dataSource != null) { if (client.isBroken()) { this.dataSource.returnBrokenResource(this); } else { this.dataSource.returnResource(this); } } else { //未使用连接池,直接关闭 client.close(); } }

Jedis代码分析
【Redis客户端(Jedis)】从类结构、启动、执行命令三个方面分析一下Jedis客户端。
Jedis类结构 Jedis类是整个客户端的入口,通过Jedis可以建立与Redis Server的连接并发送命令。Jedis继承自BinaryJedis,同时Jedis和BinaryJedis都实现了很多接口,通过一张类图来描述:
Redis客户端(Jedis)
文章图片
Jedis类图 每一个接口都代表了一类Redis命令,例如JedisCommands中包含了SET GET等命令,MultiKeyCommands中包含了针对多个Key的MSET MGET等命令。一部分命令有两个版本的接口,如JedisCommands和BinaryJedisCommands。JedisCommands是字符串参数版本命令,会在Jedis内部将参数转换成UTF-8编码的字节数组。BinaryJedisCommands提供的是字节参数版本,允许用户自己决定编码等细节。ClusterCommands和SentinelCommands与集群、高可用等相关的命令只有一个版本。
Jedis的初始化 JedisPool的构造函数:
public JedisPool(/** Commons Pool的参数 **/ final GenericObjectPoolConfig poolConfig, /** Redis Server地址 **/ final URI uri, /** 连接Redis Server超时时间**/ final int connectionTimeout, /** 等待Response超时时间 **/ final int soTimeout) { super(poolConfig, new JedisFactory(uri, connectionTimeout, soTimeout, null)); }

JedisFactory实现了PooledObjectFactory的makeObject方法,当调用pool.getResource()方法获取Jedis对象时,会通过makeObject方法创建了Jedis对象:
final Jedis jedis = new Jedis(hostAndPort.getHost(), hostAndPort.getPort(), connectionTimeout, soTimeout);

在Jedis的构造函数中,会创建真正与Redis Server通信的Client对象:
client = new Client(host, port); client.setConnectionTimeout(timeout); client.setSoTimeout(timeout);

初始化Jedis对象并不会与Redis Server建立连接,连接发生在第一次执行命令时。
Jedis执行命令 以SET命令为例,在Jedis中执行SET命令:
jedis.set("singleJedis", "hello jedis!");

调用Jedis的set方法,会委托给内部的client对象的set方法,在client的字符串版本set方法中,会进行String到byte[]的转换:
set(SafeEncoder.encode(key), SafeEncoder.encode(value));

SafeEncoder.encode将字符串转换为UTF-8编码的字节数组,然后调用sendCommand方法:
sendCommand(Command.SET, key, value); protected Connection sendCommand(final Command cmd, final byte[]... args) { try { connect(); Protocol.sendCommand(outputStream, cmd, args); ... } catch (JedisConnectionException ex) { ... } }

省略了一部分异常处理的代码,在sendCommand方法中,建立了与Server的连接,并发送命令。connect方法会按照JedisPool构造函数中的参数,初始化Socket:
socket = new Socket(); //TIME_WAIT状态下可以复用端口 socket.setReuseAddress(true); //空闲时发送数据包,确认服务端状态 socket.setKeepAlive(true); //关闭Nagle算法,尽快发送 socket.setTcpNoDelay(true); //调用close方法立即关闭socket,丢弃所有未发送的数据包 socket.setSoLinger(true, 0); //连接server socket.connect(new InetSocketAddress(host, port), connectionTimeout); //设置读取时超时时间 socket.setSoTimeout(soTimeout);

sendCommand方法,按照Redis协议,发送命令:
private static void sendCommand(final RedisOutputStream os, final byte[] command, final byte[]... args) { try { os.write(ASTERISK_BYTE); os.writeIntCrLf(args.length + 1); os.write(DOLLAR_BYTE); os.writeIntCrLf(command.length); os.write(command); os.writeCrLf(); for (final byte[] arg : args) { os.write(DOLLAR_BYTE); os.writeIntCrLf(arg.length); os.write(arg); os.writeCrLf(); } } catch (IOException e) { throw new JedisConnectionException(e); } }

    推荐阅读