[网络协议]手把手教你写一个RPC框架（二）

承接着上一节，手把手教你写一个RPC框架（一） 我们手写了一个Spring Boot Starter，开启了自己造轮子的第一步，这一节，我们继续来完成RPC框架吧！

五 自定义注解

我的需求时，使用我的RPC框架时，服务提供者可以通过注解的方式，告知框架哪些接口可以被远程过程调用，也就是将服务暴露出去；同时，服务消费者也可以通过注解的方式，把需要调用的远程服务的接口注入进来，从而调用它其中的方法。因此，我决定编写两个注解：

• @ZhonggerRpcServiceProvider：服务提供者注解，被该注解标注的接口，可以对外暴露服务
• @ZhonggerRpcServiceReference：服务消费者注解，可以将被@ZhonggerRpcServiceProvider标注的远程接口注入到本地，从而进行远程调用

@ZhonggerRpcServiceProvider的实现如下：

package com.zhongger.rpc.annotation;

import org.springframework.stereotype.Component;

import java.lang.annotation.*;

/**
 * 被@ZhonggerRpcServiceProvider标记的接口，负责对外暴露服务
 *
 * @author zhongmingyi
 * @date 2021/12/10 8:58 下午
 */
@Target(ElementType.TYPE) //作用域为类、接口、Enum
@Retention(RetentionPolicy.RUNTIME) //注解保留时间长短：在运行时有效
@Component //可以注入到Spring容器中
@Documented //Javadoc工具会将此注解标记元素的注解信息包含在javadoc中
public @interface ZhonggerRpcServiceProvider {
}

@ZhonggerRpcServiceReference的实现如下：

package com.zhongger.rpc.annotation;

import org.springframework.stereotype.Component;

import java.lang.annotation.*;

/**
 * 注入远程服务的接口，用于服务消费者
 *
 * @author zhongmingyi
 * @date 2021/12/10 9:37 下午
 */
@Target(ElementType.TYPE) //作用域为类、接口、Enum
@Component //可以注入到Spring容器中
@Retention(RetentionPolicy.RUNTIME)//注解保留时间长短：在运行时有效
@Documented //Javadoc工具会将此注解标记元素的注解信息包含在javadoc中
public @interface ZhonggerRpcServiceReference {
}

两个注解的定义都使用了三个元注解：

• @Target：表明该注解可以应用的Java元素类型，其中ElementType.TYPE应用于类、接口（包括注解类型）、枚举
• @Retention：表明该注解的生命周期，其中RetentionPolicy.RUNTIME 表明注解的生命周期是运行时
• @Documented：表明该注解标记的元素可以被Javadoc 或类似的工具文档化

使用了一个Spring注解：

• @Component：表明该接口标注的类可以被注入到Spring容器中，可以由Spring进行管理

截止到目前，我们只是定义了两个注解，这两个注解功能的实现，我们留在后面～

六 Zookeeper注册中心

Zookeeper是Apache Hadoop的子项目，是一个树型的目录服务，支持变更推送，适合作为 Dubbo 服务的注册中心，工业强度较高，可用于生产环境，并推荐使用 Dubbo官方文档

由于Dubbo这样优秀的RPC框架都使用了Zookeeper作为注册中心，可以见得Zookeeper的稳定性还是可以经得住考验的，于是我的RPC框架也决定使用Zookeeper作为注册中心。Zookeeper的安装就不在这里写了，网上还是非常多教程的。回顾下RPC框架的原理，服务提供者需要把自己的IP地址、端口号、要提供的服务注册到注册中心里，服务消费者才可以从注册中心找到服务提供者的地址，从而发送网络请求调用相应的服务。那么，现在我们来编写连接Zookeeper的代码。

我采用的操作Zookeeper的工具是Apache Curator。

