so easy！松哥手把手带你撸一个 Redis 的 Java 客户端

其实今天是想和小伙伴们聊一下 Redis 的通信协议 RESP。在搞懂这个通信协议的基础上，松哥手把手带领大家做一个 Redis 的 Java 客户端。

本文配套视频地址

以上视频节选自松哥自制的 Spring Boot + Vue 系列视频教程

以下是视频笔记。

Redis 通信使用了文本协议，文本协议比较费流量，但是 Redis 作者认为数据库的瓶颈不在于网络流量，而在于内部逻辑，所以采用了这样一个费流量的文本协议，事实证明，这个费流量的文本协议并不影响 Redis 的受欢迎程度。

这个文本协议叫做 Redis Serialization Protocol，简称 RESP。

Redis 协议将传输的数据结构分为 5 种最小单元，单元结束时，加上回车换行符 \r\n。

1. 单行字符串以 + 开始，例如 +javaboy.org\r\n
2. 多行字符串以 $ 开始，后面加上字符串长度，例如 $11\r\njavaboy.org\r\n
3. 整数值以: 开始，例如 :1024\r\n
4. 错误消息以 - 开始
5. 数组以 * 开始，后面加上数组长度。

需要注意的是，如果是客户端连接服务端，只能使用第 5 种。

1.准备工作

做两件事情：

为了方便客户端连接 Redis，我们关闭 Redis 种的保护模式(在 redis.conf 文件中)

protected no

同时关闭密码：

# requirepass xxxx

配置完成后，重启 Redis。

2. 实战

接下来，我们通过 Socket+RESP 来定义两个最最常见的命令 set 和 get。

首先我们在构造方法中初始化一个 Socket 连接，这将是我们 Java 代码和 Redis 通信的基础。

public class JavaboyRedisClient {
    private Socket socket;
    public JavaboyRedisClient() {
        try {
            socket = new Socket("192.168.91.128", 6379);
        } catch (IOException e) {
            e.printStackTrace();
            System.out.println("Redis 连接失败");
        }
    }
}

接下来，我们先来定义 set 方法。

根据前面列出来的规则，Java 客户端发送到 Redis 中的数据格式是第 5 种，也就是一个数组，对于 set 命令而言，数组中应该有三项，第一项是命令名字 set，第二项和第三项则是对应的 key/value，如下：

[set,key,value]

结合第 1 小节的 5 条规则，我们可以先规划一下要发送的字符串，每行文本之后都有 \r\n。

*3\r\n$3\r\nset\r\n$3\r\nkey\r\n$5\r\nvalue\r\n 

*3 表示数组长度为 3（规则 5），$3 表示 set 长度为 3（规则 2），后面字符串含义类似不再赘述。

整理好思路之后，我们来看下代码：

/**
* 执行 Redis 中的 set 命令 [set,key,value]
* @param key
* @param value
* @return
*/
public String set(String key, String value) throws IOException {
   StringBuilder sb = new StringBuilder();
   sb.append("*3")
           .append("\r\n")
           .append("$")
           .append("set".length())
           .append("\r\n")
           .append("set")
           .append("\r\n")
           .append("$")
           .append(key.getBytes().length)
           .append("\r\n")
           .append(key)
           .append("\r\n")
           .append("$")
           .append(value.getBytes().length)
           .append("\r\n")
           .append(value)
           .append("\r\n");
   System.out.println(sb.toString());
   socket.getOutputStream().write(sb.toString().getBytes());
   byte[] buf = new byte[1024];
   socket.getInputStream().read(buf);
   return new String(buf);
}

代码的逻辑很简单，就是把我们传入的参数，处理成我们上面写好的字符串，然后再通过 socket 写出去。

同理，我们还可以定制 get 方法，如下：

/**
 * 执行 Redis 中的 get 命令 [get,key]
 * @param key
 * @return
 */
public String get(String key) throws IOException {
    StringBuilder sb = new StringBuilder();
    sb.append("*2")
            .append("\r\n")
            .append("$")
            .append("get".length())
            .append("\r\n")
            .append("get")
            .append("\r\n")
            .append("$")
            .append(key.getBytes().length)
            .append("\r\n")
            .append(key)
            .append("\r\n");
    socket.getOutputStream().write(sb.toString().getBytes());
    byte[] buf = new byte[1024];
    socket.getInputStream().read(buf);
    return new String(buf);
}

接下来通过如下一段代码进行测试：

public static void main(String[] args) throws IOException {
    String set = new JavaboyRedisClient().set("k1", "江南一点雨");
    System.out.println(set);
    String k1 = new JavaboyRedisClient().get("k1");
    System.out.println(k1);
}

好了，如此之后，我们就定义了一个简陋的 Java 客户端。具体的测试效果小伙伴们可以参考前面的视频。

好了，在理解 RESP 的基础上，我们可以非常容易的实现这样的客户端。小伙伴们也可以自己尝试定义一下其他的命令体验下。

如果觉得有用，记得点在看哦。