手把手教你写一个极简版Jedis

最新推荐文章于 2024-05-27 09:56:53 发布

原创

最新推荐文章于 2024-05-27 09:56:53 发布 · 580 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #redis #后端

本文介绍了从基础版到支持多种Redis命令、异常处理、断线重连及连接池的Jedis客户端实现过程，涉及RESP协议、缓冲区优化、命令封装和连接管理等内容。

前言

Jedis是Redis官方推荐的Jedis客户端，在业界使用非常广泛。通过阅读Jedis源码，可以掌握如何设计和实现一个轻量级、带连接池的Redis客户端。我常常说，学习源码最好的方法就是以自己的思考重新写一遍，这样有助于把学到的知识固化成实际经验。本文会带着你从零开始设计一个极简版的Jedis，从支持最简单的GET/SET命令出发，逐步添加缓冲区、多种命令、断线重连、连接池等多种功能。本文的源代码放在Github上（mini-jedis），感兴趣的读者可以自行取阅。

版本V1：基础版

首先实现一个最简单的GET命令。我们知道Jedis的IO模式是BIO，它发送和接收数据依赖输入输出流的阻塞式读写。所以我们先为Jedis创建一个socket：

	// Jedis.java
	public Jedis(String host, int port) throws UnknownHostException, IOException {
   
   
		socket = new Socket();
		socket.setReuseAddress(true);
		socket.setKeepAlive(true); // Will monitor the TCP connection is valid
		socket.setTcpNoDelay(true); // Socket buffer Whetherclosed, to ensure timely delivery of data
		socket.setSoLinger(true, 0); // Control calls close () method, the underlying socket is closed immediately
		socket.connect(new InetSocketAddress(host, port), 2000);
		socket.setSoTimeout(2000);
	}

注意socket有多项TCP参数要设置（参考Jedis源码），设置后的效果如下：

REUSE_ADDRESS：Jedis客户端断开连接处于TIMED_WAIT状态时，重连可以复用之前的端口。
SO_KEEPALIVE：当长时间没有消息收发时，也能保证连接不断开。
TCP_NODELAY：禁用nagle算法，保证发送数据的实时性。
SO_LINGER：当调用close()方法时，连接立刻关闭，而不是通常那样等待缓冲区中的剩余数据发送完。

建立好socket后，我们再来编写与Redis服务器通信的逻辑。在写之前，我们有必要了解一下Redis的通信协议：RESP协议（Redis Serialization Protocol）。

RESP协议是一种简单的应用层协议，它的特点是：实现精简、容易阅读。以GET命令为例，我们来看一个最简单的RESP协议例子：

// GET消息：发送
*2
$3
GET
$4
key1

// GET消息：接收
$6
value1

以上消息中有一些特定符号，它们的意义总结如下：

意义	开头字符	示例	解释
简单字符串	+	+OK\r\n	未知长度的字符串，如SET命令的返回
错误	-	-Error message\r\n	Redis服务器返回的报错
整型	:	:0\r\n	整数，如LLEN命令的返回
批量字符串	$	$3\r\nGET\r\n	已知长度的字符串，$后面的数字表示字符串长度
数组	*	*2\r\n	数组，每个元素都属于其他基本类型，*后面的数字表示数组长度

根据这里的符号定义，可以解释上面的GET消息：

发送：由包含2个元素的数组构成，第一个元素是长度为3的字符串”GET“，第二个元素是长度为4的字符串”key1“。这两个元素分别是命令名字和命令参数。
接收：仅包含一个长度为6的字符串”value1“。

清楚了GET消息的协议构成，很容易写出它的实现代码：

	// Jedis.java
	public String get(String key) throws IOException {
   
   
		StringBuilder sb = new StringBuilder();
		sb.append("*2").append("\r\n")
		.append("$3").append("\r\n")
		.append("GET").append("\r\n")
		.append("$").append(key.length()).append("\r\n")
		.append(key).append("\r\n");
		socket.getOutputStream().write(sb.toString().getBytes());
		InputStream is = socket.getInputStream();
		byte[] b = new byte[1024];
		int len = is.read(b);
		String ret = new String(b, 0, len);
		return ret;
	}

同样地，我们编写SET消息的实现方法，并写好它们的测试例子：

// Jedis.java
public static void main(String args[]) throws UnknownHostException, IOException {
   
   
	Jedis jedis = new Jedis("localhost", 6379);
	System.out.print(jedis.set("key1", "value1"));
	System.out.print(jedis.get("key1")