从REST和Instance角度理解Netfix Eureka

前言

最近项目开始使用到spring cloud作为项目的微服架构，在开发中遇
到很多问题，相信很多多人也遇到，写这篇博客也是谈谈我关于spring cloud中的eureka的一些认识，当中有误的地方还请各位留言指出，多多交流。

首先看看官方对eureka的定义

Eureka是一个基于REST(Representational State Transfer)服务,主要是用于云服务为目的的中间层服务器的负载平衡和故障转移。Eureka还附带了一个基于java的客户端组件,Eureka客户机使得交互与服务更加容易。客户端也有一个基于循环负载平衡内置的负载均衡器。当然在Netflix中,还提供很多更加能满足复杂要求的负载均衡器，它们基于交通、资源使用、错误条件等因素提供更好的弹性。

这个我根据官方的介绍翻译的原文链接在这https://github.com/Netflix/eureka/wiki/Eureka-at-a-glance/当中有翻译不对的还请留言指出。

从官方的文档中我们能得到这些重要的信息：

1. Eureka是基于REST服务的，也就意味着它是基于http协议的
2. 它分为服务端（java语言实现）和 客服端（可以是java也可以是非Java语言，因为Eureka提供的是 rest服务，当然官方也有提供部分其他语言的官方包）。
3. Eureka的作用是实现为服务间的负载均衡和故障转移。

Eureka的服务端和客服端

Eureka的服务端来管理所有的微服，微服内的所有服务需要依赖Eureka客户端的依赖包，并在application上添加@EnableEurekaClient注解来实现Eureka客户端。

  com.netflix.eureka
  eureka-client
  1.1.16


@EnableEurekaClient
public class ServiceHiApplication {

public static void main(String[] args) {
    SpringApplication.run(ServiceHiApplication.class, args);
}

}

当然还有配置文件需要添加相关的配置，具体的可以参考官方文档https://github.com/Netflix/eureka/wiki/Configuring-Eureka/
,现在网上也有很多相关的博客，这里我就不详细写了。

Eureka的客服端则是通过rest服务通知Eureka的服务端该客服端的健康状况，事实是每个客服端的具体信息保存在InstanceInfo类中，通过ConcurrentHashMap>>
的双层Map结构来管理所有的的客服端。更重要的是其实在每个客服端在以心跳的模式定时通知服务端客户端的实时状态时，客户端也会获得到一份最新的服务端的InstanceInfo列表清单，没错其实每个客服端也能获得微服的所有客服端的健康状况。具体客服端获得服务信息的方法如下：

@Qualifier("eurekaClient")
@Autowired
private EurekaClient eurekaClient;

public String  serviceUrl(){
    InstanceInfo instance = eurekaClient.getNextServerFromEureka("service-hi", false);
    return instance.getHomePageUrl();
}

@Autowired
private DiscoveryClient discoveryClient;
//获得对应服务名下所有的服务实力信息列表，服务如果有做集群，则返回的是该服务集群下的所有实力的列表
List list = discoveryClient.getInstances("service-hi");
if (list != null && list.size() > 0 ) {
    String aa = list.get(0).getUri().getAuthority();
}
    
//获得微服下所有的服务名
List servicesNames = discoveryClient.getServices();
StringBuilder sb = new StringBuilder();
for (String s:servicesNames) {
    sb.append(s+"\t");
}

Eureka的REST服务

上面说过服务端和客户端是通过rest服务实现通信的，也就是说如果我现在想知道服务端下所有客服端的具体信息和健康状况只需要通过一个http请求就可以完成，答案是肯定的，当然本身eureka服务本身就提供了管理界面来查看客户端的具体信息如下：

image

但是这样获得的信息并不完全，所有如果你想获得更加详细的信息，或则你想使用其他编程语言实现客服端的话可以通过Eureka服务提供的接口文档实现注册、取消注册、更新、获得所有InstanceInfo信息等操作,文档如下：

