Choerodon 的微服务之路（三）：服务注册与发现

时间 2019-11-12

标签 choerodon 微服之路服务注册发现繁體版

原文原文链接

本文是 Choerodon 的微服务之路系列推文第三篇。在上一篇《Choerodon的微服务之路（二）：微服务网关》中，介绍了Choerodon 在搭建微服务网关时考虑的一些问题以及两种常见的微服务网关模式，而且经过代码介绍了Choerodon 的网关是如何实现的。本篇文章将介绍Choerodon 的注册中心，经过代码的形式介绍 Choerodon 微服务框架中，是如何来实现服务注册和发现的。java

▌文章的主要内容包括：git

服务注册/发现
服务注册表
健康检查

在上一篇文章的开始，咱们提到解决微服务架构中的通讯问题，基本只要解决下面三个问题：github

服务网络通讯能力
服务间的数据交互格式
服务间如何相互发现与调用

网络的互通保证了服务之间是能够通讯的，经过对JSON 的序列化和反序列化来实现网络请求中的数据交互。Choerodon 的 API 网关则统一了全部来自客户端的请求，并将请求路由到具体的后端服务上。然而这里就会有一个疑问，API 网关是如何与后端服务保持通讯的，后端服务之间又是如何来进行通讯的？固然咱们能想到最简单的方式就是经过 URL + 端口的形式直接访问（例如：http://127.0.0.1:8080/v1/hello）。spring

在实际的生产中，咱们认为这种方式应该是被避免的。由于 Choerodon 的每一个服务实例都部署在 K8S 的不一样 pod 中，每个服务实例的 IP 地址和端口均可以改变。同时服务间相互调用的接口地址如何管理，服务自己集群化后又是如何进行负载均衡。这些都是咱们须要考虑的。数据库

为了解决这个问题，天然就想到了微服务架构中的注册中心。一个注册中心应该包含下面几个部分：json

服务注册/发现：服务注册是微服务启动时，将本身的信息注册到注册中心的过程。服务发现是注册中心监听全部可用微服务，查询列表及其网络地址。

服务注册表：用来纪录各个微服务的信息。

服务检查：注册中心使用必定的机制定时检测已注册的服务，若是发现某实例长时间没法访问，就会从服务注册表中移除该实例。

Choerodon 中服务注册的过程以下图所示：后端

服务注册/发现

当咱们经过接口去调用其余服务时，调用方则须要知道对应服务实例的 IP 地址和端口。对于传统的应用而言，服务实例的网络地址是相对不变的，这样能够经过固定的配置文件来读取网络地址，很容易地使用 HTTP/REST 调用另外一个服务的接口。api

可是在微服务架构中，服务实例的网络地址是动态分配的。并且当服务进行自动扩展，更新等操做时，服务实例的网络地址则会常常变化。这样咱们的客户端则须要一套精确地服务发现机制。缓存

Eureka 是 Netflix 开源的服务发现组件，自己是一个基于 REST 的服务。它包含 Server 和 Client 两部分。服务器

Eureka Server 用做服务注册服务器，提供服务发现的能力，当一个服务实例被启动时，会向 Eureka Server 注册本身的信息（例如IP、端口、微服务名称等）。这些信息会被写到注册表上；当服务实例终止时，再从注册表中删除。这个服务实例的注册表经过心跳机制动态刷新。这个过程就是服务注册，当服务实例注册到注册中心之后，也就至关于注册中心发现了服务实例，完成了服务注册/发现的过程。

阅读 Spring Cloud Eureka 的源码能够看到，在 eureka-client-1.6.2.jar 的包中，com.netflix.discovery。 DiscoveryClient 启动的时候，会初始化一个定时任务，定时的把本地的服务配置信息，即须要注册到远端的服务信息自动刷新到注册服务器上。该类包含了 Eureka Client 向 Eureka Server 注册的相关方法。

在 DiscoveryClient 类有一个服务注册的方法 register()，该方法是经过 HTTP 请求向 Eureka Server 注册。其代码以下：

