eureka

发布日期: 2021-04-05

作者: 欧阳思海

文章字数: 3.9k

阅读时长: 16 分

阅读次数:

本人花费半年的时间总结的《Java面试指南》已拿腾讯等大厂offer，已开源在github ，欢迎star！

本文GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录，这是我花了6个月总结的一线大厂Java面试总结，本人已拿大厂offer，欢迎star

原文链接：blog.ouyangsihai.cn >> 注册中心 Eureka 源码解析 —— EndPoint 与解析器

本文主要基于 Eureka 1.8.X 版本

1. 概述
1. EndPoint
2.1 EurekaEndpoint
2.2 DefaultEndpoint
2.3 AwsEndpoint
1. 解析器
3.1 ClusterResolver
3.2 ClosableResolver
3.3 DnsTxtRecordClusterResolver
3.4 ConfigClusterResolver
3.5 ZoneAffinityClusterResolver

3.6 AsyncResolver

3.6.1 定时任务
3.6.2 解析 EndPoint 集群

1. 概述

本文主要分享 EndPoint 与解析器。

EndPoint ，服务端点。例如，Eureka-Server 的访问地址。
EndPoint 解析器，将配置的 Eureka-Server 的访问地址解析成 EndPoint 。

目前有多种 Eureka-Server 访问地址的配置方式，本文只分享 Eureka 1.x 的配置，不包含 Eureka 1.x 对 Eureka 2.x 的兼容配置：

第一种，直接配置实际访问地址。例如，eureka.serviceUrl.defaultZone=http://127.0.0.1:8080/v2 。
第二种，基于 DNS 解析出访问地址。例如，eureka.shouldUseDns=true 并且eureka.eurekaServer.domainName=eureka.iocoder.cn 。

本文涉及类在 com.netflix.discovery.shared.resolver 包下，涉及到主体类的类图如下( 打开大图 )：

红色部分 —— EndPoint
黄色部分 —— EndPoint 解析器

推荐 Spring Cloud 书籍：

请支持正版。下载盗版，等于主动编写低级 BUG 。
程序猿DD —— 《Spring Cloud微服务实战》
周立 —— 《Spring Cloud与Docker微服务架构实战》
两书齐买，京东包邮。

推荐 Spring Cloud 视频：

Java 微服务实践 - Spring Boot
Java 微服务实践 - Spring Cloud
Java 微服务实践 - Spring Boot / Spring Cloud

2. EndPoint

2.1 EurekaEndpoint

com.netflix.discovery.shared.resolver.EurekaEndpoint ，Eureka 服务端点接口，实现代码如下：


public interface EurekaEndpoint extends ComparableObject {

    /**
     * @return 完整的服务 URL
     */
    String getServiceUrl();

    /**
     * @deprecated use {@link #getNetworkAddress()}
     */
    @Deprecated
    String getHostName();

    /**
     * @return 网络地址
     */
    String getNetworkAddress();

    /**
     * @return 端口
     */
    int getPort();

    /**
     * @return 是否安全( https )
     */
    boolean isSecure();

    /**
     * @return 相对路径
     */
    String getRelativeUri();

}

2.2 DefaultEndpoint

com.netflix.discovery.shared.resolver.DefaultEndpoint ，默认 Eureka 服务端点实现类。实现代码如下：


public class DefaultEndpoint implements EurekaEndpoint {

    /**
     * 网络地址
     */
    protected final String networkAddress;
    /**
     * 端口
     */
    protected final int port;
    /**
     * 是否安全( https )
     */
    protected final boolean isSecure;
    /**
     * 相对地址
     */
    protected final String relativeUri;
    /**
     * 完整的服务 URL
     */
    protected final String serviceUrl;

    public DefaultEndpoint(String serviceUrl) {
        this.serviceUrl = serviceUrl;

        // 将 serviceUrl 分解成 几个属性
        try {
            URL url = new URL(serviceUrl);
            this.networkAddress = url.getHost();
            this.port = url.getPort();
            this.isSecure = "https".equals(url.getProtocol());
            this.relativeUri = url.getPath();
        } catch (Exception e) {
            throw new IllegalArgumentException("Malformed serviceUrl: " + serviceUrl);
        }
    }

    public DefaultEndpoint(String networkAddress, int port, boolean isSecure, String relativeUri) {
        this.networkAddress = networkAddress;
        this.port = port;
        this.isSecure = isSecure;
        this.relativeUri = relativeUri;

        // 几个属性 拼接成 serviceUrl
        StringBuilder sb = new StringBuilder().append(isSecure ? "https" : "http").append("://").append(networkAddress);
        if (port = 0) {
            sb.append(':').append(port);
        }
        if (relativeUri != null) {
            if (!relativeUri.startsWith("/")) {
                sb.append('/');
            }
            sb.append(relativeUri);
        }
        this.serviceUrl = sb.toString();
    }
}

重写了 #equals(…) 和 #hashCode(…) 方法，标准实现方式，这里就不贴代码了。
重写了 #compareTo(…) 方法，基于 serviceUrl 属性做比较。

2.3 AwsEndpoint