操作	接口地址	描述
注册服务	POST /eureka/v2/apps/appID	Input: JSON/XML payload HTTP Code: 204 on success
取消服务注册	DELETE /eureka/v2/apps/appID/instanceID	HTTP Code: 200 on success
发送一个服务的心跳	PUT /eureka/v2/apps/appID/instanceID	HTTP Code: 200 on success 404 if instanceID doesn’t exist
查询所有服务信息	GET /eureka/v2/apps	HTTP Code: 200 on success Output: JSON/XML
查询所有服务的服务id	GET /eureka/v2/apps/appID	HTTP Code: 200 on success Output: JSON/XML
根据具体服务id查询服务信息	GET /eureka/v2/apps/appID/instanceID	HTTP Code: 200 on success Output: JSON/XML
对于一个具体的实例查询	GET /eureka/v2/instances/instanceID	HTTP Code: 200 on success Output: JSON/XML
停止实力服务	PUT /eureka/v2/apps/appID/instanceID/status?value=OUT_OF_SERVICE	HTTP Code: 200 on success 500 on failure
把实例重新放入服务中	DELETE /eureka/v2/apps/appID/instanceID/status?value=UP (The value=UP is optional, it is used as a suggestion for the fallback status due to removal of the override)	HTTP Code: 200 on success 500 on failure
更新 metadata中的数据	PUT /eureka/v2/apps/appID/instanceID/metadata?key=value	HTTP Code: 200 on success 500 on failure
查询特定vipaddress地址下的所有实例	GET /eureka/v2/vips/vipAddress	HTTP Code: 200 on success Output: JSON/XML 404 if the vipAddress does not exist.
查询特定安全vipaddress下的所有实例	GET /eureka/v2/svips/svipAddress	HTTP Code: 200 on success Output: JSON/XML 404 if the svipAddress does not exist.

官方文档的链接在这：https://github.com/Netflix/eureka/wiki/Eureka-REST-operations/
已获取所有InstanceInfo列表信息为例，我在postman上的请求结果如下：

1
UP_3_

    SERVICE-HI-APPNAME 8763
    
        service-hi
        DESKTOP-CKLCJ5F
        SERVICE-HI-APPNAME 8763
        192.168.1.8
        UP
        UNKNOWN
        8763
        443
        1
        
            MyOwn
        
        
            30
            90
            1510988885998
            1511102494467
            0
            1510988822454
        
        
            testValue4
            testValue3
            testValue2
            testValue1
        
        http://DESKTOP-CKLCJ5F:8763/
        http://DESKTOP-CKLCJ5F:8763/info
        http://DESKTOP-CKLCJ5F:8763/health
        service-hi
        service-hi
        false
        1510988885998
        1510988885942
        ADDED
    


    SERVICE-RIBBON
    
        DESKTOP-CKLCJ5F:service-ribbon:8764
        DESKTOP-CKLCJ5F
        SERVICE-RIBBON
        192.168.1.8
        UP
        UNKNOWN
        8764
        443
        1
        
            MyOwn
        
        
            30
            90
            1510993263471
            1511102494632
            0
            1510988934957
        
        
        http://DESKTOP-CKLCJ5F:8764/
        http://DESKTOP-CKLCJ5F:8764/info
        http://DESKTOP-CKLCJ5F:8764/health
        service-ribbon
        service-ribbon
        false
        1510993263471
        1510993263422
        ADDED
    


    SERVICE-HI-APPNAME 8765
    
        service-hi
        DESKTOP-CKLCJ5F
        SERVICE-HI-APPNAME 8765
        192.168.1.8
        UP
        UNKNOWN
        8765
        443
        1
        
            MyOwn
        
        
            30
            90
            1511100242138
            1511102492656
            0
            1511100242138
        
        
            testValue4
            testValue3
            testValue2
            testValue1
        
        http://DESKTOP-CKLCJ5F:8765/
        http://DESKTOP-CKLCJ5F:8765/info
        http://DESKTOP-CKLCJ5F:8765/health
        service-hi
        service-hi
        false
        1511100242138
        1511100242050
        ADDED
    

上面的信息更加详细，如IP地址、服务的健康状况、instanceId、hostName等信息都可以查到，方便我们在开发中发现问题。

总结

相信讲到这大家对Eureka是如何管理微服务已经有了一定的认识，管理Eureka下的服务其实是管理每个InstanceInfo,而负载均衡，错误故障转移都是基于每个InstanceInfo实现的。后面我会单独对InstanceInfo做更具体的讲解，欢迎大家评论。