SpringCloud-组件之一Eureka客户端

1、Eureka客户端介绍

服务发现是基于微服务的体系结构的主要宗旨之一。尝试手动配置每个客户端或某种形式的约定可能很困难并且很脆弱。Eureka是Netflix Service Discovery服务器和客户端。可以将服务器配置和部署为高可用性，每个服务器将有关已注册服务的状态复制到其他服务器

2、EureKa客户端

要将Eureka客户端应用到项目中，请使用启动器，其组ID为org.springframework.cloud，工件ID为spring-cloud-starter-netflix-eureka-client。

1. 向EureKa注册

当客户端向Eureka注册时，它会提供有关其自身的元数据-例如主机，端口，运行状况指示器URL，主页和其他详细信息。Eureka从属于服务的每个实例接收心跳消息。如果心跳在可配置的时间表上进行故障转移，则通常会将实例从注册表中删除。

以下示例显示了最小的Eureka客户端应用程序：

@SpringBootApplication
@RestController
public class Application {

    @RequestMapping("/")
    public String home() {
        return "Hello world";
    }

    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(true).run(args);
    }

}

请注意，前面的示例显示了普通的Spring Boot应用程序。通过在类路径上使用spring-cloud-starter-netflix-eureka-client，您的应用程序将自动在Eureka服务器中注册。如下例所示，需要进行配置才能找到Eureka服务器：

application.yml：

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

注：defaultZone属性区分大小写，并且需要使用驼峰式大小写，因为serviceUrl属性是Map<String, String>。因此，defaultZone属性不遵循default-zone的常规Spring Boot蛇形惯例。

默认应用程序名称（即服务ID），虚拟主机和非安全端口（从Environment获取）分别为${spring.application.name}，${spring.application.name}和${server.port}。

在类路径上具有spring-cloud-starter-netflix-eureka-client可使应用程序同时进入Eureka “ 实例 ”（即，它自己注册）和“ 客户端 ”（它可以查询注册表以定位其他服务）。实例行为由eureka.instance.*配置键驱动，但是如果确保您的应用程序具有spring.application.name的值（这是Eureka服务ID或VIP的默认值），则默认值很好。

要禁用Eureka Discovery Client，可以将eureka.client.enabled设置为false。当spring.cloud.discovery.enabled设置为false时，Eureka Discovery Client也将被禁用。

2. 通过Eureka服务器进行身份验证

如果其中一个eureka.client.serviceUrl.defaultZone URL内嵌了凭据，则HTTP基本身份验证会自动添加到您的eureka客户端（卷曲样式，如下：http://user:password@localhost:8761/eureka）。对于更复杂的需求，您可以创建类型为DiscoveryClientOptionalArgs的@Bean并将ClientFilter实例注入其中，所有这些实例都应用于从客户端到服务器的调用。

注：由于Eureka中的限制，无法支持每服务器的基本身份验证凭据，因此仅使用找到的第一组凭据。

3. 状态页和运行状况指示器

Eureka实例的状态页和运行状况指示器分别默认为/info和/health，这是Spring Boot Actuator应用程序中有用端点的默认位置。即使您使用非默认上下文路径或Servlet路径（例如server.servletPath=/custom），也需要更改这些内容，即使对于Actuator应用程序也是如此。下面的示例显示两个设置的默认值：

application.yml:

eureka:
  instance:
    statusPageUrlPath: ${server.servletPath}/info
    healthCheckUrlPath: ${server.servletPath}/health

注：在Dalston中，还需要在更改该管理上下文路径时设置状态和运行状况检查URL。从Edgware开始就删除了此要求。

4. 注册安全的应用程序

如果您希望通过HTTPS与您的应用进行联系，则可以在EurekaInstanceConfig中设置两个标志：

• eureka.instance.[nonSecurePortEnabled]=[false]

• eureka.instance.[securePortEnabled]=[true]

这样做会使Eureka发布实例信息，该实例信息显示出对安全通信的明确偏好。对于以这种方式配置的服务，Spring Cloud DiscoveryClient始终返回以https开头的URI。同样，以这种方式配置服务时，Eureka（本机）实例信息具有安全的运行状况检查URL。

