Spring Cloud Eureka 实例类配置
本文为个人笔记,若要转载,请注明作者。
1.元数据
org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean 配置信息中有一大部分都是对服务实例元数据的配置。
元数据是什么?
元数据是:Eureka客户端在向服务注册中心发送注册时,用来描述自己服务信息的对象,包含了一些标准化的元数据,比如服务名称、是咧名称、实例IP、实例端口等用于服务治理的重要信息;甚至有一些用于负载均衡策略或时其他用途自定义的元数据信息。
在使用 Spring Cloud Eureka 的时候,所有的配置信息都是通过 org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean 进行加载,但在真正服务注册的时候会把数据存储在 com.netflix.appinfo.InstanceInfo 对象发送给 Eureka 服务端。
这两个类非常相似,我们可以通过查看 com.netflix.appinfo.InstanceInfo 类中的详细定义来了解原生的 Eureka 对元数据的定义。其中,Map<String, String> metadata = new ConcurrentHashMap<String, String>()时自定义的元数据信息,其他变量则时标准化的元数据信息,也就是已经界定好的数据信息。Spring Cloud 的 EurekaInstanceConfigBean 对原声元数据对象做了一些配置优化化处理。
我们可以通过eureka.instance.<properties>=<value>的格式对标准化元数据进行配置,其中<properties>就是 EurekaInstanceConfigBean 对象中的成员变量。
若我们需要自定义元数据,可以通过 eureka.instance.metadataMap.<key>=<value>的格式来进行配置,例如:
eureka.instance.metadataMap.zone=yidongde130
下面我们针对一些常用的元数据配置做进一步的介绍和说明。
1.1 实例名配置
实例名:就是 InstanceInfo 中的 instanceId 参数, 它是区分同一服务中不同实例的唯一标识。在 Netflix Eureka 的原生实现中,实例名采用主机名作为默认值,这样使得在同一主机中无法启动多实例的情况。所以, Spring Cloud Eureka 对实例名的默认命名做出了合理的扩展。默认规则如下:
${spring.cloud.client.hostname}:${spring.application.name}:${spring.application.instance_id:${server.port}}
对于实例名的命名股则,我们可以通过 eureka.instance.instanceId 参数来进行配置。比如,在本地进行客户端负载均衡调试时,需要启动同一服务的多个实例,如果我们直接启动一个应用没必然会产生端口冲突,虽然在命令行中制定不同的 server.port 来启动,但是这种方式还是比较麻烦。那我们可以通过server.port=0 或者使用随机数 server.port=${random.int[10000,19999]}
来让Tomcat 启动的时候采用随即端口。我们这个时候会发现注册到 Eureka Server 的实例名都相同的,这会使得只有一个服务实力能够正常提供服务。对于这个问题,我们可以同故宫设置实例名规则来轻松解决:
eureka.instance.instanceId=${spring.application.name}:${randmo.int}
通过以上的配置,利用应用名加随机数的方式来区分不同的实例,从而实现在同一主机上,不指定端口就能轻松启动多个实例的效果。
1.2 端点配置
在 InstanceInfo 中,我们可以看到一些URL的配置信息,比如 homePageUrl、statusPageUrl、healthCheckUrl, 它们分别代表了应用主页的URL、状态页的URL、健康检查的URL。其中,状态页和健康检查页的URL在Spring Cloud Eureka 中默认使用了 spring-boot-actuator 模块提供的/info端点和/health端点。虽然我们在之前的示例中并没有对这些端点做具体的设置,但是实际上这些URL地址的配置非常重要。为了服务的正常运作,我们必须确保Eureka客户端的/health端点在发送元数据的时候,是一个能够被注册中心访问到的地址,否则服务注册中心不会根据应用的健康检查来更改状态(仅当开启了healthcheck功能时, 以该端点信息作为健康检查标准)。而/info端点如果不正确的话会导致在Eureka面板中单击服务实例时,无法访问到服务实例提供的信息接口。