手写dubbo 3-服务治理(服务注册-zookeeper)

    博客中代码地址：https://github.com/farliu/farpc.git

    在前两章，铺垫的已经够多了，本章我们来看看具体如何基于zookeeper实现服务注册，show you my code.

项目结构介绍

    本节涉及博客中代码的module：farpc-registry（服务治理）。

    farpc-registry秉承可扩展的设计思路，提供一个接口IRegistrar。统一规范管理注册中心的实现方式。

public interface IRegistrar {

    /**
     * 初始化
     * @param registerAddress zookeeper地址，例如127.0.0.1:2181
     */
    void init(String registerAddress);

    /**
     * 注册服务
     * @param providerAddress 服务提供者地址
     * @param service 服务
     */
    void register(String providerAddress, String service);
}

初始化zookeeper

    本章使用zookeeper实现实现注册中心，首先要解决的就是程序如何使用zookeeper，这里选择curator操作zookeeper。那么先依赖maven。

 <dependencies>
    <dependency>
        <groupId>org.apache.curator</groupId>
        <artifactId>curator-framework</artifactId>
        <version>2.5.0</version>
    </dependency>
    <dependency>
        <groupId>org.apache.curator</groupId>
        <artifactId>curator-recipes</artifactId>
        <version>2.5.0</version>
    </dependency>
</dependencies>

    这里实现IRegistrar接口，分别介绍实现的两个方法，第一个初始化zookeeper的连接。

private static final int SESSION_TIMEOUT_MS = 5000;
private static final int SLEEP_TIME_MS = 1000;
private static final int MAX_RETRIES = 2;

public void init(String registerAddress){
    curatorFramework = CuratorFrameworkFactory.builder()
            .connectString(registerAddress)
            .sessionTimeoutMs(SESSION_TIMEOUT_MS)
            .retryPolicy(new ExponentialBackoffRetry(SLEEP_TIME_MS, MAX_RETRIES))
            .build();

    curatorFramework.start();
}

服务注册

    服务注册，说到底就是在zookeeper中创建一个个的目录节点，由这一个个的节点来充当服务和服务提供者。代码如下：

private static final String SEPARATOR = "/";
private static final String FOLDER = "/faregistrys";

public void register(String providerAddress, String service) {
    try {
        String servicePath = FOLDER + SEPARATOR + service;
        Stat stat = curatorFramework.checkExists().forPath(servicePath);
        if (stat == null) {   // ----- 1
			//  ---  2
            curatorFramework.create().creatingParentsIfNeeded()
                    .withMode(CreateMode.PERSISTENT).forPath(servicePath);
        }
        String provider = servicePath + SEPARATOR + providerAddress;

		// ---- 3
        curatorFramework.create().withMode(CreateMode.EPHEMERAL)
                .forPath(provider);
        logger.info("provider:{} is registered to {}", providerAddress, servicePath);
    } catch (Exception e) {

        logger.error(e.getMessage(), e);
    }
}

    假如我们要注册的服务为：com.ofcoder.farpc.demo.api.IWelcome。分别解析代码中所标注的1、2、3点。

    第一点，就是判断/faregistrys/com.ofcoder.farpc.demo.api.IWelcome该目录是否存在，存在则不创建，因为我们有提到过，zookeeper中目录路径是唯一的。再创建会报错的昂。这里多说一句，你应该使用double-check-lock。
    第二点和第三点，都是创建，不同的区别在于，CreateMode不同，分别传入的参数是PERSISTENT（永久）、EPHEMERAL（临时）。provider的信息为什么要设置成临时的。是因为，服务在注册后可以永久生效。但是provider可能因为发版或者服务宕机导致服务不可用，而这时它不应该存在该服务的provider列表中。设置为EPHEMERAL，当你的服务宕机时，zookeeper将自动移除掉这个路径。以此达到服务的动态注册和发现

    那么我们测试一下代码

public class ProviderTest {

    @Test
    public void test() throws IOException {
        IRegistrar registrar = new ZookeeperRegistrarImpl();
        registrar.init("127.0.0.1:2181");
        registrar.register("127.0.0.1:20880", "com.ofcoder.farpc.demo.api.IWelcome");
        System.in.read();
    }
}

    打开zookeeper客户端验证。

[zk: localhost:2181(CONNECTED) 6] ls /faregistrys
[com.ofcoder.farpc.demo.api.IWelcome]
[zk: localhost:2181(CONNECTED) 7] ls /faregistrys/com.ofcoder.farpc.demo.api.IWelcome
[127.0.0.1:20880]
[zk: localhost:2181(CONNECTED) 8]

dubbo源码

    dubbo源码很容易找，我都是直接使用dubbo命名，我们可以在dubbo-registry找到对应的代码，可对比我们所实现的代码，肯定是有很多共性的。

ZookeeperRegistry.doRegister()
public void doRegister(URL url) {
    try {
        zkClient.create(toUrlPath(url), url.getParameter(DYNAMIC_KEY, true));
    } catch (Throwable e) {
        throw new RpcException("Failed to register " + url + " to zookeeper " + getUrl() + ", cause: " + e.getMessage(), e);
    }
}

AbstractZookeeperClient.create()
public void create(String path, boolean ephemeral) {
    if (!ephemeral) {
		// 不存在则创建
        if (checkExists(path)) {
            return;
        }
    }
    int i = path.lastIndexOf('/');
    if (i > 0) {
        create(path.substring(0, i), false);
    }
    if (ephemeral) {
        createEphemeral(path);
    } else {
        createPersistent(path);
    }
}

    以上为服务注册的代码，是不是有跟我们逻辑一样的代码，例如：服务节点不存在则创建。而我们也同样找到了创建永久目录节点和临时目录节点的代码，createEphemeral(path);和 createPersistent(path);

    我们还可以，可以在zookeeper的客户端，找到dubbo存储结构。

[zk: localhost:2181(CONNECTED) 4] ls /dubbo/com.ofcoder.farpc.demo.api.IWelcome
[consumers, configurators, routers, providers]
[zk: localhost:2181(CONNECTED) 5] ls /dubbo/com.ofcoder.farpc.demo.api.IWelcome/providers
[dubbo%3a%2f%2f127.0.0.1%3a20880%2fcom.ofcoder.farpc.demo.api.IWelcome%3fanyhost%3dtrue%26application%3ddubbo-demo%26default.delay%3d-1%26default.loadbalance%3dleastactive%26default.retries%3d2%26default.threadpool%3dfixed%26default.threads%3d500%26default.timeout%3d5000%26delay%3d-1%26dubbo%3d2.6.0%26generic%3dfalse%26interface%3dcom.ofcoder.farpc.demo.api.IWelcome%26methods%3dgreet%26organization%3ddemo%26owner%3dofcoder%26pid%3d23541%26revision%3d0.0.1-SNAPSHOT%26side%3dprovider%26timestamp%3d1561962179716]
[zk: localhost:2181(CONNECTED) 6] 

总结

    以上就是zookeeper服务注册的一个实现。感觉写博客，直接贴代码是最傻的。但是又不知道如何表达我想说的，希望后面可以找到一个讲述清楚的方式吧。