blog

Eureka其它特性

上次记录了eureka最基本的特性，包括服务注册中心以及服务提供者，而且还是单机版本。这次记录一下eureka其它特性。

Eureka多实例

Eureka不仅可以像上回那样部署为单机版本，也可以启动多个实例，然后相互注册来保证服务的可用性。修改为多实例版本也很简单，而且Eureka默认就是多实例模式。下面通过修改spring-cloud-eureka-server模块来演示。

备份spring-cloud-eureka-server模块的application.yml为application-单机.yml。然后再修改application.yml文件如下

server:
  port: 8761

spring:
  profiles: peer1
  application:
    name: eureka-server
    
eureka:
  instance:
    hostname: peer1
  client:
    service-url:
      defaultZone: http://peer2:8762/eureka
---
server:
  port: 8762

spring:
  profiles: peer2
  application:
    name: eureka-server
    
eureka:
  instance:
    hostname: peer2
  client:
    service-url:
      defaultZone: http://peer1:8761/eureka

配置了两个profile，并且peer1和peer2相互注册对方为defaultZone

修改host文件，增加配置如下

127.0.0.1       peer1 peer2

分别启动profile为peer1的EurekaServerApplication和profile为peer2的EurekaServerApplication。然后访问http://peer1:8761和http://peer2:8762
第一点中的配置文件也可以配置为如下格式

eureka:
  client:
    service-url:
      defaultZone: http://peer1:8761/eureka,http://peer2:8762/eureka
spring:
  application:
    name: eureka-server
---
server:
  port: 8761

spring:
  profiles: peer1
eureka:
  instance:
    hostname: peer1
---
server:
  port: 8762

spring:
  profiles: peer2

eureka:
  instance:
    hostname: peer2

和第一点配置的区别是将defaultZone提出来，这样如果配置三个Eureka服务时，只修改一个地方的defaultZone就可以了

优先使用ip而不是hostname注册到Eureka上

默认情况下，是使用hostname注册到Eureka服务器的。如果hostname无法被java获取时，ip地址就会发送给Eureka服务器。也可以配置优先使用ip地址。示例如下

eureka:
  instance:
    prefer-ip-address: true

保护Eureka

可以通过增加spring-boot-starter-security依赖来保护Eureka服务器。（后续需要通过代码演示）

Eureka可配置的内容

前面看到的只是Eureka配置的一部分内容，其它可以配置的内容可以参考 EurekaInstanceConfigBean 和 EurekaClientConfigBean，其中EurekaInstanceConfigBean 对应的是 eureka.instance.* 配置（instance表示将自己注册为一个实例），而EurekaClientConfigBean对应的是eureka.client.*配置（client表示通过查询注册中心来获取其它服务信息）

状态页和健康检查

状态页对应的地址为/info，健康检查对应的地址为/health。如果使用上下文路径，则需要修改这两个默认的地址

#指定上下文路径
server:
  servlet:
    path: eureka
    
eureka:
  instance:
    status-page-url-path: ${server.servlet.path}/info
    health-check-url-path: ${server.servlet.path}/health

注册安全应用

如果应用通过https访问，需要设置如下标识，说明需要用到安全端口（默认为443）和禁用非安全端口（默认为80）来接收流量（receive traffic）（后续需要查看eureka源码来确认具体的含义）

eureka:
  instance:
    secure-port-enabled: true
    non-secure-port-enabled: false

健康检查

默认情况下，Eureka使用客户端心跳来判断是否客户端还活着。当成功注册后，Eureka服务端会声明客户端为UP状态。可以通过让Eureka启用健康检查来改变这种方式。健康检查可以将应用的状态传递给Eureka服务器。其它应用不会发送非UP状态给该应用。可以通过如下方式打开健康检查

eureka:
  client:
    healthcheck:
      enabled: true

该配置应该配置到application.yml中，配置到bootstrap.yml文件中会导致不可预期的副作用，例如注册到Eureka服务器的状态为 UNKNOWN

元数据