boolean register() throws Throwable {
        logger.info(PREFIX + appPathIdentifier + ": registering service...");
        EurekaHttpResponse<Void> httpResponse;
        try {
            httpResponse = eurekaTransport.registrationClient.register(instanceInfo);
        } catch (Exception e) {
            logger.warn("{} - registration failed {}", PREFIX + appPathIdentifier, e.getMessage(), e);
            throw e;
        }
        if (logger.isInfoEnabled()) {
            logger.info("{} - registration status: {}", PREFIX + appPathIdentifier, httpResponse.getStatusCode());
        }
        return httpResponse.getStatusCode() == 204;
    }

对于 Choerodon 而言，客户端依旧采用 Eureka Client，而服务端采用 GoLang 编写，结合 K8S，经过主动监听 K8S 下 pod 的启停，发现服务实例上线，Eureka Client 则经过 HTTP 请求获取注册表，来实现服务注册/发现过程。

注册中心启动时，会构造一个 podController，用来监听pod 的生命周期。代码以下：

func Run(s *options.ServerRunOptions, stopCh <-chan struct{}) error {
    ... ... 
    podController := controller.NewController(kubeClient, kubeInformerFactory, appRepo)


    go kubeInformerFactory.Start(stopCh)

    go podController.Run(instance, stopCh, lockSingle)

    return registerServer.PrepareRun().Run(appRepo, stopCh)
}

在 github.com/choerodon/go-register-server/controller/controller.go 中定义了 Controller，提供了 Run() 方法，该方法会启动两个进程，用来监听环境变量 REGISTER_SERVICE_NAMESPACE 中配置的对应 namespace 中的 pod，而后在 pod 启动时，将 pod 信息转化为自定义的服务注册信息，存储起来。在 pod 下线时，从存储中删除服务信息。其代码以下：

func (c *Controller) syncHandler(key string, instance chan apps.Instance, lockSingle apps.RefArray) (bool, error) {
    namespace, name, err := cache.SplitMetaNamespaceKey(key)
    if err != nil {
    	runtime.HandleError(fmt.Errorf("invalid resource key: %s", key))
    	return true, nil
    }   
    pod, err := c.podsLister.Pods(namespace).Get(name)
    if err != nil {
    	if errors.IsNotFound(err) {
    		if ins := c.appRepo.DeleteInstance(key); ins != nil {
    			ins.Status = apps.DOWN
    			if lockSingle[0] > 0 {
    				glog.Info("create down event for ", key)
    				instance <- *ins
    			}
    		}
    		runtime.HandleError(fmt.Errorf("pod '%s' in work queue no longer exists", key))
    		return true, nil
    	}   
    	return false, err
    }   
    _, isContainServiceLabel := pod.Labels[ChoerodonServiceLabel]
    _, isContainVersionLabel := pod.Labels[ChoerodonVersionLabel]
    _, isContainPortLabel := pod.Labels[ChoerodonPortLabel] 
    if !isContainServiceLabel || !isContainVersionLabel || !isContainPortLabel {
    	return true, nil
    }   
    if pod.Status.ContainerStatuses == nil {
    	return true, nil
    }   
    if container := pod.Status.ContainerStatuses[0]; container.Ready && container.State.Running != nil && len(pod.Spec.Containers) > 0 {
    	if in := convertor.ConvertPod2Instance(pod); c.appRepo.Register(in, key) {
    		ins := *in
    		ins.Status = apps.UP
    		if lockSingle[0] > 0 {
    			glog.Info("create up event for ", key)
    			instance <- ins
    		}
    	}   
    } else {
    	if ins := c.appRepo.DeleteInstance(key); ins != nil {
    		ins.Status = apps.DOWN
    		if lockSingle[0] > 0 {
    			glog.Info("create down event for ", key)
    			instance <- *ins
    		}
    	}
    }   
    return true, nil
}

github.com/choerodon/go-register-server/eureka/repository/repository 中的 ApplicationRepository 提供了 Register() 方法，该方法手动将服务的信息做为注册表存储在注册中心中。

func (appRepo *ApplicationRepository) Register(instance *apps.Instance, key string) bool {

    if _, ok := appRepo.namespaceStore.Load(key); ok {
    	return false
    } else {
    	appRepo.namespaceStore.Store(key, instance.InstanceId)
    }
    appRepo.instanceStore.Store(instance.InstanceId, instance)
    return true
}

经过上面的代码咱们能够了解到Choerodon 注册中心是如何实现服务注册的。有了注册中心后，下面咱们来介绍下服务发现中的服务注册表。

服务注册表