由于Eureka在内部工作的方式，它仍然会为状态和主页发布非安全URL，除非您也明确地覆盖了它们。您可以使用占位符来配置eureka实例URL，如以下示例所示：

application.yml：

eureka:
  instance:
    statusPageUrl: https://${eureka.hostname}/info
    healthCheckUrl: https://${eureka.hostname}/health
    homePageUrl: https://${eureka.hostname}/

（请注意，${eureka.hostname}是本机占位符，仅在Eureka的更高版本中可用。您也可以使用Spring占位符来实现相同的目的，例如，使用${eureka.instance.hostName}。）

注：如果您的应用程序在代理后面运行，并且SSL终止在代理中（例如，如果您在Cloud Foundry或其他平台中作为服务运行），则需要确保拦截代理的“ 转发 ”标头并由应用处理。如果嵌入在Spring Boot应用程序中的Tomcat容器具有针对'X-Forwarded-\ *'标头的显式配置，则此操作自动发生。应用程序提供的指向自身的链接错误（错误的主机，端口或协议）表明此配置错误。

5. Eureka的检查

默认情况下，Eureka使用客户端心跳来确定客户端是否启动。除非另有说明，否则发现客户端不会根据Spring Boot Actuator传播应用程序的当前运行状况检查状态。因此，在成功注册之后，Eureka始终宣布该应用程序处于“启动”状态。可以通过启用Eureka运行状况检查来更改此行为，这将导致应用程序状态传播到Eureka。结果，所有其他应用程序都不会将流量发送到处于“ UP”状态以外的其他状态的应用程序。以下示例显示如何为客户端启用运行状况检查：

application.yml：

eureka:
  client:
    healthcheck:
      enabled: true

注：eureka.client.healthcheck.enabled=true仅应在application.yml中设置。在bootstrap.yml中设置该值会导致不良的副作用，例如在Eureka中以UNKNOWN状态注册。

如果您需要对运行状况检查进行更多控制，请考虑com.netflix.appinfo.HealthCheckHandle

6. 使用EurekaClient

一旦拥有作为发现客户端的应用程序，就可以使用它从Eureka服务器发现服务实例。一种方法是使用本地com.netflix.discovery.EurekaClient（而不是Spring Cloud DiscoveryClient），如以下示例所示：

@Autowired
private EurekaClient discoveryClient;

public String serviceUrl() {
    InstanceInfo instance = discoveryClient.getNextServerFromEureka("STORES", false);
    return instance.getHomePageUrl();
}

注：请勿在@PostConstruct方法或@Scheduled方法（或可能尚未启动ApplicationContext的任何地方）中使用EurekaClient。它是通过SmartLifecycle（带有phase=0）进行初始化的，因此最早可以依靠它的是处于更高阶段的另一个SmartLifecycle。

7. 分区域

如果您已将Eureka客户端部署到多个区域，则您可能希望这些客户端在尝试使用其他区域中的服务之前先使用同一区域中的服务。要进行设置，您需要正确配置Eureka客户端。

首先，您需要确保已将Eureka服务器部署到每个区域，并且它们彼此对等。有关 更多信息，请参见区域和区域部分。

接下来，您需要告诉Eureka服务位于哪个区域。您可以使用metadataMap属性来做到这一点。例如，如果将service 1部署到zone 1和zone 2上，则需要在service 1中设置以下Eureka属性：

1区服务1

eureka.instance.metadataMap.zone = zone1
eureka.client.preferSameZoneEureka = true

2区服务1

eureka.instance.metadataMap.zone = zone2
eureka.client.preferSameZoneEureka = true

8. 刷新Eureka客户端

默认情况下，EurekaClient bean是可刷新的，这意味着Eureka客户端属性可以更改和刷新。发生刷新时，客户端将从Eureka服务器中注销，并且可能会在短暂的时间内不提供给定服务的所有实例。消除这种情况的一种方法是禁用刷新Eureka客户端的功能。为此，请设置eureka.client.refresh.enable=false。