专栏首页实战dockerSpring Cloud源码分析之Eureka篇第八章:服务注册名称的来历

Spring Cloud源码分析之Eureka篇第八章:服务注册名称的来历

关于服务注册名称

服务注册名称,是指Eureka client注册到Eureka server时,用于标记自己身份的标志,举例说明,以下是个简单的Eureka client配置:

server:
  port: 8082
spring:
  application:
    name: springcloud-deep-provider
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8081/eureka/

这样配置的应用,启动后如果在Eureka server注册成功,那么Eureka server的home页面信息如下,红框中就是注册名称:

本文目标是通过分析Eureka client源码来找出这个名称是如何创建的;

关于源码版本

本次分析的Spring Cloud版本为Edgware.RELEASE,对应的eureka-client版本为1.7.0;

从启动说起

  1. 在spring-cloud-commons库的META-INF目录下有spring.factories文件,这是spring扩展规范的实现,这里面配置的类会被实例化,其中就包含了HostInfoEnvironmentPostProcessor这个类,如下图红框所示:
  1. HostInfoEnvironmentPostProcessor实现了EnvironmentPostProcessor接口,来看看官方文档对EnvironmentPostProcessor的描述:

上图红框中说明开发者可以自定义环境变量; 上图绿框中说明EnvironmentPostProcessor的实现类必须在spring.factories文件中定义; 因此HostInfoEnvironmentPostProcessor类的作用已经清楚了:自定义环境变量;

  1. HostInfoEnvironmentPostProcessor源码如下:
public class HostInfoEnvironmentPostProcessor
		implements EnvironmentPostProcessor, Ordered {

	// Before ConfigFileApplicationListener
	private int order = ConfigFileApplicationListener.DEFAULT_ORDER - 1;

	@Override
	public int getOrder() {
		return this.order;
	}

	@Override
	public void postProcessEnvironment(ConfigurableEnvironment environment,
			SpringApplication application) {
		InetUtils.HostInfo hostInfo = getFirstNonLoopbackHostInfo(environment);
		LinkedHashMap<String, Object> map = new LinkedHashMap<>();
		map.put("spring.cloud.client.hostname", hostInfo.getHostname());
		map.put("spring.cloud.client.ipAddress", hostInfo.getIpAddress());
		MapPropertySource propertySource = new MapPropertySource(
				"springCloudClientHostInfo", map);
		environment.getPropertySources().addLast(propertySource);
	}

	private HostInfo getFirstNonLoopbackHostInfo(ConfigurableEnvironment environment) {
		InetUtilsProperties target = new InetUtilsProperties();
		RelaxedDataBinder binder = new RelaxedDataBinder(target,
				InetUtilsProperties.PREFIX);
		binder.bind(new PropertySourcesPropertyValues(environment.getPropertySources()));
		try (InetUtils utils = new InetUtils(target)) {
			return utils.findFirstNonLoopbackHostInfo();
		}
	}
}

上述代码有两处需要注意: 第一,设置了两个环境变量:spring.cloud.client.hostname和spring.cloud.client.ipAddress; 第二,getFirstNonLoopbackHostInfo方法返回的对象中,127.0.0.1这样的IP地址是会被过滤掉的,过滤逻辑很简单,源码在Inet4Address类的isLoopbackAddress方法:

public boolean isLoopbackAddress() {
        /* 127.x.x.x */
        byte[] byteAddr = getAddress();
        return byteAddr[0] == 127;
    }

小结:HostInfoEnvironmentPostProcessor的作用是把本机的hostname和IP地址设置到环境变量中;

在配置类中保存服务名称

  1. 接下来看看配置类EurekaClientAutoConfiguration,这里面主要是和Eureka相关的配置信息的数据和逻辑;
  2. 请看方法eurekaInstanceConfigBean,该方法向Spring容器环境提供EurekaInstanceConfigBean实例,注意instance.setInstanceId(getDefaultInstanceId(propertyResolver))这一行:
