搜索
您的当前位置:首页正文

SpringCloud组件 & 源码剖析:Eureka服

来源:哗拓教育

本章目标

分析每一种服务注册方式源码执行流程。

构建项目

  1. 启动服务注册中心
  2. 启动本章服务项目
  3. 查看服务列表,服务注册方式

配置信息获取执行流程

在开始讲解本章注册方式之前,我们需要了解整体的配置信息获取的流程信息,这样才可以分析指定的注册方式执行流程。

第一步:实例化EurekaInstanceConfigBean配置实体
......
public class EurekaClientAutoConfiguration {
    //省略部分源码
    @Bean
    @ConditionalOnMissingBean(value = EurekaInstanceConfig.class, search        = SearchStrategy.CURRENT)
    public EurekaInstanceConfigBean eurekaInstanceConfigBean(InetUtils inetUtils,                                                       ManagementMetadataProvider managementMetadataProvider) {
      //省略部分源码
      // 传递
      EurekaInstanceConfigBean instance = new EurekaInstanceConfigBean(inetUtils);
      // 省略部分源码
    }
    //省略部分源码
}

EurekaClientAutoConfiguration#eurekaInstanceConfigBean方法只有满足@ConditionalOnMissingBean(value = EurekaInstanceConfig.class, search = SearchStrategy.CURRENT)表达式后才会去实例化,并且把实例化对象放入到IOC容器内容,BeanIdeurekaInstanceConfigBean,也就是方法的名称。
EurekaClientAutoConfiguration#eurekaInstanceConfigBean方法中有这么一行代码我们可以进行下一步的分析

// 通过有参构造函数实例化EurekaInstanceConfigBean配置实体
EurekaInstanceConfigBean instance = new EurekaInstanceConfigBean(inetUtils);

通过调用EurekaInstanceConfigBean(InetUtils inetUtils)构造函数来进行实例化EurekaInstanceConfigBean对象,在这个构造函数内也有一些实例化的工作,源码如下:

public EurekaInstanceConfigBean(InetUtils inetUtils) {
    this.inetUtils = inetUtils;
    this.hostInfo = this.inetUtils.findFirstNonLoopbackHostInfo();
    this.ipAddress = this.hostInfo.getIpAddress();
    this.hostname = this.hostInfo.getHostname();
}
第二步:InetUtils#findFirstNonLoopbackHostInfo获取主机基本信息

在构造函数EurekaInstanceConfigBean(InetUtils inetUtils)源码实现内hostInfo主机信息通过了InetUtils#findFirstNonLoopbackHostInfo方法来进行实例化,我们来看看这个方法的具体实现逻辑,它会自动读取系统网卡列表然再进行循环遍历查询正在UP状态的网卡信息,如果没有查询到网卡信息,则使用默认的HostNameIpAddress配置信息,源码如下所示:

public HostInfo findFirstNonLoopbackHostInfo() {
    InetAddress address = findFirstNonLoopbackAddress();
    if (address != null) {
        return convertAddress(address);
    }
    HostInfo hostInfo = new HostInfo();
    hostInfo.setHostname(this.properties.getDefaultHostname());
    hostInfo.setIpAddress(this.properties.getDefaultIpAddress());
    return hostInfo;
}

public InetAddress findFirstNonLoopbackAddress() {
    InetAddress result = null;
    try {
        int lowest = Integer.MAX_VALUE;
        for (Enumeration<NetworkInterface> nics = NetworkInterface
                .getNetworkInterfaces(); nics.hasMoreElements();) {
            NetworkInterface ifc = nics.nextElement();
            if (ifc.isUp()) {
                log.trace("Testing interface: " + ifc.getDisplayName());
                if (ifc.getIndex() < lowest || result == null) {
                    lowest = ifc.getIndex();
                }
                else if (result != null) {
                    continue;
                }

                // @formatter:off
                if (!ignoreInterface(ifc.getDisplayName())) {
                    for (Enumeration<InetAddress> addrs = ifc
                            .getInetAddresses(); addrs.hasMoreElements();) {
                        InetAddress address = addrs.nextElement();
                        if (address instanceof Inet4Address
                                && !address.isLoopbackAddress()
                                && isPreferredAddress(address)) {
                            log.trace("Found non-loopback interface: "
                                    + ifc.getDisplayName());
                            result = address;
                        }
                    }
                }
                // @formatter:on
            }
        }
    }
    catch (IOException ex) {
        log.error("Cannot get first non-loopback address", ex);
    }

    if (result != null) {
        return result;
    }

    try {
        return InetAddress.getLocalHost();
    }
    catch (UnknownHostException e) {
        log.warn("Unable to retrieve localhost");
    }

    return null;
}

