使用 Netty 实现简单的 RPC 框架

Dubbo 底层使用 Netty 作为网络通信框架。
【网络传输问题】：相对于传统的 RPC 或者 RMI 等方式的远程服务过程调用采用了同步阻塞IO，当客户端的并发压力或者网络时延增长之后，同步阻塞 I/O 会由于频繁的等待导致 I/O 线程经常性阻塞，由于线程无法高效的工作，I/O处理能力自然会下降。
【序列化性能差链接】：无法跨语言、码流长、性能差。
【线程模型问题】：采用同步阻塞IO，这会导致每个 TCP 连接都占用 1个线程，由于线程资源是 JVM 虚拟机非常宝贵的资源，当 I/O 读写阻塞导致线程无法释放时，会导致性能急剧下降。

一、设计思想

---

模仿 Dubbo 的消费者和提供者约定接口和协议，消费者远程调用提供者，提供者返回数据，消费者打印提供者返回的数据。
【1】创建一个接口，定义抽象方法。用于消费者和提供者之间的约定。
【2】创建一个提供者，该类需要监听消费者的请求，并按照约定返回数据。
【3】创建一个消费者，该类需要透明的调用自己不存在的方法，内部需要使用 Netty 请求提供者返回数据。

二、服务端

---

【1】添加 Netty Maven 依赖：

1 <dependencies>
2     <dependency>
3         <groupId>io.netty</groupId>
4         <artifactId>netty-all</artifactId>
5         <version>4.1.16.Final</version>
6     </dependency>
7 </dependencies>    

【2】首先准备客户端和服务端需要的公共接口：

1 public interface HelloInterface {
2     String hello(String msg);
3 }

【3】服务端实现 HelloInterface 接口：

1 public class HelloImpl implements HelloInterface {
2     @Override
3     public String hello(String msg) {
4         //返回客户端的消息
5         return msg != null ? msg + " -----> I am fine." : "I am fine.";
6     }
7 }

【4】实现 Netty Server 端代码（代码固定，通常作为公共代码使用）：

 1 public class Provider {
 2
 3     static void startServer(String hostName, int port) {
 4         //配置服务端的 NIO 线程组
 5         NioEventLoopGroup bossGroup = new NioEventLoopGroup();
 6         NioEventLoopGroup workerGroup = new NioEventLoopGroup();
 7         try {
 8             ServerBootstrap bootstrap = new ServerBootstrap();
 9             bootstrap.group(bossGroup,workerGroup)
10                     .channel(NioServerSocketChannel.class)
11                     .childHandler(new ChannelInitializer<SocketChannel>() {
12                         @Override
13                         protected void initChannel(SocketChannel ch) throws Exception {
14                             ChannelPipeline p = ch.pipeline();
15                             //字符串的编解码器
16                             p.addLast(new StringDecoder());
17                             p.addLast(new StringEncoder());
18                             p.addLast(new HelloHandler());
19                         }
20                     });
21             //绑定端口，同步等待成功
22             ChannelFuture f = bootstrap.bind(hostName, port).sync();
23             //等待服务端监听端口关闭
24             f.channel().closeFuture().sync();
25         } catch (InterruptedException e) {
26             e.printStackTrace();
27         }finally {
28             //优雅退出释放线程池资源
29             //bossGroup.shutdownGracefully();
30             //workerGroup.shutdownGracefully();
31         }
32     }
33 }

【5】服务端对应的 HelloHandler 类的实现：实现 ChannelInboundHandlerAdapter 适配器，对客户端发送的消息进行处理。这里显示判断了是否符合约定（并没有使用复杂的协议，只是一个字符串判断），然后创建一个具体实现类，并调用方法写回客户端。

 1 public class HelloHandler extends ChannelInboundHandlerAdapter {
 2     @Override
 3     public void channelRead(ChannelHandlerContext ctx, Object msg) {
 4
 5              // 如何符合约定，则调用本地方法，返回数据
 6              if (msg.toString().startsWith(ClientBootstrap.providerName)) {
 7                    String result = new HelloImpl()
 8                        .hello(msg.toString().substring(msg.toString().lastIndexOf("#") + 1));
 9                    ctx.writeAndFlush(result);
10                  }
11            }
12 }

【6】服务端启动类：先运行服务端，后运行客户端；

1 public class Bootstrap {
2    public static void main(String[] args) {
3              Provider.startServer("localhost", 8088);
4    }
5 }

三、客户端

---

