【开源项目】EasyRpc——一个简单的RPC框架

EasyRpc——一个简单的RPC框架

项目介绍

easy-RPC 是一款低性能的服务框架，主要用于学习造轮子！

学习本项目可以让你从零开始实现一个类似 Dubbo 服务框架 mini 版RPC。

如果你认真学下来，可以掌握以下的技术：

1. 底层网络层基于 netty，学完 netty 入门没有问题；
2. 使用自定义注解，学完可以了解注解的基本运行机制；
3. 服务注册基于 zookeeper，学完 zk 入门没有问题；
4. 会用到反射机制；
5. 会用到动态代理技术；
6. 教你如何定义一个 xxx-spring-boot-starter，了解spring boot自动配置机制；
7. 学会如何自定义配置项，并绑定到 bean；
8. 学习监听 spring 容器的事件；

入门案例

入门案例

实现原理

服务端

1. 因为引入了easy-rpc-spring-boot-starter，所以会加载spring.factories里面的AutoConfiguration。AutoConfiguration会初始化DefaultRpcListener。
2. DefaultRpcListener初始化。因为DefaultRpcListener实现了ApplicationListener<ContextRefreshedEvent>，所以会重写onApplicationEvent方法，主要初始化了RpcServer和RpcClient。
3. 注册服务实例接口信息。获取容器中带有注解ServiceExpose的Bean，DefaultRpcListener#registerInstanceInterfaceInfo，将服务名和对应的实例存放到本地map中，且注册到远程服务器上。
4. 启动网络通信服务器，开始监听指定端口。NettyRpcServer#start。该方法主要是用到了Netty，而最核心的是ChannelRequestHandler，该类实现了ChannelInboundHandlerAdapter，当有消息进来，会执行channelRead方法。
5. 获取到对应的方法，RequestHandler#handleRequest，根据RpcRequest获取serviceName，再根据serviceName获取ServiceInterfaceInfo，从而获取到对应的Class和实例。

客户端

1. DefaultRpcListener#initRpcClient，找到所有属性带有注解ServiceReference的Bean，重新设置属性clientProxyFactory.getProxyInstance(fieldClass)。根据服务名称获取远程实例。
2. 代理方法。封装接口信息，调用接口NettyRpcClient#sendMessage。获取到服务端的响应，返回数据。

    //获取代理实例
	public <T> T getProxyInstance(Class<T> clazz) {
        return (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{clazz}, new InvocationHandler() {
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                // 第一步：通过服务发现机制选择一个服务提供者暴露的服务
                String serviceName = clazz.getName();
                ServiceInterfaceInfo serviceInterfaceInfo = serviceDiscovery.selectOneInstance(serviceName);
                logger.info("Rpc server instance list: {}", serviceInterfaceInfo);
                if (serviceInterfaceInfo == null) {
                    throw new RpcException("No rpc servers found.");
                }

                // 第二步：构造 rpc 请求对象
                final RpcRequest rpcRequest = new RpcRequest();
                rpcRequest.setServiceName(serviceName);
                rpcRequest.setMethodName(method.getName());
                rpcRequest.setParameterTypes(method.getParameterTypes());
                rpcRequest.setParameters(args);

                // 第三步：编码请求消息， TODO: 这里可以配置多种编码方式
                byte[] data = messageProtocol.marshallingReqMessage(rpcRequest);

                // 第四步：调用 rpc client 开始发送消息
                byte[] byteResponse = rpcClient.sendMessage(data, serviceInterfaceInfo);

                // 第五步：解码响应消息
                final RpcResponse rpcResponse = messageProtocol.unmarshallingRespMessage(byteResponse);

                // 第六步：解析返回结果进行处理
                if (rpcResponse.getException() != null) {
                    throw rpcResponse.getException();
                }
                return rpcResponse.getRetValue();
            }
        });
    }

总结

1. 连接服务端，bootstrap.connect(ip, port).sync();。服务端的启动方式是ChannelFuture channelFuture = serverBootstrap.bind(port).sync();。

2. 服务注册与发现。

//ZookeeperServiceRegistry#register         
public void register(ServiceInterfaceInfo serviceInterfaceInfo) throws Exception {
             logger.info("Registering service: {}", serviceInterfaceInfo);
     
             super.register(serviceInterfaceInfo);
     
             // 创建 ZK 永久节点（服务节点）
             String serviceName = serviceInterfaceInfo.getServiceName();
             String servicePath = "/com/leixiaoshuai/easyrpc/service/" + serviceName;
             if (!zkClient.exists(servicePath)) {
                 zkClient.createPersistent(servicePath, true);
                 logger.info("Created node: {}", servicePath);
             }
     
             // 创建 ZK 临时节点（实例节点）
             String uri = JSON.toJSONString(serviceInterfaceInfo);
             uri = URLEncoder.encode(uri, "UTF-8");
             String uriPath = servicePath + "/" + uri;
             if (zkClient.exists(uriPath)) {
                 zkClient.delete(uriPath);
             }
             zkClient.createEphemeral(uriPath);
             logger.info("Created ephemeral node: {}", uriPath);
         }

// Nacos注册服务
    public void register(ServiceInterfaceInfo serviceInterfaceInfo) throws Exception {
        super.register(serviceInterfaceInfo);
        // 注册当前服务实例
        naming.registerInstance(serviceInterfaceInfo.getServiceName(), buildInstance(serviceInterfaceInfo));
    }
 
//Nacos服务发现
    public ServiceInterfaceInfo selectOneInstance(String serviceName) {
        Instance instance;
        try {
            // 调用 nacos 提供的接口，随机挑选一个服务实例，负载均衡的算法依赖 nacos 的实现
            instance = namingService.selectOneHealthyInstance(serviceName);
        } catch (NacosException e) {
            log.error("Nacos exception", e);
            return null;
        }

        // 封装实例对象返回
        ServiceInterfaceInfo serviceInterfaceInfo = new ServiceInterfaceInfo();
        serviceInterfaceInfo.setServiceName(instance.getServiceName());
        serviceInterfaceInfo.setIp(instance.getIp());
        serviceInterfaceInfo.setPort(instance.getPort());
        return serviceInterfaceInfo;
    }

//Zookeeper服务发现
    public ServiceInterfaceInfo selectOneInstance(String serviceName) {
        String servicePath = "/com/leixiaoshuai/easyrpc/service/" + serviceName;
        final List<String> childrenNodes = zkClient.getChildren(servicePath);

        return Optional.ofNullable(childrenNodes)
                .orElse(new ArrayList<>())
                .stream()
                .map(node -> {
                    try {
                        // 将服务信息经过 URL 解码后反序列化为对象
                        String serviceInstanceJson = URLDecoder.decode(node, "UTF-8");
                        return JSON.parseObject(serviceInstanceJson, ServiceInterfaceInfo.class);
                    } catch (UnsupportedEncodingException e) {
                        logger.error("Fail to decode", e);
                    }
                    return null;
                }).filter(Objects::nonNull).findAny().get();
    }

项目源码

• https://github.com/CoderLeixiaoshuai/easy-rpc