带你玩转Spring Cloud Tencent（二）服务注册与发现

项目地址

spring-cloud-tencent

模块简介

服务注册发现模块是 Spring Cloud Tencent 最核心的模块之一，实现了标准的 Spring Cloud Discovery SPI 接口 （PolarisDiscoveryClient.java）。任何一个 Spring Cloud 标准应用都能快速平滑的使用 Spring Cloud Tencent Discovery。

Spring Cloud Tencent Discovery 背后对接的是社区流行的统一服务发现和治理平台 Polaris

快速入门

本章节将介绍如何在 Spring Cloud 项目中使用 Spring Cloud Tencent Discovery 的功能。

完整 Example 代码请参考：polaris-discovery-example

第一步：引入 Polaris 服务端

方式一：搭建本地北极星服务

搭建北极星服务请参考 Polaris Getting Started

方式二：使用北极星开源提供的体验环境

• Console Address : http://14.116.241.63:8080/
  • Username: polaris
  • Password: polaris
• Server Address: grpc://183.47.111.80:8091

方式三：使用腾讯云北极星服务

腾讯云提供了免运维的北极星云服务，基于云服务可以快速开通生产级高可用北极星集群 了解更多

第二步：引入 Spring Cloud Tencent Discovery 依赖

1. 参考 Spring Cloud Tencent 版本管理 文档获取最新的版本号，引入 Spring Cloud Tencent Bom，例如：

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.tencent.cloud</groupId>
            <artifactId>spring-cloud-tencent-dependencies</artifactId>
            <version>1.5.0-Hoxton.SR9</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

2. 引入 Spring Cloud Tencent Discovery Starter

<dependency>
    <groupId>com.tencent.cloud</groupId>
    <artifactId>spring-cloud-starter-tencent-polaris-discovery</artifactId>
</dependency>

第三步：增加 Spring Cloud Tencent Discovery Starter 的配置文件

1. 在您的 bootstrap.yml 配置文件中加入以下配置内容

spring:
  application:
    name: ${application.name}
  cloud:
    polaris:
      address: grpc://${修改为第一步部署的 Polaris 服务地址}:8091
      namespace: default

第四步：启动应用

应用成功启动后，到 Polaris 控制台查看服务注册信息。如下图所示：

到此接入 Spring Cloud Tencent Discovery 即已完成。

拓展使用

元数据

元数据定义

服务实例通常带有一系列的标签信息，例如实例所属的机房信息、地域信息、环境信息等，这些信息统称为服务实例的元信息。实例注册到注册中心时，会带上自身的元数据信息。当消费方从注册中心获取到实例时，既可以同时获取到每个实例的元信息。

元数据来源

来源一：项目里的配置文件

在 Spring Cloud 项目里的 application.yml 中配置以下内容:

spring:
  cloud:
    tencent:
      metadata:
        content:
          idc: shanghai
          env: dev1

应用在启动注册时，会自动读取配置文件并带上 idc=shanghai 和 env=dev1 两个元数据信息。

通过配置文件的方式为最直接的方式，但是这种方式有一个最大的弊端，就是设置不同元数据值时需要重新编译打包。本质上的原因就是：大部分的元数据信息属于部署环境的信息或者叫机器的信息，而不是应用静态代码的信息。

来源二：应用启动参数

众所周知，Spring Boot 应用配置文件定义的配置项都可以通过 -D 启动参数覆盖，例如通过以下方式覆盖 env 值为 dev2 ：

Java -jar -Dspring.cloud.tencent.metadata.content.env=dev2  demo.jar

通过启动参数的方式，可以在启动时动态修改元数据信息，而不用重新打包，从而解决了方式一的弊端。

但是这种方式也有弊端，就是谁负责修改启动脚本，加上 -D 参数呢？

大部分情况下，Java -jar 启动命令都放在项目里的 start.sh 脚本里，那也就是说，每次需要增加 -D 参数都要修改 start.sh，这本身也会增加维护成本。

来源三：环境变量

环境变量的方式则完全跟运行的应用解耦，是完完全全的机器信息。Spring Cloud Tencent 约定了前缀 SCT_METADATA_CONTENT_ 的环境变量为应用的元数据信息。例如：

SCT_METADATA_CONTENT_IDC=shanghai
SCT_METADATA_CONTENT_ENV=dev1

应用在启动时，则会自动携带 IDC=shanghai 和 ENV=dev 的元数据。

通过环境变量的方式，paas 平台在拉起一台虚拟机或者一个容器 Pod 时，只需要设置相应的环境变量即可。而应用自身无需做任何其它事情。

以上几种方式，可以通过查看启动日志确认是否正确打标：

grep "Loaded static metadata info" xx.log

来源四：自定义实现 SPI （待实现）

前面三种方式为 SCT（Spring Cloud Tencent 的缩写） 内置的方式，但是并不一定符合每个公司自己的规范或者实现。例如：

• 把元数据放到机器上的某一个配置文件里，例如 /etc/metadata
• 启动时，调用 CMDB 的接口获取元信息

所以 SCT 定义了一个 SPI，方便用户自己实现元数据来源。SCT 在注册前，回调 SPI 获取元数据信息，并注册到注册中心。

控制台调整实例的权重、下线实现等操作

如下图所示，可以在控制台上对实例进行一系列管控操作，例如隔离实例，调整实例权重等。

自定义参数

除了控制台页面可以调整参数以外，Spring Cloud Tencent Discovery 提供了很多自定义参数满足各类场景。以权重随机策略为例，您可以在项目里的 bootstrap.yml 配置文件里配置 spring.cloud.polaris.weight既可以调整权重值（默认为 100）。

完整的的配置列表如下

配置项Key	默认值	是否必填	配置项说明
spring.cloud.polaris.address	无	是	Polaris 后端地址
spring.cloud.polaris.namespace	default	否	服务所在的命名空间名称
spring.cloud.polaris.service	${spring.application.name}	否	服务名称
spring.cloud.polaris.local-ip-address	无	否	注册的 IP 地址，默认情况下 Spring Boot 会自动获取 IP 地址无需指定 IP 地址，当需要自定义 IP 地址时才需要设置
spring.cloud.polaris.discovery.enabled	true	否	是否开启服务发现
spring.cloud.polaris.discovery.register	true	否	是否开启服务注册
spring.cloud.polaris.discovery.instance-enabled	true	否	当前微服务实例是否可以被访问
spring.cloud.polaris.discovery.token	无	否	鉴权 Token
spring.cloud.polaris.discovery.version	null	否	微服务版本
spring.cloud.polaris.discovery.protocol	null	否	微服务协议类型
spring.cloud.polaris.discovery.weight	100	否	微服务权重
spring.cloud.polaris.discovery.service-list-refresh-interval	60000	否	服务列表刷新间隔（毫秒）