SpringCloud升级之路2020.0.x版-17.Eureka的实例配置

Posted 2021-09-09 干货满满张哈希

本系列代码地址：https://github.com/HashZhang/spring-cloud-scaffold/tree/master/spring-cloud-iiford

上一节我们提到过，每个注册到 Eureka 上面的实例就是 Eureka 实例。 不论这个实例本身就是 Eureka Server 或者是要注册的微服务，只要作为实例，就需要实例配置。我们系列中的实例配置，特指 Spring Cloud 中的 Eureka 实例配置（基于 spring-cloud-netflix），配置均以 eureka.instance 开头，对应配置类是 EurekaInstanceConfigBean

实例配置会影响 Eureka Server 上这个实例的信息，心跳时间和过期时间等信息，同时对于某些微服务框架也会使用实例中的元数据做一些负载均衡、断路等策略。

实例配置均以 eureka.instance 开头，对应类是 EurekaInstanceConfigBean

首先是访问这个 Eureka 实例所需的信息，这些信息一般不需要我们自己手动配置，会自动读取：

eureka:
    instance:
      #一般不用我们自己设置，EurekaInstanceConfigBean 的构造器会通过 InetUtils 获取 ip 地址
      #ip-address:
      #一般不用我们自己设置，EurekaInstanceConfigBean 的构造器会通过 InetUtils 获取 hostname
      #hostname:

至于注册中心上面，倾向于直接用 ip 注册还是域名注册，这个是可以配置的。有些时候域名映射的 ip 可能会改变，但是服务本身地址没变，在云环境尤其常见，所以我们一般会配置使用 ip 注册：

eureka:
    instance:
      #注册到 eureka 上面供其他实例访问的地址使用 ip 进行注册，其他实例会通过 ip 进行访问
      prefer-ip-address: true

对于端口，一般使用微服务的端口直接进行注册，这里也是可以配置的，因为可能有些 SideCar 应用要注册的端口和本身 Spring Boot 服务端口不一样。

eureka:
    instance:
      #不用设置 non-secure-port，自动使用 server.port 作为 non-secure-port
      #non-secure-port:
      #如果 secure-port-enabled 是 true，则会自动使用 server.port 作为 secure-port;我们一般内部调用不用 ssl，所以不需要配置 secure-port
      #secure-port:
      #默认是启用 non-secure-port 的
      non-secure-port-enabled: true
      #默认是不启用 secure-port 的，我们一般内部调用不用 ssl
      secure-port-enabled: false

同时，我们还可以对于注册的微服务名称，以及该实例的 ID，进行订制：

eureka:
    instance:
      #个性化的实例id，包括 ip:微服务名称:端口
      instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
      # app名称，不填写在 Spring-cloud-netflix 体系下默认就是 spring.application.name
      appname: ${spring.application.name}
      #app组名称归类用的，目前也没什么用
      app-group-name: common
      #实例命名空间，目前也没什么用
      namespace: public

这些信息对于 Eureka 本身没有什么用，主要给外部监控使用，例如从 Eureka 上面获取实例信息，根据基本链接信息对实例的健康性进行检查。

eureka:
    instance:
      # 健康检查地址，默认是 /actuator/health
      health-check-url-path: /actuator/health
      # 实例状态地址，默认是 /actuator/info
      status-page-url-path: /actuator/info
      # 首页地址，默认是 /
      home-page-url-path: /

实例注册行为配置，即实例注册后的行为，以及心跳间隔等配置。Eureka 客户端会根据这个配置进行心跳，并且是否在一开始就注册自己为 UP 状态开始服务，或者注册自己为 STARTING 待某些初始化任务完成后再改为 UP，Eureka Server 也会根据这个配置结合实例上次心跳时间判断实例是否存活

eureka:
    instance:
	  # 服务过期时间配置,超过这个时间没有接收到心跳EurekaServer就会将这个实例剔除
      # 注意，EurekaServer一定要设置eureka.server.eviction-interval-timer-in-ms否则这个配置无效
      # 这个配置一般为服务刷新时间配置的三倍
      # 默认90s
      lease-expiration-duration-in-seconds: 15
      #服务刷新时间配置，每隔这个时间会主动心跳一次
      #默认30s
      lease-renewal-interval-in-seconds: 5
      #实例注册后是否立刻开始服务，默认为 false，一般注册后还需要做一些操作，所以注册实例的状态是 STARTING。后面改变状态后会更新为 UP
      instance-enabled-onit: false

其他框架可以通过实例元数据来实现一些个性化的功能，例如 configPath 是使用 spring-cloud-config 的时候会设置，zone 是实例的区域配置，会被 spring-cloud-loadbalancer 使用。

eureka:
    instance:
	  #元数据map，我们可以自己使用，放一些个性化的元数据，目前只有 configPath 和 zone 比较有用。 configPath 是使用 spring-cloud-config 的时候会设置 
      metadata-map:
        # spring cloud 体系中，可用区的配置放入元数据中，key 为 zone
        zone: zone1

我们这一节详细分析了 Eureka 的实例配置。下一节，我们将开始分析 Eureka 的客户端配置。

微信搜索“我的编程喵”关注公众号，每日一刷，轻松提升技术，斩获各种offer：