消费者有一个需要注意的地方，就是调用需要透明，也就是说，框架使用者不用关心底层的网络实现。这里我们可以使用 JDK 的动态代理【链接】来实现这个目的。思路是客户端调用代理方法，返回一个实现了 HelloService 接口的代理对象，调用代理对象的方法，返回结果。当调用代理方法的时候，我们需要初始化 Netty 客户端，还需要向服务端请求数据，并返回数据。

【1】首先创建代理相关的类：该类有 2 个方法，创建代理和初始化客户端。初始化客户端逻辑： 创建一个 Netty 的客户端，并连接提供者，并设置一个自定义 handler，和一些 String 类型的编解码器。创建代理逻辑：使用 JDK 的动态代理技术，代理对象中的 invoke 方法实现如下：如果 client 没有初始化，则初始化 client，这个 client 既是 handler ，也是一个 Callback。将参数设置进 client ，使用线程池调用 client 的 call 方法并阻塞等待数据返回。

 1 public class Consumer {
 2     private static ExecutorService executor = Executors
 3             .newFixedThreadPool(Runtime.getRuntime().availableProcessors());
 4
 5     private static HelloClientHandler client;
 6
 7     /**
 8      * 创建一个代理对象
 9      */
10     public Object createProxy(final Class<?> serviceClass,
11                               final String providerName) {
12         return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
13                 new Class<?>[]{serviceClass}, (proxy, method, args) -> {
14                     if (client == null) {
15                         initClient();
16                     }
17                     // 设置参数
18                     client.setPara(providerName + args[0]);
19                     return executor.submit(client).get();
20                 });
21     }
22
23     /**
24      * 初始化客户端
25      */
26     private static void initClient() {
27         client = new HelloClientHandler();
28         EventLoopGroup group = new NioEventLoopGroup();
29         try {
30             Bootstrap b = new Bootstrap();
31             b.group(group)
32                     .channel(NioSocketChannel.class)
33                     .option(ChannelOption.TCP_NODELAY, true)
34                     .handler(new ChannelInitializer<SocketChannel>() {
35                         @Override
36                         public void initChannel(SocketChannel ch) throws Exception {
37                             ChannelPipeline p = ch.pipeline();
38                             p.addLast(new StringDecoder());
39                             p.addLast(new StringEncoder());
40                             p.addLast(client);
41                         }
42                     });
43             //发起异步连接操作
44             ChannelFuture f = b.connect("localhost", 8088).sync();
45             //等待客户端关闭连接
46             f.channel().closeFuture().sync();
47         } catch (InterruptedException e) {
48             e.printStackTrace();
49         }finally {
50             //group.shutdownGracefully();
51         }
52     }
53 }

【2】客户端 Netty 中 HelloClientHandler 类的实现：该类缓存了 ChannelHandlerContext，用于下次使用，有两个属性：返回结果和请求参数。当成功连接后，缓存 ChannelHandlerContext，当调用 call 方法的时候，将请求参数发送到服务端，等待。当服务端收到并返回数据后，调用 channelRead 方法，将返回值赋值个 result，并唤醒等待在 call 方法上的线程。此时，代理对象返回数据。

 1 public class HelloClientHandler extends ChannelInboundHandlerAdapter implements Callable {
 2
 3     private ChannelHandlerContext context;
 4     private String result;
 5     private String para;
 6
 7     @Override
 8     public void channelActive(ChannelHandlerContext ctx) {
 9         context = ctx;
10     }
11
12     /**
13      * 收到服务端数据，唤醒等待线程
14      */
15     @Override
16     public synchronized void channelRead(ChannelHandlerContext ctx, Object msg) {
17         result = msg.toString();
18         notify();
19     }
20
21     /**
22      * 写出数据，开始等待唤醒
23      */
24     @Override
25     public synchronized Object call() throws InterruptedException {
26         context.writeAndFlush(para);
27         wait();
28         return result;
29     }
30
31     void setPara(String para) {
32         this.para = para;
33     }
34 }

四、测试

---

首先创建了一个代理对象，然后每隔一秒钟调用代理的 hello 方法，并打印服务端返回的结果。

 1 public class ClientBootstrap {
 2     public static final String providerName = "HelloService#hello#";
 3
 4     public static void main(String[] args) throws InterruptedException {
 5
 6         Consumer consumer = new Consumer();
 7         // 创建一个代理对象
 8         HelloInterface service = (HelloInterface) consumer
 9                 .createProxy(HelloInterface.class, providerName);
10         for (; ; ) {
11             Thread.sleep(1000);
12             System.out.println(service.hello("are you ok ?"));
13         }
14     }
15 }

结果展示：
​