自己用 Netty 实现一个简单的 RPC

 

 目录:

  1. 需求
  2. 设计
  3. 实现
    1. 创建 maven 项目,导入 Netty 4.1.16。
    2. 项目目录结构
    3. 设计接口
    4. 提供者相关实现
    5. 消费者相关实现
    6. 测试结果
  4. 总结

源码地址:github 地址

 

前言

众所周知,dubbo 底层使用了 Netty 作为网络通讯框架,而 Netty 的高性能我们之前也分析过源码,对他也算还是比较了解了。今天我们就自己用 Netty 实现一个简单的 RPC 框架。

 

1. 需求

模仿 dubbo,消费者和提供者约定接口和协议,消费者远程调用提供者,提供者返回一个字符串,消费者打印提供者返回的数据。底层网络通信使用 Netty 4.1.16。

2. 设计

  1. 创建一个接口,定义抽象方法。用于消费者和提供者之间的约定。
  2. 创建一个提供者,该类需要监听消费者的请求,并按照约定返回数据。
  3. 创建一个消费者,该类需要透明的调用自己不存在的方法,内部需要使用 Netty 请求提供者返回数据。

3. 实现

1. 创建 maven 项目,导入 Netty 4.1.16。

 1   <groupId>cn.thinkinjava</groupId>
 2   <artifactId>rpc-demo</artifactId>
 3   <version>1.0-SNAPSHOT</version>
 4 
 5   <dependencies>
 6     <dependency>
 7       <groupId>io.netty</groupId>
 8       <artifactId>netty-all</artifactId>
 9       <version>4.1.16.Final</version>
10   </dependency>

 

 

2. 项目目录结构如下:

 

 

 

3. 设计接口

一个简单的 hello world:

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

 

 

 

4. 提供者相关实现

4.1. 首先实现约定接口,用于返回客户端数据:

1 /**
2  * 实现类
3  */
4 public class HelloServiceImpl implements HelloService {
5   public String hello(String msg) {
6     return msg != null ? msg + " -----> I am fine." : "I am fine.";
7   }
8 }

 

 

 

4.2. 实现 Netty 服务端和自定义 handler

启动 Netty Server 代码:

 1   private static void startServer0(String hostName, int port) {
 2     try {
 3       ServerBootstrap bootstrap = new ServerBootstrap();
 4       NioEventLoopGroup eventLoopGroup = new NioEventLoopGroup();
 5       bootstrap.group(eventLoopGroup)
 6           .channel(NioServerSocketChannel.class)
 7           .childHandler(new ChannelInitializer<SocketChannel>() {
 8             @Override
 9             protected void initChannel(SocketChannel ch) throws Exception {
10               ChannelPipeline p = ch.pipeline();
11               p.addLast(new StringDecoder());
12               p.addLast(new StringEncoder());
13               p.addLast(new HelloServerHandler());
14             }
15           });
16       bootstrap.bind(hostName, port).sync();
17     } catch (InterruptedException e) {
18       e.printStackTrace();
19     }
20   }

 

 

上面的代码中添加了 String类型的编解码 handler,添加了一个自定义 handler。

自定义 handler 逻辑如下:

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

 

 

这里显示判断了是否符合约定(并没有使用复杂的协议,只是一个字符串判断),然后创建一个具体实现类,并调用方法写回客户端。

还需要一个启动类:

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

 

 

好,关于提供者的代码就写完了,主要就是创建一个 netty 服务端,实现一个自定义的 handler,自定义 handler 判断是否符合之间的约定(算是协议吧),如果符合,就创建一个接口的实现类,并调用他的方法返回字符串。

 

5. 消费者相关实现

消费者有一个需要注意的地方,就是调用需要透明,也就是说,框架使用者不用关心底层的网络实现。这里我们可以使用 JDK 的动态代理来实现这个目的。

思路:客户端调用代理方法,返回一个实现了 HelloService 接口的代理对象,调用代理对象的方法,返回结果。

我们需要在代理中做手脚,当调用代理方法的时候,我们需要初始化 Netty 客户端,还需要向服务端请求数据,并返回数据。

 

5.1. 首先创建代理相关的类

 

 1 public class RpcConsumer {
 2 
 3   private static ExecutorService executor = Executors
 4       .newFixedThreadPool(Runtime.getRuntime().availableProcessors());
 5 
 6   private static HelloClientHandler client;
 7 
 8   /**
 9    * 创建一个代理对象
10    */
11   public Object createProxy(final Class<?> serviceClass,
12       final String providerName) {
13     return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
14         new Class<?>[]{serviceClass}, (proxy, method, args) -> {
15           if (client == null) {
16             initClient();
17           }
18           // 设置参数
19           client.setPara(providerName + args[0]);
20           return executor.submit(client).get();
21         });
22   }
23 
24   /**
25    * 初始化客户端
26    */
27   private static void initClient() {
28     client = new HelloClientHandler();
29     EventLoopGroup group = new NioEventLoopGroup();
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     try {
44       b.connect("localhost", 8088).sync();
45     } catch (InterruptedException e) {
46       e.printStackTrace();
47     }
48   }
49 }
View Code

 

 

 

该类有 2 个方法,创建代理和初始化客户端。

初始化客户端逻辑: 创建一个 Netty 的客户端,并连接提供者,并设置一个自定义 handler,和一些 String 类型的编解码器。

创建代理逻辑:使用 JDK 的动态代理技术,代理对象中的 invoke 方法实现如下:
如果 client 没有初始化,则初始化 client,这个 client 既是 handler ,也是一个 Callback。将参数设置进 client ,使用线程池调用 client 的 call 方法并阻塞等待数据返回。

 

 

看看 HelloClientHandler 的实现:

 

 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 }
View Code

 

 

 

该类缓存了 ChannelHandlerContext,用于下次使用,有两个属性:返回结果和请求参数。

当成功连接后,缓存 ChannelHandlerContext,当调用 call 方法的时候,将请求参数发送到服务端,等待。当服务端收到并返回数据后,调用 channelRead 方法,将返回值赋值个 result,并唤醒等待在 call 方法上的线程。此时,代理对象返回数据。

 

再看看设计的测试类:

 

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

 

 

 

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

 

 

测试结果

 

 

 

 

 

总结

看了这么久的 Netty 源码,我们终于实现了一个自己的 Netty 应用,虽然这个应用很简单,甚至代码写的有些粗糙,但功能还是实现了,RPC 的目的就是允许像调用本地服务一样调用远程服务,需要对使用者透明,于是我们使用了动态代理。并使用 Netty 的 handler 发送数据和响应数据,完成了一次简单的 RPC 调用。

当然,还是那句话,代码比较简单,主要是思路,以及了解 RPC 底层的实现。

好吧。good luck!!!!

 

posted @ 2018-04-27 09:22  莫那-鲁道  阅读(...)  评论(...编辑  收藏