漫谈 Socket 编程 如何设计 Cheese 的远程调用功能

1、概述

        前段时间设计了一款简单的分布式服务框架，具备了基本的服务发现、服务注册以及远程调用的功能，细心的你肯定发现了 远程调用我们直接使用了Spring 里面的 RestTemplate 组件，那么RestTemplate底层是怎么实现的呢，我们如何设计一款远程调用的框架呢 。我们今天就来研究这些内容。

关于Cheese这个框架 不知道的小伙伴可以查阅一下前面的文章

抽丝剥茧 分布式服务框架设计 理论设计篇

抽丝剥茧 分布式服务框架设计 实战落地篇

2、Socket 编程

2.1、从一个Demo开始 

        刚学编程的时候相信大家肯定学过 Socket 相关的内容，这里先来上段代码，给大家看个小案例帮助大家回忆一下相关的内容

public class SocketDemo {
    public static void main(String[] args) {
        try {
            ServerSocket serverSocket = new ServerSocket(10081); // 监听端口
            System.out.println("server start ...");
            Socket clientSocket = serverSocket.accept();
            BufferedReader in = new BufferedReader(new InputStreamReader(clientSocket.getInputStream()));
            PrintWriter out = new PrintWriter(clientSocket.getOutputStream(), true);
            String message;
            while ((message = in.readLine()) != null) {
                System.out.println("服务器已收到: " + message);
                out.println("服务器已收到: " + message); // 发送响应消息
            }
            in.close();
            out.close();
            clientSocket.close();
            serverSocket.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

      上面的这段代码就是 在本机上开启了一个监听端口，当有客户端建立了连接并且发送了数据的时候，就通过输入流读取客户端发过来的数据，接着使用输出流给客户端返回一个响应消息。下面给出一段客户端的代码示例

/**
 * @Description
 * @Author wcan
 * @Date 2024/11/25 下午 19:01
 * @Version 1.0
 */
public class Client {
    public static void main(String[] args) {
        try {
            Socket socket = new Socket("127.0.0.1", 10081); // 连接服务器
            BufferedReader in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
            PrintWriter out = new PrintWriter(socket.getOutputStream(), true);
            Scanner scanner = new Scanner(System.in);
            System.out.println("请输入要发送的消息:");
            while (scanner.hasNextLine()) {
                String input = scanner.nextLine();
                out.println(input);
                if (input.equals("exit")) {
                    break;
                }
                String response = in.readLine(); // 接收服务器的响应
                System.out.println("response: " + response);
            }
            in.close();
            out.close();
            socket.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

        大家可以先启动服务端的方法，接着启动客户端的程序，然后在控制台输入要发送的数据 这个时候就能看到效果了。

从这个简单的Demo就是服务器和客户端通过Socket 进行数据交换的一个过程。

2.2、Socket 工作过程

        1、服务端通过 ServerSocket 监听一个端口，等待客户端连接

        2、客户端创建一个Socket 对象，通过它连接到 指定端口和ip的服务器

        3、服务端接收到了客户端的连接请求，创建一个新的Socket对象 处理这个连接请求

        4、连接建立成功后，客户端和服务器可以通过 Socket 对象的输入输出流 进行数据交换

这个过程如下图所示：

 2.3、一个大胆的想法

        从上面的 demo 中我们大概知道了服务端和客户端之间可以通过 Socket 进行数据交换，那么 Tom 和 Jerry 是否也可以使用Socket 进行沟通呢，我们设计的cheese 本质上不就是解决两个服务之间进行数据交换吗。好了相信你脑子里肯定有这样的流程了

2.4、想法落地的思考

        假设 Jerry 通过原生的 Socket API 与 Tom 进行数据交换，这个思路该如何落地呢？使用Socket Jerry 和 Tom 之间可以通过网络建立连接并进行数据交换。那么是不是可以将这个过程抽象成

1、Jerry 通过 Socket 向 Tom 发送一条消息： 我需要一块奶酪，请你告诉我奶酪的位置。

2、Tom 使用 InputStream 从Socket 中读取 Jerry发送的消息

3、Tom 解析出了Jerry 发送的消息后执行查找奶酪位置的方法

4、Tom 将方法返回值 使用 OutputStream 写入Socket 

5、Jerry 通过 Socket 解析出 Tom 发送的返回内容

        这里其实涉及到了通信协议，但是我想将通信协议放到单独的章节给大家介绍，我们姑且先按照上面的5个步骤开始，也算是自己定义一个简单的协议了。

2.5、编码落地

        有了设计和思考之后，我们就可以进行编码，这里直接给出Tom 和Jerry的代码

public class Jerry {
    public static void main(String[] args) {
        try {
            Socket socket = new Socket("127.0.0.1", 10081); // 连接服务器
            BufferedReader in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
            PrintWriter out = new PrintWriter(socket.getOutputStream(), true);
            out.println("我需要一块奶酪，请你调用 findCheese 方法帮我查询奶酪的位置");
            String response = in.readLine(); // 接收服务器的响应
            System.out.println(response);
            in.close();
            out.close();
            socket.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

package org.wcan.demo;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.ServerSocket;
import java.net.Socket;

/**
 * @Description
 * @Author wcan
 * @Date 2024/11/25 下午 13:52
 * @Version 1.0
 */
public class Tom {
    public static void main(String[] args) {
        try {
            ServerSocket serverSocket = new ServerSocket(10081); // 监听端口
            System.out.println("server start ...");
            Socket clientSocket = serverSocket.accept();
            BufferedReader in = new BufferedReader(new InputStreamReader(clientSocket.getInputStream()));
            PrintWriter out = new PrintWriter(clientSocket.getOutputStream(), true);
            String message;
            while ((message = in.readLine()) != null) {
                System.out.println("Jerry: "+message);
                //执行查找的方法
                String cheese = findCheese();
                //将返回值返回给Jerry
                out.println("response: " + cheese); // 发送响应消息
            }
            in.close();
            out.close();
            clientSocket.close(