在微服务架构中，服务注册表是一个很关键的系统组件。当服务向注册中心的其余服务发出请求时，请求调用方须要获取注册中心的服务实例，知道全部服务实例的请求地址。

Choerodon 沿用 Spring Cloud Eureka 的模式，由注册中心保存服务注册表，同时客户端缓存一份服务注册表，每通过一段时间去注册中心拉取最新的注册表。

在github.com/choerodon/go-register-server/eureka/apps/types 中定义了 Instance 对象，声明了一个微服务实例包含的字段。代码以下：

type Instance struct {
    InstanceId       string            `xml:"instanceId" json:"instanceId"`
    HostName         string            `xml:"hostName" json:"hostName"`
    App              string            `xml:"app" json:"app"`
    IPAddr           string            `xml:"ipAddr" json:"ipAddr"`
    Status           StatusType        `xml:"status" json:"status"`
    OverriddenStatus StatusType        `xml:"overriddenstatus" json:"overriddenstatus"`
    Port             Port              `xml:"port" json:"port"`
    SecurePort       Port              `xml:"securePort" json:"securePort"`
    CountryId        uint64            `xml:"countryId" json:"countryId"`
    DataCenterInfo   DataCenterInfo    `xml:"dataCenterInfo" json:"dataCenterInfo"`
    LeaseInfo        LeaseInfo         `xml:"leaseInfo" json:"leaseInfo"`
    Metadata         map[string]string `xml:"metadata" json:"metadata"`
    HomePageUrl      string            `xml:"homePageUrl" json:"homePageUrl"`
    StatusPageUrl    string            `xml:"statusPageUrl" json:"statusPageUrl"`
    HealthCheckUrl   string            `xml:"healthCheckUrl" json:"healthCheckUrl"`
    VipAddress       string            `xml:"vipAddress" json:"vipAddress"`
    SecureVipAddress string            `xml:"secureVipAddress" json:"secureVipAddress"`

    IsCoordinatingDiscoveryServer bool `xml:"isCoordinatingDiscoveryServer" json:"isCoordinatingDiscoveryServer"`    
    LastUpdatedTimestamp uint64 `xml:"lastUpdatedTimestamp" json:"lastUpdatedTimestamp"`
    LastDirtyTimestamp   uint64 `xml:"lastDirtyTimestamp"   json:"lastDirtyTimestamp"`
    ActionType           string `xml:"actionType" json:"actionType"`
}

客户端能够经过访问注册中心的/eureka/apps 接口获取对应的注册表信息。以下所示：

{
  "name": "iam-service",
  "instance": [
    {
      "instanceId": "10.233.73.39:iam-service:8030",
      "hostName": "10.233.73.39",
      "app": "iam-service",
      "ipAddr": "10.233.73.39",
      "status": "UP",
      "overriddenstatus": "UNKNOWN",
      "port": {
        "@enabled": true,
        "$": 8030
      },
      "securePort": {
        "@enabled": false,
        "$": 443
      },
      "countryId": 8,
      "dataCenterInfo": {
        "name": "MyOwn",
        "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo"
      },
      "leaseInfo": {
        "renewalIntervalInSecs": 10,
        "durationInSecs": 90,
        "registrationTimestamp": 1542002980,
        "lastRenewalTimestamp": 1542002980,
        "evictionTimestamp": 0,
        "serviceUpTimestamp": 1542002980
      },
      "metadata": {
        "VERSION": "2018.11.12-113155-master"
      },
      "homePageUrl": "http://10.233.73.39:8030/",
      "statusPageUrl": "http://10.233.73.39:8031/info",
      "healthCheckUrl": "http://10.233.73.39:8031/health",
      "vipAddress": "iam-service",
      "secureVipAddress": "iam-service",
      "isCoordinatingDiscoveryServer": true,
      "lastUpdatedTimestamp": 1542002980,
      "lastDirtyTimestamp": 1542002980,
      "actionType": "ADDED"
    }
  ]
}

咱们能够在服务注册表中获取到全部服务的 IP 地址、端口以及服务的其余信息，经过这些信息，服务直接就能够经过 HTTP 来进行访问。有了注册中心和注册表以后，咱们的注册中心又是如何来确保服务是健康可用的，则须要经过健康检查机制来实现。

健康检查

