常用的RPC框架包括 Dubbo、SpringCloud、Rpcx等,RPC框架中服务端也称为提供者
XG0@3TSV3Z3`~T$7CY$HFJP.png
RPC远程调用过程

调用流程说明:

1、服务消费方(client)以本地调用方式调用服务
2、client stub接收到调用后负责将方法、参数等封装成能够进行网络传输的消息体
3、client stub将消息进行编码并发送到服务端
4、server stub收到消息后进行解码
5、server stub根据解码结果调用本地的服务
6、本地服务执行并将结果返回给server stub
7、server stub将返回导入结果进行编码并发送至消费方
8、client stub接收到消息并进行解码
9、服务消费方(client)得到结果
RPC的目标就是将2~8这些步骤都封装起来,用户无需关心其细节,只需要像调用本地方法一样即可完成远程服务调用

自定义Dubbo RPC:

模仿dubbo,消费者和提供者约定接口和协议,消费者远程调用提供者的服务,提供者返回一个字符串,消费者打印提供者返回的数据
![@H3(XLE]_HRE%1$25OV2I9.png
自定义RPC框架设计说明

设计说明:

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

代码实现:

公共接口:

  1. package dubborpc.publicinterface;
  2. /* 服务提供方和消费方都需要的接口 */
  3. public interface HelloService {
  4. String hello(String msg);
  5. }
  1. package dubborpc.provider;
  2. import dubborpc.publicinterface.HelloService;
  3. public class HelloServiceImpl implements HelloService {
  4. //当有消费方调用该方法时返回结果
  5. @Override
  6. public String hello(String msg) {
  7. System.out.println("收到客户端消息="+msg);
  8. //根据message返回不同的结果
  9. if(msg!=null){
  10. return "客户端已收到你的消息["+msg+"]";
  11. }else{
  12. return "客户端已收到你的空消息";
  13. }
  14. }
  15. }

服务器端:

  1. package dubborpc.netty;
  2. import io.netty.bootstrap.ServerBootstrap;
  3. import io.netty.channel.ChannelFuture;
  4. import io.netty.channel.ChannelInitializer;
  5. import io.netty.channel.ChannelPipeline;
  6. import io.netty.channel.EventLoopGroup;
  7. import io.netty.channel.nio.NioEventLoopGroup;
  8. import io.netty.channel.socket.SocketChannel;
  9. import io.netty.channel.socket.nio.NioServerSocketChannel;
  10. import io.netty.handler.codec.string.StringDecoder;
  11. import io.netty.handler.codec.string.StringEncoder;
  12. public class NettyServer {
  13. public static void startServer(String hostname,int port){
  14. startServer0(hostname, port);
  15. }
  16. //编写一个方法,完成对NettyServer的初始化与启动工作
  17. private static void startServer0(String hostname,int port){
  18. EventLoopGroup bossGroup = new NioEventLoopGroup(1);
  19. EventLoopGroup workGroup = new NioEventLoopGroup();
  20. try {
  21. ServerBootstrap bootstrap = new ServerBootstrap();
  22. bootstrap.group(bossGroup,workGroup)
  23. .channel(NioServerSocketChannel.class)
  24. .childHandler(new ChannelInitializer<SocketChannel>() {
  25. @Override
  26. protected void initChannel(SocketChannel ch) throws Exception {
  27. ChannelPipeline pipeline = ch.pipeline();
  28. pipeline.addLast(new StringEncoder());
  29. pipeline.addLast(new StringDecoder());
  30. pipeline.addLast(new NettyServerHandler()); //自定义业务处理器
  31. }
  32. });
  33. ChannelFuture channelFuture = bootstrap.bind(hostname, port).sync();
  34. System.out.println("服务提供方开始提供服务...");
  35. channelFuture.channel().closeFuture().sync();
  36. } catch (InterruptedException e) {
  37. e.printStackTrace();
  38. } finally {
  39. bossGroup.shutdownGracefully();
  40. workGroup.shutdownGracefully();
  41. }
  42. }
  43. }
  1. package dubborpc.netty;
  2. import dubborpc.provider.HelloServiceImpl;
  3. import io.netty.channel.ChannelHandlerContext;
  4. import io.netty.channel.ChannelInboundHandlerAdapter;
  5. /* 服务器端Handler */
  6. public class NettyServerHandler extends ChannelInboundHandlerAdapter {
  7. @Override
  8. public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
  9. // 获取客户端发送的消息并调用服务
  10. System.out.println("msg="+msg);
  11. //客户端在调用服务器API时走自定义协议,例如要求每次发送的数据必须以 "HELLORPC#"开头
  12. if(msg.toString().startsWith("HELLORPC#")){
  13. String result = new HelloServiceImpl().hello(msg.toString().substring(msg.toString().lastIndexOf("#") + 1));
  14. ctx.writeAndFlush(result);
  15. }
  16. }
  17. @Override
  18. public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
  19. ctx.close();
  20. }
  21. }
  1. package dubborpc.provider;
  2. import dubborpc.netty.NettyServer;
  3. /* ServerBootstrap会启动一个服务提供者,就是NettyServer */
  4. public class ServerBootstrap {
  5. public static void main(String[] args) {
  6. NettyServer.startServer("127.0.0.1",7000);
  7. }
  8. }

客户端:

  1. package dubborpc.netty;
  2. import io.netty.bootstrap.Bootstrap;
  3. import io.netty.channel.*;
  4. import io.netty.channel.nio.NioEventLoopGroup;
  5. import io.netty.channel.socket.SocketChannel;
  6. import io.netty.channel.socket.nio.NioSocketChannel;
  7. import io.netty.handler.codec.string.StringDecoder;
  8. import io.netty.handler.codec.string.StringEncoder;
  9. import java.lang.reflect.Proxy;
  10. import java.util.concurrent.ArrayBlockingQueue;
  11. import java.util.concurrent.ThreadPoolExecutor;
  12. import java.util.concurrent.TimeUnit;
  13. public class NettyClient {
  14. private static ThreadPoolExecutor threadPool = new ThreadPoolExecutor(8,10,
  15. 200, TimeUnit.MICROSECONDS,
  16. new ArrayBlockingQueue<>(10));
  17. private static NettyClientHandler client;
  18. /*
  19. * 编写方法使用代理模式,获取一个代理对象
  20. */
  21. public Object getBean(final Class<?> serviceClass,final String providerName){
  22. return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
  23. new Class<?>[]{serviceClass},(proxy, method, args) -> {
  24. //{} 部分的代码,客户端每调用一次hello就会进入到该代码
  25. if(client ==null){
  26. initclient(); //进行初始化
  27. }
  28. /*设置要发给服务器端的信息
  29. * @param providerName: 协议头
  30. * @param args: 客户端低啊用api hello(xxx)方法的参数
  31. */
  32. client.setPara(providerName+args[0]);
  33. return threadPool.submit(client).get(); //返回服务器返回的结果
  34. });
  35. }
  36. //初始化客户端
  37. private static void initclient(){
  38. client = new NettyClientHandler();
  39. //创建EventLoopGroup
  40. EventLoopGroup group = new NioEventLoopGroup();
  41. Bootstrap bootstrap = new Bootstrap();
  42. bootstrap.group(group)
  43. .channel(NioSocketChannel.class)
  44. .option(ChannelOption.TCP_NODELAY,true) //TCP不延时
  45. .handler(new ChannelInitializer<SocketChannel>() {
  46. @Override
  47. protected void initChannel(SocketChannel ch) throws Exception {
  48. ChannelPipeline pipeline = ch.pipeline();
  49. pipeline.addLast(new StringDecoder());
  50. pipeline.addLast(new StringEncoder());
  51. pipeline.addLast(client);
  52. }
  53. });
  54. try {
  55. bootstrap.connect("127.0.0.1", 7000).sync();
  56. } catch (InterruptedException e) {
  57. e.printStackTrace();
  58. }
  59. }
  60. }
  1. package dubborpc.netty;
  2. import io.netty.channel.ChannelHandlerContext;
  3. import io.netty.channel.ChannelInboundHandlerAdapter;
  4. import java.util.concurrent.Callable;
  5. public class NettyClientHandler extends ChannelInboundHandlerAdapter implements Callable {
  6. private ChannelHandlerContext context; //上下文
  7. private String result; //返回结果
  8. private String para; //客户端调用方法时传入的参数
  9. @Override
  10. public void channelActive(ChannelHandlerContext ctx) throws Exception {
  11. context = ctx; //在其他方法中会使用到上下文
  12. }
  13. /* 处于读取状态时将被调用 */
  14. @Override
  15. public synchronized void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
  16. result = (String) msg;
  17. notify(); //接收到服务器返回结果,唤醒等待的call线程
  18. }
  19. @Override
  20. public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
  21. ctx.close();
  22. }
  23. //被代理对象调用,发送数据给服务器后等待被唤醒
  24. @Override
  25. public synchronized Object call() throws Exception {
  26. context.writeAndFlush(para);
  27. wait();//等待服务器返回结果后被唤醒
  28. return result;
  29. }
  30. //设置参数
  31. void setPara(String para){
  32. this.para = para;
  33. }
  34. }
  1. package dubborpc.customer;
  2. import dubborpc.netty.NettyClient;
  3. import dubborpc.publicinterface.HelloService;
  4. public class ClientBootstrap {
  5. public static final String providerName = "HELLORPC#";//定义协议头
  6. public static void main(String[] args) {
  7. //创建消费者
  8. NettyClient customer = new NettyClient();
  9. //创建代理对象
  10. HelloService service = (HelloService) customer.getBean(HelloService.class, providerName);
  11. //通过代理对象调用服务提供者的方法
  12. String res = service.hello("你好,自定义Dubbo~");
  13. System.out.println("调用的结果="+res);
  14. }
  15. }

测试:

启动两个Bootstrap服务,自定义RPC框架成功实现通信
image.png