集成Consul负载均衡多实例注册

SpringBoot2.x 集成Consul负载均衡多实例注册

• 原理
• 解决方案（2种）
• • 解决方案一
  • • 自定义ConsulServiceRegistry
    • 开启心跳检测
  • 解决方案二
  • • 直接修改实例ID
• 参考

原理

1. 问题：问题在多个实例注册时出现。如果不解决将会出现实例覆盖的情况，实现不了负载均衡。
2. 原因：根据官网描述：Consul 的注册机制，默认是Spring Cloud Consul在注册的时候实例名（InstanceId）采用了：“服务名-端口号”（即：{spring.application.name}-{server.port}）的值，可以看到这个实例名如果不改变端口号的情况下，实例名都是相同的。

3. 官网描述

   By default a consul instance is registered with an ID that is equal to its Spring Application Context ID. By default, the Spring Application Context ID is ${spring.application.name}:comma,separated,profiles: ${server.port}. For most cases, this will allow multiple instances of one service to run on one machine. If further uniqueness is required, Using Spring Cloud you can override this by providing a unique identifier in spring.cloud.consul.discovery.instanceId. For example:

4. Consul 旧版本机制：熟悉Spring Cloud Consul的读者，可能会问老版本也是这个规则，怎么没有这个问题呢？。主要是由于Consul对实例唯一性的判断标准也有改变，在老版本的Consul中，对于实例名相同，但是服务地址不同，依然会认为是不同的实例。在Consul 1.2.x中，服务实例名成为了集群中的唯一标识，所以，也就导致了上述问题。

解决方案（2种）

解决方案一

自定义ConsulServiceRegistry

@Configuration
public class MyConsulServiceRegistry extends ConsulServiceRegistry {

    /**
     * 参照源码定义声名
     */
    @Autowired(required = false)
    private TtlScheduler ttlScheduler;

    public MyConsulServiceRegistry(ConsulClient client, ConsulDiscoveryProperties properties, TtlScheduler ttlScheduler, HeartbeatProperties heartbeatProperties) {
        super(client, properties, ttlScheduler, heartbeatProperties);
    }

    @Override
    public void register(ConsulRegistration reg) {
        reg.getService().setId(reg.getService().getName() + "-" + reg.getService().getAddress() + "-" + reg.getService().getPort());
        super.register(reg);
    }
}
           

开启心跳检测

spring:
    consul:
        discovery:
            heartbeat:
                enabled: true
           

解决方案二

直接修改实例ID

spring.cloud.consul.discovery.instance-id=${spring.application.name}-${random.int[10000,99999]}
           

参考

本文章只是对springboot2.集成consul 问题解决补充，感兴趣的可以参考

[1]:Spring Cloud Finchley版中Consul多实例注册的问题处理

[2]: Spring Cloud Consul 多实例注册问题