<dependency>
	<groupId>org.apache.curator</groupId>
	<artifactId>curator-recipes</artifactId>
	<version>${curator.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-framework</artifactId>
    <version>${curator.version}</version>
</dependency>

首先定义一个接口 RpcServiceRegister（后续方便扩展，以后如果不采用Zookeeper作为注册中心时，可以采用其他的实现）

import com.zhongger.rpc.entity.ServerNode;
/**
 * 服务注册
 *
 * @author zhongmingyi
 * @date 2021/12/11 12:13 下午
 */
public interface RpcServiceRegister {
    /**
     * 将服务节点注册到注册中心
     *
     * @param serverNode
     */
    void register(ServerNode serverNode) throws Exception;

    /**
     * 返回注册中心使用的客户端
     *
     * @return
     */
    Object getRegisterCenterClient();
}

定义ZookeeperRpcServiceRegister 类实现RpcServiceRegister 接口：

package com.zhongger.rpc.register.impl;

import com.alibaba.fastjson.JSON;
import com.zhongger.rpc.entity.ServerNode;
import com.zhongger.rpc.register.RpcServiceRegister;
import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.CuratorFrameworkFactory;
import org.apache.curator.retry.RetryNTimes;
import org.apache.zookeeper.CreateMode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.net.URLEncoder;

/**
 * @author zhongmingyi
 * @date 2021/12/11 12:20 下午
 */
public class ZookeeperRpcServiceRegister implements RpcServiceRegister {
    private static final Logger logger = LoggerFactory.getLogger(ZookeeperRpcServiceRegister.class);

    private CuratorFramework zookeeperClient;

    public ZookeeperRpcServiceRegister(String zookeeperAddress) {
        zookeeperClient = CuratorFrameworkFactory.
                builder().
                connectString(zookeeperAddress).
                sessionTimeoutMs(10000).
                retryPolicy(new RetryNTimes(3, 5000)).
                namespace("rpc-register-center").
                build();
        logger.info("init zookeeper client success {}", zookeeperAddress);
    }


    @Override
    public void register(ServerNode serverNode) throws Exception {
        logger.info("register server node info is {}", serverNode);
        String uri = JSON.toJSONString(serverNode);
        uri = URLEncoder.encode(uri, "UTF-8");

        String servicePath = "/com/zhongger/rpc/" + serverNode.getServerName() + "/service";
        // 创建永久节点
        if (zookeeperClient.checkExists().forPath(servicePath) == null) {
            logger.info("service path {} not exist create persistent node ", servicePath);
            zookeeperClient.create().creatingParentsIfNeeded().withMode(CreateMode.PERSISTENT).forPath(servicePath);
        }

        //创建临时节点
        String uriPath = servicePath + "/" + uri;
        logger.info("uri path is {}", uriPath);
        if (zookeeperClient.checkExists().forPath(uriPath) != null) {
            zookeeperClient.delete().forPath(uriPath);
        }
        zookeeperClient.create().creatingParentsIfNeeded().withMode(CreateMode.EPHEMERAL).forPath(uriPath);
    }

    @Override
    public Object getRegisterCenterClient() {
        return zookeeperClient;
    }
}

Zookeeper连接类的初始化中，有下面几个点：

• 连接的IP地址和端口号为：zookeeperAddress
• Session超时时间为10s
• 重试策略为3，5000
• 命名空间为：rpc-register-center

编写一个@ConfigurationProperties类，被@ConfigurationProperties 标注的类可以使用application.properties 文件进行配置。

package com.zhongger.rpc.properties;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * RPC服务信息配置类，对应application.yml中的配置
 *
 * @author zhongmingyi
 * @date 2021/12/10 9:54 下午
 */
@ConfigurationProperties(prefix = "com.zhongger.rpc")
@Data
@Component //表明这是一个Spring组件
public class ZhonggerRpcProperties {
    //服务名称
    private String applicationName;
    //Zookeeper注册中心地址
    private String zookeeperAddress;
    //RPC服务暴露的端口号
    private Integer servicePort;
}

ZhonggerRpcProperties类我们需要交给Spring容器进行管理，因此将它写入配置类AutoConfiguration中：

package com.zhongger.rpc.config;

import com.zhongger.rpc.properties.ZhonggerRpcProperties;
import com.zhongger.rpc.register.impl.ZookeeperRpcServiceRegister;
import com.zhongger.rpc.service.StarterDemoService;
import com.zhongger.rpc.service.StarterDemoServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author zhongmingyi
 * @date 2021/12/7 6:40 下午
 */
@Configuration
public class AutoConfiguration {

    /**
     * 配置文件与类属性绑定
     * @return
     */
    @Bean
    public ZhonggerRpcProperties getZhonggerRpcProperties() {
        return new ZhonggerRpcProperties();
    }
	/**
     * 返回Zookeeper注册中心，其中Zookeeper的Ip+Port由配置文件动态配置并与ZhonggerRpcProperties类的zookeeperAddress属性绑定
     * 作为ZookeeperRpcServiceRegister的构造方法的参数
     *
     * @param properties
     * @return
     */
    @Bean
    public ZookeeperRpcServiceRegister getZookeeperRpcServiceRegister(@Autowired ZhonggerRpcProperties properties) {
        return new ZookeeperRpcServiceRegister(properties.getZookeeperAddress());
    }

}

好了，注册中心Zookeeper编写完成，现在来使用项目zhongger-rpc-consumer来测试下：

• 首先在application.properties中配置Zookeeper的地址

com.zhongger.rpc.zookeeper-address=127.0.0.1:2181

• Controller中注入ZookeeperRpcServiceRegister ，调用其方法，启动项目

package com.zhongger.rpc.consumer.controller;

import com.zhongger.rpc.properties.ZhonggerRpcProperties;
import com.zhongger.rpc.register.impl.ZookeeperRpcServiceRegister;
import com.zhongger.rpc.service.StarterDemoService;
import org.apache.curator.framework.CuratorFramework;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author zhongmingyi
 * @date 2021/12/7 7:52 下午
 */
@RestController
public class StarterDemoController {
    @Autowired
    private ZookeeperRpcServiceRegister zookeeperRpcServiceRegister;
    @GetMapping("/testZookeeper")
    public String testZookeeper() {
        CuratorFramework zkClient = (CuratorFramework) zookeeperRpcServiceRegister.getRegisterCenterClient();
        return "zookeeper init success namespace is " + zkClient.getNamespace();
    }
}

• 浏览器访问：http://localhost:8080/testZookeeper，发现Zookeeper的命名空间与初始化时是一致的：rpc-register-center，可以表明连接成功！

好了，今天的文章就写到这里，如果大家喜欢这个系列，别忘了一键三连哦！我们下期见！