README

用于（Spring Cloud）Netflix Eureka服务注册和发现的PHP客户端。

安装

您可以使用 Composer 轻松安装此包

composer require "piwvh/php-eureka"

文档

创建Eureka客户端

您需要做的第一件事是使用您的配置创建一个 EurekaClient 实例

$client = new EurekaClient([
    'eurekaDefaultUrl' => 'https://:8761/eureka',
    'hostName' => 'service.hamid.work',
    'appName' => 'service',
    'ip' => '127.0.0.1',
    'port' => ['8080', true],
    'homePageUrl' => 'https://:8080',
    'statusPageUrl' => 'https://:8080/info',
    'healthCheckUrl' => 'https://:8080/health'
]);

所有可用的配置项包括：

• eurekaDefaultUrl（默认：https://:8761）；
• 主机名
• 应用程序名称
• IP
• 状态（默认：UP）
• overriddenStatus（默认：UNKNOWN）
• 端口
• securePort（默认：['443', false]）
• countryId （默认：1）
• dataCenterInfo（默认：['com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo', 'MyOwn']）
• 主页URL
• 状态页URL
• 健康检查URL
• 虚拟IP地址
• 安全虚拟IP地址
• heartbeatInterval（默认：30）
• discoveryStrategy（默认：RandomStrategy）
• 实例提供者

您还可以在创建 EurekaClient 实例后更改配置，使用setter方法

$client->getConfig()->setAppName("my-service");

操作

在创建 EurekaClient 实例后，您将可以进行多个操作

• 注册：将您的服务实例注册到 Eureka

$client->register();

• 注销：从 Eureka 注销您的服务实例

$client->deRegister();

• 心跳：向 Eureka 发送心跳，以确定客户端正在运行（一次性心跳）

$client->heartbeat();

您可以使用 start() 方法注册您的实例并定期发送心跳

$client->start();

使用此方法，首先您的服务将使用您提供的配置在 Eureka 中注册。之后，将根据 heartbeatInterval 配置值定期向 Eureka 发送心跳。此间隔时间可以像任何其他配置项一样更改

$client->getConfig()->setHeartbeatInterval(60); // 60 seconds

显然，此方法应在 CLI 中使用。

• 服务发现：从 Eureka 获取服务实例

$instance = $client->fetchInstance("the-service");
$homePageUrl = $instance->homePageUrl;

发现策略

当从 Eureka 获取服务的实例时，您可能会得到一个可用实例的列表。您可以根据您想要的负载均衡策略选择其中一个。例如，轮询或随机策略可能是您的选择。

目前此库仅支持 RandomStrategy，但您可以通过实现 DiscoveryStrategy 接口的 getInstance() 方法创建自定义策略

class RoundRobinStrategy implements DiscoveryStrategy {

    public function getInstance($instances) {
        // return an instance
    }
    
}

然后，您只需将您的自定义策略引入到 EurekaClient 实例中即可

$client->getConfig()->setDiscoveryStrategy(new RoundRobinStrategy());

本地注册表和缓存

失败是不可避免的，尤其是在云原生或分布式应用程序中。因此，有时由于失败，Eureka 可能不可用。在这种情况下，我们应该有一个本地服务注册表以避免级联故障。

默认情况下，如果 Eureka 不可用，则 fetchInstance() 方法失败，因此应用程序会抛出异常并无法继续工作。为了解决这个问题，您应该在应用程序中创建一个本地注册表。

有一个名为 InstanceProvider 的接口，您可以使用它。您应该实现此接口的 getInstances() 方法，并根据您的理想逻辑返回服务实例。

class MyProvider implements InstanceProvider {

    public function getInstances($appName) { 
        // return cached instances of the service from the database 
    }
}

在这个例子中，我们已经在数据库中缓存了服务的实例，并在Eureka服务不可用时加载它们。

创建自定义提供者后，只需将其添加到配置中，使其正常工作。

$client->getConfig()->setInstanceProvider(new MyProvider());

您的自定义提供者仅在Eureka服务不可用或未正确响应时被调用。

就这样。通过添加此功能，即使Eureka服务不可用，您的应用程序仍然可以继续运行。

要缓存特定服务的所有可用实例，您可以调用fetchInstances()方法，该方法从Eureka获取服务的所有实例。

$instances = $client->fetchInstances("the-service");