如何自定义微服务注册到Consul的InstanceId。
Consul把InstanceId作为唯一标识,而Spring Cloud Consul默认的InstanceId是
$ {spring.application.name}-${server.port} 。
这样导致的问题是:某个微服务即使有多个实例,只要端口相同,那么Consul上依然只会保留1条数据!要想解决这个问题,只需要让不同实例,拥有不同的InstanceId即可。
方式1:拼接随机值
添加配置:
spring:
cloud:
consul:
discovery:
instance-id: ${spring.application.name}-${server.port}-${random.long}
目前市面上的一些文章也是这么玩的。但这样做,在一些场景下还是有一点小问题的。
举个例子:假设某个微服务实例崩溃了,然后在很短的时间内(Consul还没来得及把这个实例删除);应用重启了,就会导致Consul上出现两条数据,但其实代表的是一个实例(虽然过段时间后,Consul会把没用的实例删除,但在一段时间内出现2条数据还是很诡异的)。
${random.long} 是Spring Boot自带的“扩展配置”,还有很多的使用姿势。文档可详见 https://docs.spring.io/spring-boot/docs/2.2.0.M5/reference/html/spring-boot-features.html#boot-features-external-config-random-values
方式2:拼接机器唯一标识
一个合理的instanceid应该满足以下两点需求:
不同实例的instanceid不同;
相同实例启动多次,instanceid应该相同。
要想实现这两点诉求,只要在instanceid上加上机器的唯一标示就OK了,比如IP或者是主机名等等。
spring:
cloud:
consul:
discovery:
instance-id: ${spring.application.name}-${server.port}-${spring.cloud.client.hostname}
或者:
spring:
cloud:
consul:
discovery:
instance-id: ${spring.application.name}-${server.port}-${spring.cloud.client.ip-address}
这里,${spring.cloud.client.hostname} 以及 ${spring.cloud.client.ip-address} ,是利用了Spring Boot配置文件可以读取环境变量的特点。
你的应用只要集成Spring Boot Actuator ,就可以通过 /actuator/env 查看所有环境变量啦!环境变量的Key值,都可以写到配置文件中。
方式3:代码扩展
如果上面两种方式依然满足不了你的需求,那么你还可以通过写代码的方式去扩展。
代码:
public class WiiConsulAutoRegistration extends ConsulAutoRegistration {
public WiiConsulAutoRegistration(NewService service, AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, ApplicationContext context, HeartbeatProperties heartbeatProperties, List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers) {
super(service, autoServiceRegistrationProperties, properties, context, heartbeatProperties, managementRegistrationCustomizers);
}
public static String getInstanceId(WiiProperties wiiProperties,
Environment environment) {
return String.format("%s-%s-%s",
environment.getProperty("spring.application.name"),
wiiProperties.getIp(),
wiiProperties.getPort());
}
}
配置:
@Configuration
public class XXXConfiguration {
@Bean
public ConsulAutoRegistration consulRegistration(
AutoServiceRegistrationProperties autoServiceRegistrationProperties,
ConsulDiscoveryProperties properties,
ApplicationContext applicationContext,
ObjectProvider<List<ConsulRegistrationCustomizer>> registrationCustomizers,
ObjectProvider<List<ConsulManagementRegistrationCustomizer>> managementRegistrationCustomizers,
HeartbeatProperties heartbeatProperties) {
return WiiConsulAutoRegistration.registration(autoServiceRegistrationProperties,
properties, applicationContext, registrationCustomizers.getIfAvailable(),
managementRegistrationCustomizers.getIfAvailable(), heartbeatProperties);
}
}
代码方式更加灵活,你可以在InstanceId上拼接mac地址或者其他什么玩意儿……不过,只是为了定制个唯一标示而已,这么玩成本有点高了,相关代码在这里,有兴趣可以看下: https://github.com/eacdy/spring-cloud-wii/blob/master/spring-cloud-wii/src/main/java/com/itmuch/wii/consul/WiiConsulAutoRegistration.java