每一个Eureka客户端有一些标准的元数据，比如主机名，IP地址，端口号，状态页和健康检查。这些信息会发布到服务端，其它客户端通过这些信息直接与服务交互。也可以通过 eureka.instance.metadata-map 添加其它的元数据，这些元数据也可以被其它客户端访问到。添加的元数据不会对客户端造成影响。某些元数据已经被SpringCloud赋予意义，比如 vcap.application.instance_id,在Cloud Foundry上默认被设置为 eureka.instance.instanceId 的值

设置Eureka Instance ID

SpringCloud推荐的设置InstanceID值的格式如下

eureka:
  instance:
    instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

含义如下：

默认instanceId为${spring.application.name}:${vcap.application.instance_id}，如果${vcap.application.instance_id}没有设置（不是部署在Cloud Foundry上），则instanceId为${spring.application.name}:${spring.application.instance_id}，如果${spring.application.instance_id}没有设置，则instanceId为${spring.application.name}:${random.value}

EurekaClient排除Jersey

默认情况下，EurekaClient使用Jersey来进行HTTP通信。如果不希望依赖Jersey，可以将它移除。SpringCloud自动配置了基于RestTemplate的传输客户端。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    <exclusions>
        <exclusion>
            <groupId>com.sun.jersey</groupId>
            <artifactId>jersey-client</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.sun.jersey</groupId>
            <artifactId>jersey-core</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.sun.jersey.contribs</groupId>
            <artifactId>jersey-apache-client4</artifactId>
        </exclusion>
    </exclusions>
</dependency>

EurekaClient的替代方案

默认情况下，不应该使用EurekaClient类。SpringCloud使用Feign和RestTemplate，通过Eureka服务标识（VIPs）而不是物理URL地址来调用。如果需要配置Ribbon使用几个固定的物理服务器，可以设置<client>.ribbon.listOfServers属性，值为逗号分隔的物理地址（或主机名），其中<client>是客户端ID。

也可以使用org.springframework.cloud.client.discovery.DiscoveryClient，它提供了简单的API来发现客户端（不是特定与Netflix）

@Autowired
private DiscoveryClient discoveryClient;

public String serviceUrl() {
    List<ServiceInstance> list = discoveryClient.getInstances("STORES");
    if (list != null && list.size() > 0 ) {
        return list.get(0).getUri();
    }
    return null;
}

注册服务为何如此慢

作为一个实例，也需要周期性地和服务器保持心跳（通过客户端的serviceUrl），默认间隔为30秒。直到实例、服务器和客户端在自己本地缓存中都有相同的元数据时，服务器才可用（因此最多需要3次心跳）。可以通过eureka.instance.leaseRenewalIntervalInSeconds属性修改心跳周期。当设置的值小于30时，就会加快客户端与其它服务的连接。在生产环境中，最好使用默认值，因为服务器内部会猜测该值（租约续延期lease renewal period）。

Zone

如果Eureka客户端部署在多个区域（Zone），你需要设置客户端优先使用相同区域的服务，而不是不同区域的服务。

需要保证Eureka服务端部署在不同的区域，它们之间是对等的。
需要告诉Eureka服务在哪个区域。可以通过metadataMap属性来做到。例如，如果service 1部署到zone 1和zone 2，需要设置如下Eureka属性

zone 1的service 1

eureka:
  client:
    prefer-same-zone-eureka: true
  instance:
    metadata-map:
      zone: zone1

zone 2的service 1

eureka:
  client:
    prefer-same-zone-eureka: true
  instance:
    metadata-map:
      zone: zone2

刷新Eureka客户端

默认情况下，EurekaClient bean是可刷新端。意味着能够修改并刷新Eureka客户端属性。当刷新操作发生时，客户端会从Eureka服务器注销，服务的所有实例将会有很短的一段时间不可用。消除这种情况的一个办法就是不刷新Eureka客户端。可以通过eureka.client.refresh.enable=false来设置。

加载freemarker模板

默认情况下eureka服务端是使用freemarker模板引擎的。如果你的工程依赖于其它模板（比如thymeleaf），freemarker模板就不会被加载。这种情况下需要在application.yml中手工配置模板加载

spring:
  freemarker:
    template-loader-path: classpath:/templates/
    prefer-file-system-access: false

下面记录一下Eureka监控页面