在咱们提供了注册中心以及服务注册表以后，咱们还须要确保咱们的服务注册表中的信息，与服务实际的运行状态保持一致，须要提供一种机制来保证服务自身是可被访问的。在Choerodon微服务架构中处理此问题的方法是提供一个健康检查的端点。当咱们经过 HTTP 进行访问时，若是可以正常访问，则应该回复 HTTP 状态码200，表示健康。

Spring Boot 提供了默认的健康检查端口。须要添加spring-boot-starter-actuator 依赖。

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

访问 /health 端点后，则会返回以下相似的信息表示服务的状态。能够看到 HealthEndPoint 给咱们提供默认的监控结果，包含磁盘检测和数据库检测等其余信息。

{
    "status": "UP",
    "diskSpace": {
        "status": "UP",
        "total": 398458875904,
        "free": 315106918400,
        "threshold": 10485760
    },
    "db": {
        "status": "UP",
        "database": "MySQL",
        "hello": 1
    }
}

可是由于 Choerodon 使用的是 K8S 做为运行环境。咱们知道 K8S 提供了 liveness probes 来检查咱们的应用程序。而对于 Eureka Client 而言，服务是经过心跳来告知注册中心本身是 UP 仍是 DOWN的。这样咱们的系统中则会出现两种检查机制，则会出现以下几种状况。

K8S 经过，/health 经过
K8S 经过，/health 未经过
K8S 未经过，/health 经过

第一种状况，当两种都经过的话，服务是能够被访问的。

第二种状况，K8S 认为服务是正常运行的，但注册中心认为服务是不健康的，注册表中不会记录该服务，这样其余服务则不能获取该服务的注册信息，也就不会经过接口进行服务调用。则服务间不能正常访问，以下图所示：

第三种状况，服务经过心跳告知注册中心本身是可用的，可是可能由于网络的缘由，K8S 将 pod 标识为不可访问，这样当其余服务来请求该服务时，则不能够访问。这种状况下服务间也是不能正常访问的。以下图所示：

同时，当咱们配置了管理端口以后，该端点则须要经过管理端口进行访问。能够再配置文件中添加以下配置来修改管理端口。

management.port: 8081

当咱们开启管理端口后，这样会使咱们的健康检查变得更加复杂，健康检查并不能获取服务真正的健康状态。

在这种状况下，Choerodon 使用 K8S 来监听服务的健康端口，同时须要保证服务的端口与管理端口都能被正常访问，才算经过健康检查。能够在部署的 deploy 文件中添加 readinessProbe 参数。

apiVersion: v1
kind: Pod
spec:
  containers:
    readinessProbe:
      exec:
        command:
        - /bin/sh
        - -c
        - curl -s localhost:8081/health --fail && nc -z localhost 8080
      failureThreshold: 3
      initialDelaySeconds: 60
      periodSeconds: 10
      successThreshold: 1
      timeoutSeconds: 10

这样，当咱们的服务启动以后，才会被注册中心正常的识别。当服务状态异常时，也能够尽快的从注册表中移除。

总结

回顾一下这篇文章，咱们介绍了 Choerodon 的注册中心，经过代码的形式介绍了 Choerodon 微服务框架中，是如何来实现服务注册和发现的，其中 Spring Cloud 的版本为 Dalston.SR4。具体的代码能够参见咱们的 github 地址（https://github.com/choerodon/go-register-server）。

更多关于微服务系列的文章，点击蓝字可阅读 ▼

Choerodon的微服务之路(二)：微服务网关

Choerodon的微服务之路(一)：如何迈出关键的第一步

关于Choerodon猪齿鱼

Choerodon猪齿鱼是一个开源企业服务平台，是基于Kubernetes的容器编排和管理能力，整合DevOps工具链、微服务和移动应用框架，来帮助企业实现敏捷化的应用交付和自动化的运营管理的开源平台，同时提供IoT、支付、数据、智能洞察、企业应用市场等业务组件，致力帮助企业聚焦于业务，加速数字化转型。

你们也能够经过如下社区途径了解猪齿鱼的最新动态、产品特性，以及参与社区贡献：

官网：http://choerodon.io
论坛：http://forum.choerodon.io
Github：https://github.com/choerodon
微信：Choerodon猪齿鱼
微博：Choerodon猪齿鱼

欢迎加入Choerodon猪齿鱼社区，共同为企业数字化服务打造一个开放的生态平台