com.netflix.discovery.shared.resolver.aws.AwsEndpoint ，基于 region、zone 的 Eureka 服务端点实现类 ( 请不要在意 AWS 开头 )。实现代码如下：


public class AwsEndpoint extends DefaultEndpoint {

    /**
     * 区域
     */
    protected final String region;
    /**
     * 可用区
     */
    protected final String zone;
}

重写了 #equals(…) 和 #hashCode(…) 方法，标准实现方式，这里就不贴代码了。

3. 解析器

EndPoint 解析器使用委托设计模式实现。所以，上文图片中我们看到好多个解析器，实际代码非常非常非常清晰。

FROM 《委托模式》委托模式是软件设计模式中的一项基本技巧。在委托模式中，有两个对象参与处理同一个请求，接受请求的对象将请求委托给另一个对象来处理。委托模式是一项基本技巧，许多其他的模式，如状态模式、策略模式、访问者模式本质上是在更特殊的场合采用了委托模式。委托模式使得我们可以用聚合来替代继承，它还使我们可以模拟mixin。

我们在上图的基础上，增加委托的关系，如下图：

3.1 ClusterResolver

com.netflix.discovery.shared.resolver.ClusterResolver ，集群解析器接口。接口代码如下：


public interface ClusterResolverT extends EurekaEndpoint {

    /**
     * @return 地区
     */
    String getRegion();

    /**
     * @return EndPoint 集群( 数组 )
     */
    List getClusterEndpoints();

}

3.2 ClosableResolver

com.netflix.discovery.shared.resolver.ClosableResolver ，可关闭的解析器接口，继承自 ClusterResolver 接口。接口代码如下：


public interface ClosableResolverT extends EurekaEndpoint extends ClusterResolverT {

    /**
     * 关闭
     */
    void shutdown();
}

3.3 DnsTxtRecordClusterResolver

com.netflix.discovery.shared.resolver.aws.DnsTxtRecordClusterResolver ，基于 DNS TXT 记录类型的集群解析器。类属性代码如下：


public class DnsTxtRecordClusterResolver implements ClusterResolverAwsEndpoint {

    /**
     * 地区
     */
    private final String region;
    /**
     * 集群根地址，例如 txt.default.eureka.iocoder.cn
     */
    private final String rootClusterDNS;
    /**
     * 是否解析可用区( zone )
     */
    private final boolean extractZoneFromDNS;
    /**
     * 端口
     */
    private final int port;
    /**
     * 是否安全
     */
    private final boolean isSecure;
    /**
     * 相对地址
     */
    private final String relativeUri;
}

DnsTxtRecordClusterResolver 通过集群根地址( `rootClusterDNS` ) 解析出 EndPoint 集群。需要在 DNS 配置**两层**解析记录：
- 第 12 至 16 行：调用 `#resolve(rootClusterDNS)` 解析**第一层** DNS 记录。实现代码如下：
```
  1: private static SetString resolve(String rootClusterDNS) throws NamingException {
  2:     SetString result;
  3:     try {
  4:         result = DnsResolver.getCNamesFromTxtRecord(rootClusterDNS);
  5:         // TODO 芋艿：这块是bug，不需要这一段
  6:         if (!rootClusterDNS.startsWith("txt.")) {
  7:             result = DnsResolver.getCNamesFromTxtRecord("txt." + rootClusterDNS);
  8:         }
  9:     } catch (NamingException e) {
 10:         if (!rootClusterDNS.startsWith("txt.")) {
 11:             result = DnsResolver.getCNamesFromTxtRecord("txt." + rootClusterDNS);
 12:         } else {
 13:             throw e;
 14:         }
 15:     }
 16:     return result;
 17: }
```
  - 第 3 至 8 行：基于 DNS 获取 EndPoint 集群，调用 `#getClusterEndpointsFromDns()` 方法，实现代码如下：
```
`// ... 省略代码，超过微信文章的长度`
```
    - 第 3 行：获得可用区数组。通过 `eureka.${REGION}.availabilityZones` 配置。
    - 第 5 行：调用 `InstanceInfo#getZone(…)` 方法，获得**应用实例自己所在的可用区**( `zone` )。非亚马逊 AWS 环境下，可用区数组的第一个元素就是**应用实例自己所在的可用区**。
    - 第 7 行：调用 `EndpointUtils#getServiceUrlsMapFromConfig(...)` 方法，获得可用区与 `serviceUrls` 的映射。实现代码如下：
```
`// ... 省略代码，超过微信文章的长度`
```
      - 第 13 行：获得**开始位置**。实现代码如下：
        `// ... 省略代码，超过微信文章的长度`
      - 第 20 至 33 行：从开始位置**顺序**将剩余的可用区的 `serviceUrls` 添加到结果。**顺序**理解如下图：

本人花费半年的时间总结的《Java面试指南》已拿腾讯等大厂offer，已开源在github ，欢迎star！

本文GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录，这是我花了6个月总结的一线大厂Java面试总结，本人已拿大厂offer，欢迎star

原文链接：blog.ouyangsihai.cn >> 注册中心 Eureka 源码解析 —— EndPoint 与解析器