教程系列(一):Spring Cloud Tencent 接入注册中心

丁咸
• 阅读 970

导读

注册中心是微服务最核心的组件,本文主要介绍使用 Spring Cloud Tencent 接入北极星注册中心。北极星注册中心具备服务上下线等能力,是一款非常好用的注册中心产品。

Github 地址:https://github.com/Tencent/sp...

模块简介

服务注册发现模块是 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

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

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

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

第二步:引入 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>
  1. 引入 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 接入注册中心

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

拓展使用

元数据

元数据定义

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

<img width="1013" alt="image" src="https://user-images.githubusercontent.com/4991116/170854608-cb3d0e1b-217e-411f-9773-0bf8574356bc.png">

元数据来源

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

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

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

应用在启动注册时,会自动读取配置文件并带上 idc=shanghaienv=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=shanghaiENV=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 接入注册中心

自定义参数

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

完整的的配置列表如下

配置项Key默认值是否必填配置项说明
spring.cloud.polaris.addressPolaris 后端地址
spring.cloud.polaris.namespacedefault服务所在的命名空间名称
spring.cloud.polaris.service${spring.application.name}服务名称
spring.cloud.polaris.local-ip-address注册的 IP 地址,默认情况下 Spring Boot 会自动获取 IP 地址无需指定 IP 地址,当需要自定义 IP 地址时才需要设置
spring.cloud.polaris.discovery.enabledtrue是否开启服务发现
spring.cloud.polaris.discovery.registertrue是否开启服务注册
spring.cloud.polaris.discovery.instance-enabledtrue当前微服务实例是否可以被访问
spring.cloud.polaris.discovery.token鉴权 Token
spring.cloud.polaris.discovery.versionnull微服务版本
spring.cloud.polaris.discovery.protocolnull微服务协议类型
spring.cloud.polaris.discovery.weight100微服务权重
spring.cloud.polaris.discovery.service-list-refresh-interval60000服务列表刷新间隔(毫秒)
点赞
收藏
评论区
推荐文章
捉虫大师 捉虫大师
2年前
如何组装一个注册中心
hello,大家好呀,我是小楼。今天不写BUG,来聊一聊注册中心。标题本来想叫《如何设计一个注册中心》,但网上已经有好多类似标题的文章了。所以打算另辟蹊径,换个角度,如何组装一个注册中心。组装意味着不必从0开始造轮子,这也比较符合许多公司对待自研基础组件的态度。知道如何组装一个注册中心有什么用呢?第一可以更深入理解注册中心。以我个人经历来说,注册中心的第一印
Easter79 Easter79
3年前
springcloud中微服务的优雅停机(已验证)
 大部分项目部署中,为了方便,可能都直接使用kill9服务的pid来停掉服务。但是由于Eureka采用心跳的机制来上下线服务,会导致服务消费者调用此已经kill的服务提供者然后出错。可以采用以下方式来解决:核心是先调用方法主动通知Eureka注册中心服务下线,然后再停掉服务。本文会介绍几种eureka注册中心服务下线的方式最不可取
捉虫大师 捉虫大师
4年前
dubbo应用级服务发现初体验
dubbo应用级服务发现介绍了解dubbo的朋友知道,dubbo的provider启动时向注册中心注册,consumer从注册中心消费。目前dubbo往注册中心上注册的数据是接口级,而应用级服务发现是往注册中心上注册实例(ipport),两者的区别只是注册的粒度不同。至于为什么会出现应用级服务发现,有如下几点原因与业界主流微服务模型对齐,比如Sprin
捉虫大师 捉虫大师
4年前
当我们谈注册中心时我们谈什么
本文已收录https://github.com/lkxiaolou/lkxiaolou欢迎star。最近工作重心转向了注册中心,于是想来写一篇关于注册中心的文章概念什么是注册中心,以大多数人熟悉的RPC框架来说,通常RPC中有三种角色:provider服务提供者consumer服务消费者,即调用方registry注册中心,让consumer
Easter79 Easter79
3年前
springCloud 集群
5.1注册中心集群 1.复制注册中心项目   2.修改yml配置文件      注册中心1中引入注册中心2的url地址       2.1server1的application.yml配置           server:             port:7000           注
捉虫大师 捉虫大师
3年前
Nacos注册中心之概要设计
前言在之前的文章中分析了Nacos配置中心,配置中心的核心是配置的创建、读取、推送。注册中心的核心比配置中心多一个服务探活模块,他俩的相似度非常高,甚至阿里内部的注册中心就叫ConfigServer。Nacos注册中心打算分成几个模块来分析,本文重点在于概要设计,基于2.0.0版本。环境搭建用Nacos的源码来搭建源码阅读和调试环境,可参考Nacos调试
Easter79 Easter79
3年前
SpringCloud注册中心高可用搭建
SpringCloud的注册中心可以由Eureka、Consul、Zookeeper、ETCD等来实现,这里推荐使用SpringCloudEureka来实现注册中心,它基于Netfilix的Eureka做了二次封装,完成分布式服务中服务治理的功能,微服务系统中的服务注册与发现都通过这个注册中心来进行管理。引入EurekaServer依赖
Easter79 Easter79
3年前
SpringCloud常用组件
springcloud中有五大核心组件Eureka、Ribbon、Feign、Hystrix、Zuul,简单记录如下。Eureka是微服务架构中的注册中心,专门负责服务的注册与发现。EurekaClient组件专门负责将服务的信息注册到EurekaServer中,而EurekaServer是一个注册中心,里面有一个注册表,保存了各服务所在
Stella981 Stella981
3年前
Spring Cloud Alibaba Nacos 服务配置中心和注册中心
学习在SpringCloud中使用Nacos实现服务配置中心和注册中心,类似SpringCloudConfig和SpringCloudNetflixEureka提供的功能。1概述SpringCloudAlibaba是阿里巴巴提供的一套微服务开发一站式解决方案。主要提供的功能:分布式配置中心
Stella981 Stella981
3年前
Dubbo HA 高可用
一、zookeeper宕机现象:zookeeper注册中心宕机,还可以消费dubbo暴露的服务健壮性监控中心宕掉不影响使用,只是丢失部分采样数据数据库宕掉后,注册中心仍能通过缓存提供服务列表查询,但不能注册新服务注册中心对等集群,任意一台宕掉后,将
Easter79 Easter79
3年前
Springboot2.x整合SpringCloud之Eureka服务注册中心
一、 什么是服务注册中心服务注册中心是服务实现服务化管理的核心组件,类似于目录服务的作用,主要用来存储服务信息,譬如提供者url串、路由信息等。服务注册中心是SOA架构中最基础的设施之一。1 服务注册中心的作用1,服务的注册2,服务的发现2. 常见