默认的HostNameIpAddress属性配置信息在InetUtilsProperties配置实体类内,如果不进行设置则直接使用默认值,如果你想更换默认值,那么你可以在application.yml配置文件内通过设置spring.cloud.inetutils.defaultHostnamespring.cloud.inetutils.defaultIpAddress进行修改默认值,源码如下所示:

public class InetUtilsProperties {
    public static final String PREFIX = "spring.cloud.inetutils";

    /**
     * The default hostname. Used in case of errors.
     */
    private String defaultHostname = "localhost";

    /**
     * The default ipaddress. Used in case of errors.
     */
    private String defaultIpAddress = "127.0.0.1";
}
第三步:EurekaInstanceConfigBean#getHostName方法实现
@Override
public String getHostName(boolean refresh) {
    if (refresh && !this.hostInfo.override) {
        this.ipAddress = this.hostInfo.getIpAddress();
        this.hostname = this.hostInfo.getHostname();
    }
    return this.preferIpAddress ? this.ipAddress : this.hostname;
}

默认注册方式源码分析

由于在实例化EurekaInstanceConfigBean配置实体类时,构造函数进行了获取第一个非回环主机信息,默认的hostName以及ipAddress参数则是会直接使用InetUtils#findFirstNonLoopbackHostInfo方法返回的相对应的值。

IP优先注册方式源码分析

EurekaInstanceConfigBean#getHostName方法直接调用本类重载方法getHostName(boolean refresh)并且传递参数为false,根据第三步源码我们就可以看到:

return this.preferIpAddress ? this.ipAddress : this.hostname;

如果eureka.instance.prefer-ip-address参数设置了true就会返回eureka.instance.ip-address的值,这样我们就可以从中明白为什么主动设置eureka.instance.ip-address参数后需要同时设置eureka.instance.prefer-ip-address参数才可以生效。

指定IP、HostName源码分析

我们通过application.yml配置文件进行设置eureka.instance.hostname以及eureka.instance.ip-address后会直接替换原默认值,在EurekaInstanceConfigBean#getHostName中也是返回的this.hostnamethis.ipAddress所以在这里设置后会直接生效作为返回的配置值。

总结

我们通过源码进行分析服务注册方式执行流程,这样在以后进行配置eureka.instance.hostnameeureka.instance.prefer.ip-addresseureka.instance.ip-address三个配置信息时就可以根据优先级顺序达到预期的效果,避免没有必要的错误出现。

源码位置

  • SpringBoot配套源码地址:、
  • SpringCloud配套源码地址(本章源码在这):

与恒宇少年面对面

学习目录推荐

  • SpringCloud相关系列文章访问:
  • SpringBoot相关系列文章请访问:
  • QueryDSL相关系列文章请访问:
  • SpringDataJPA相关系列文章请访问:

开源信息

这段时间一直在编写开源的相关框架,致力于公司使用的框架升级以及开源计划,将公司使用到的工具以及插件进行升级重构并且开源。

  • 代码生成器(Code-Builder)
    code-builder代码生成器根据你提供的模板文件(目前支持freemarker)自动生成实体类,可以很大很有效的提高开发效率。
    Gitee地址
    Github地址
  • 持久化框架(MyBatis-Enhance)
    mybatis-enhance是一个对mybatis框架的增强封装,提供一系列的内部方法来完成单表数据的操作,多表数据提供DSL方式进行操作。
    Gitee地址
    Github地址
  • 自动分页插件
    MyBatis-Pageable是一款自动化分页的插件,基于MyBatis内部的插件Interceptor拦截器编写完成,拦截Executor.query的两个重载方法计算出分页的信息以及根据配置的数据库Dialect自动执行不同的查询语句完成总数量的统计。
    Gitee地址
Top