springcloud注册hostname或者ip那点事

4,036 阅读2分钟

注册hostname/ip

默认情况下,Eureka 使用 hostname 进行服务注册,以及服务信息的显示, 如果我们相拥 IP 地址的方式,可以在配置文件中配置eureka.instance.prefer-ip-address=true

idea中ctrl+鼠标左键,点击eureka.instance.prefer-ip-address=true进入查看EurekaInstanceConfigBean会引入这个属性

EurekaInstanceConfigBean

/**
	 * Flag to say that, when guessing a hostname, the IP address of the server should be
	 * used in prference to the hostname reported by the OS.
	 */
	private boolean preferIpAddress = false;

preferIpAddress: 首选IP地址。 默认false,也就是默认不注册ip.

肯定有地方做了判断,在EurekaInstanceConfigBean搜索preferIpAddress,发现了getHostName方法, 此方法用于返回得到的hostname或者ip

@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;
}

1.首先会判断:this.hostInfo.override属性. 此属性在setIpAddress方法里设置。setIpAddress方法对应的是eureka.instance.ip-address=这个配置属性。

也就是说:eureka.instance.ip-addresseureka.instance.prefer-ip-address = true同时设置是优先取eureka.instance.ip-address的配置

public void setIpAddress(String ipAddress) {
		this.ipAddress = ipAddress;
		this.hostInfo.override = true;
	}

2.preferIpAddress为false返回hostname属性,为true返回ipAddress属性 在EurekaInstanceConfigBean搜索hostname 会返现hostname 与ipAddress 可从hostInfo获得;hostInfo从inetUtils.findFirstNonLoopbackHostInfo获得。

public EurekaInstanceConfigBean(InetUtils inetUtils) {
		this.inetUtils = inetUtils;
		this.hostInfo = this.inetUtils.findFirstNonLoopbackHostInfo();
		this.ipAddress = this.hostInfo.getIpAddress();
		this.hostname = this.hostInfo.getHostname();
}

重点就落在了这个InetUtils.findFirstNonLoopbackHostInfo方法上。

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//是IPV4
		&& !address.isLoopbackAddress()//不是回环地址(127.***)
		&& isPreferredAddress(address)) {//有推荐网卡,判断是推荐网卡内的ip
								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 {
			//都没有找到使用JDK的InetAddress获取
			return InetAddress.getLocalHost();
		}
		catch (UnknownHostException e) {
			log.warn("Unable to retrieve localhost");
		}

		return null;
}

此方法,会获取所有网卡,取ip地址合理、索引值最小且不在忽略列表的网卡的IP地址作为结果。如果没有找到合适的IP, 就调用InetAddress.getLocalHost() 方法。

至此我们来总结下,关于注册的几种灵活配置:

  • Ip注册:eureka.instance.prefer-ip-address=true
  • 指定IP注册:eureka.instance.ip-address=
  • 忽略网卡:spring.cloud.inetutils.ignored-interfaces[0]
  • 推荐网卡:spring.cloud.inetutils.preferredNetworks[0]
  • 配置本机的host文件:当InetUtils找不到合适ip时,会调用JDK的InetAddress.getLocalHost()。该方法会根据本机的hostname解析出对应的ip。所以可以配置本机的hostname和/etc/hosts文件,直接将本机的主机名映射到有效IP地址

总结:

了解了注册hostname/ip的原理,当我们遇到注册问题时,就会有方向去解决

推荐阅读:

  1. docker内服务注册到Eureka上的instanceId问题
  2. Cannot find a way to configure Eureka client with Docker swarm mode