@Bean
	@ConditionalOnMissingBean(value = EurekaInstanceConfig.class, search = SearchStrategy.CURRENT)
	public EurekaInstanceConfigBean eurekaInstanceConfigBean(InetUtils inetUtils,
															 ManagementMetadataProvider managementMetadataProvider) throws MalformedURLException {
		PropertyResolver eurekaPropertyResolver = new RelaxedPropertyResolver(this.env, "eureka.instance.");
		String hostname = eurekaPropertyResolver.getProperty("hostname");

		boolean preferIpAddress = Boolean.parseBoolean(eurekaPropertyResolver.getProperty("preferIpAddress"));
		boolean isSecurePortEnabled = Boolean.parseBoolean(eurekaPropertyResolver.getProperty("securePortEnabled"));
		String serverContextPath = propertyResolver.getProperty("server.contextPath", "/");
		int serverPort = Integer.valueOf(propertyResolver.getProperty("server.port", propertyResolver.getProperty("port", "8080")));

		Integer managementPort = propertyResolver.getProperty("management.port", Integer.class);// nullable. should be wrapped into optional
		String managementContextPath = propertyResolver.getProperty("management.contextPath");// nullable. should be wrapped into optional
		Integer jmxPort = propertyResolver.getProperty("com.sun.management.jmxremote.port", Integer.class);//nullable
		EurekaInstanceConfigBean instance = new EurekaInstanceConfigBean(inetUtils);

		instance.setNonSecurePort(serverPort);
		//服务自身的名称在此设置,保存到instance后,其他地方就可以使用了
		instance.setInstanceId(getDefaultInstanceId(propertyResolver));
  1. 顺藤摸瓜,展开方法getDefaultInstanceId:
public static String getDefaultInstanceId(PropertyResolver resolver) {
		RelaxedPropertyResolver relaxed = new RelaxedPropertyResolver(resolver);
		String vcapInstanceId = relaxed.getProperty("vcap.application.instance_id");
		if (StringUtils.hasText(vcapInstanceId)) {
			return vcapInstanceId;
		}

		String hostname = relaxed.getProperty("spring.cloud.client.hostname");
		String appName = relaxed.getProperty("spring.application.name");

		String namePart = combineParts(hostname, SEPARATOR, appName);

		String indexPart = relaxed.getProperty("spring.application.instance_id",
				relaxed.getProperty("server.port"));

		return combineParts(namePart, SEPARATOR, indexPart);
	}

如上述代码所示,真相大白,服务注册名称一共有三部分:hostname、应用名称、自定义实例ID,如果自定义实例ID没有配置就用监听端口代替;

此时再来回顾之前在Eureka server的home页面上看到的服务注册名:localhost:springcloud-deep-provider:8082,果然与源码一致; 4. 源码读到此处,禁不住手痒,按照上面的逻辑,在应用的aplication.yml中增加配置项spring.application.instance_id,看看能否生效,改过的aplication.yml内容如下图所示,红框中是新增的自定义实例ID配置:

5. 重启应用,重新注册到Eureka server,此时再看home页面如下图红框,服务注册名称果然已经更新:

使用配置类中的服务名称

现在我们知道了EurekaInstanceConfigBean实例的instanceId字段被设置为"hostname:应用名称:自定义实例ID",接下来看该字段如何被提交到Eureka server;

  1. 在EurekaClientAutoConfiguration类中有个eurekaApplicationInfoManager方法,为spring容器提供了ApplicationInfoManager实例:
@Bean
@ConditionalOnMissingBean(value = ApplicationInfoManager.class, search = SearchStrategy.CURRENT)
public ApplicationInfoManager eurekaApplicationInfoManager(
		EurekaInstanceConfig config) {
		//config就是前面看到的EurekaInstanceConfigBean实例,
		//EurekaInstanceConfig是个接口,EurekaInstanceConfigBean是该接口的实现,
		//instanceInfo实例中已经保存了EurekaInstanceConfigBean的信息,也包括instanceId字段
		InstanceInfo instanceInfo = new InstanceInfoFactory().create(config);
		//生成ApplicationInfoManager实例,
		//config和instanceInfo都被设置为ApplicationInfoManager实例的成员变量
		return new ApplicationInfoManager(config, instanceInfo);
}

如上所示,spring容器中有了ApplicationInfoManager实例,就可以通过该实例获得服务注册名称;

  1. Eureka client向Eureka server发起服务注册的操作是在DiscoveryClient类中进行的,该类的构造方法如下:

如上图所示,红框中ApplicationInfoManager实例被注入,蓝框中表明DiscoveryClient的成员变量instanceInfo获得了InstanceInfo实例;

  1. 具体的注册逻辑在DiscoveryClient的register方法中,可见成员变量instanceInfo被当作入参传入了注册逻辑的API:
    /**
     * Register with the eureka service by making the appropriate REST call.
     */
    boolean register() throws Throwable {
        logger.info(PREFIX + appPathIdentifier + ": registering service...");
        EurekaHttpResponse<Void> httpResponse;
        try {
            //以成员变量instanceInfo作为入参进行注册
            httpResponse = eurekaTransport.registrationClient.register(instanceInfo);
        } catch (Exception e) {
            logger.warn("{} - registration failed {}", PREFIX + appPathIdentifier, e.getMessage(), e);
            throw e;
        }
        if (logger.isInfoEnabled()) {
            logger.info("{} - registration status: {}", PREFIX + appPathIdentifier, httpResponse.getStatusCode());
        }
        return httpResponse.getStatusCode() == 204;
    }
  1. 上述代码中的eurekaTransport.registrationClient.register(instanceInfo)方法,经过层层调用,最终调用了AbstractJerseyEurekaHttpClient类的register方法,如下图所示:

上图的红框表明,POST请求时InstanceInfo实例被作为请求参数提交到了Eureka server;

Wireshark抓包验证

至此,代码分析已经结束了,最后我们用Wireshark抓包来验证之前的分析结果,在Eureka client所在电脑上用Wireshark2.6.3来分析注册请求:

如上图所示,红框中就是注册请求,绿框中是请求包头的全部内容,也就是前面看到的InstanceInfo实例的内容,蓝框中的内容,就是服务注册名称的键值对,值就是Eureka server收到的注册名称;

最后来小结一下,服务注册名称从诞生到提交至Eureka server的过程:

  1. HostInfoEnvironmentPostProcessor将本机的hostname和IP地址设置到应用环境变量中;
  2. 配置类EurekaClientAutoConfiguration中,创建一个EurekaInstanceConfigBean类型的bean,其instanceId字段就是即将上报到Eureka server的自身名称,instanceId字段的内容由hostname、应用名称、自定义实例ID拼接而成,其中自定义实例ID来自配置项"spring.application.instance_id",如果不存在就用服务监听端口代替;
  3. ApplicationInfoManager类型的bean在创建时被注入EurekaInstanceConfigBean实例,用于创建ApplicationInfoManager的成员变量instanceInfo;
  4. DiscoveryClient的构造方法中注入了ApplicationInfoManager,于是DiscoveryClient的成员变量instanceInfo就被赋值为ApplicationInfoManager的成员变量instanceInfo;
  5. DiscoveryClient的register方法负责注册到Eureka server的逻辑,用到的参数就是成员变量instanceInfo;
  6. 发起注册网络请求的操作最终由AbstractJerseyEurekaHttpClient类的register方法完成,POST的内容就是instanceInfo实例;

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • spring+mybatis启动NoClassDefFoundError异常分析三部曲之三:改spring源码,取详细错误

    在上一章《spring+mybatis启动NoClassDefFoundError异常分析三部曲之二:定位错误》中,我们通过打断点的方式,在spring初始化时...

    程序员欣宸
  • Spring Cloud源码分析之Eureka篇第七章:续约

    在文章《Spring Cloud源码分析之Eureka篇第四章:服务注册是如何发起的 》的分析中,我们知道了作为Eureka Client的应用启动时,在com...

    程序员欣宸
  • 应用升级SpringCloud版本时的注意事项(Dalston升级到Edgware)

    手里有个Spring Cloud的工程,是服务提供者的身份,在pom.xml中配置的Spring Cloud版本是Dalston.SR5,要升级到Edgware...

    程序员欣宸
  • BZOJ4008: [HNOI2015]亚瑟王(期望dp)

    Time Limit: 20 Sec  Memory Limit: 512 MBSec  Special Judge

    attack
  • 无服务器化是云计算的未来吗?

    导语 “纽约时报”首席技术官尼克·罗克韦尔(Nick Rockwell)表示,随着云计算为企业带来了更多的灵活性,事件触发的计算成本也得到了降低,并使应用程序的...

    静一
  • Windows Phone 8.0 SDK Update(10322) Released

        昨天微软低调发布了WP 8 SDK的更新,甚至在Windows Phone Developer Blog上都没有提及。     从开发者的角度来看,此次...

    ShiJiong
  • 币聪早报:比特币哈希率在单日内突破1000万TH/s,比特大陆S11开启测试?

    尽管最近比特币价格走势疲软,但比特币挖掘的网络哈希率在过去两天突然大幅上涨。这种增加使其达到令人难以置信的每秒6200万terahashes。仅仅两天前,该网络...

    币聪财经
  • 正则表达式re.sub替换不完整的问题现象及其根本原因

    问题的起因来自于一段正则替换。为了从一段HTML代码里面提取出正文,去掉所有的HTML标签和属性,可以写一个Python函数:

    青南
  • 【SpringBoot MQ 系列】RabbitListener 消费基本使用姿势介绍

    之前介绍了 rabbitmq 的消息发送姿势,既然有发送,当然就得有消费者,在 SpringBoot 环境下,消费可以说比较简单了,借助@RabbitListe...

    一灰灰blog
  • BZOJ 2648: SJY摆棋子(K-D Tree)

    attack

扫码关注云+社区

领取腾讯云代金券