Apollo之原理和使用讲解

2024-01-13  本文已影响0人  上善若泪

1 Apollo

1.1 简介

由于 Apollo 概念比较多，刚开始使用比较复杂，最好先过一遍概念再动手实践尝试使用。

1.1.1 背景

随着程序功能的日益复杂，程序的配置日益增多，各种功能的开关、参数的配置、服务器的地址……对程序配置的期望值也越来越高，配置修改后实时生效，灰度发布，分环境、分集群管理配置，完善的权限、审核机制…… 在这样的大环境下，传统的通过配置文件、数据库等方式已经越来越无法满足开发人员对配置管理的需求。因此 Apollo 配置中心应运而生！

1.1.2 简介

Apollo（阿波罗）是携程框架部门研发的开源配置管理中心，能够集中化管理应用不同环境、不同集群的配置，配置修改后能够实时推送到应用端，并且具备规范的权限、流程治理等特性。

1.1.3 特点

特点：

1.2 基础模型

如下即是 Apollo 的基础模型：

0c6d316155de6ea0c8210107aab881cf_a4894de63e8941a088d83b07bad00910.png

1.3 Apollo 四个维度

Apollo支持4个维度管理Key-Value格式的配置：

1.3.1 application

Apollo 客户端在运行时需要知道当前应用是谁，从而可以根据不同的应用来获取对应应用的配置。
每个应用都需要有唯一的身份标识，可以在代码中配置 app.id 参数来标识当前应用，Apollo 会根据此指来辨别当前应用。

1.3.2 environment

在实际开发中，我们的应用经常要部署在不同的环境中，一般情况下分为开发、测试、生产等等不同环境，不同环境中的配置也是不同的，在 Apollo 中默认提供了四种环境：

在程序中如果想指定使用哪个环境，可以配置变量 env 的值为对应环境名称即可。

1.3.3 cluster

一个应用下不同实例的分组，比如典型的可以按照数据中心分，把上海机房的应用实例分为一个集群，把北京机房的应用实例分为另一个集群。
对不同的集群，同一个配置可以有不一样的值，比如说上面所指的两个北京、上海两个机房设置两个集群，两个集群中都有 mysql 配置参数，其中参数中配置的地址是不一样的。

1.3.4 namespace

一个应用中不同配置的分组，可以简单地把 namespace 类比为不同的配置文件，不同类型的配置存放在不同的文件中，如数据库配置文件，RPC 配置文件，应用自身的配置文件等。

熟悉 SpringBoot 的都知道，SpringBoot 项目都有一个默认配置文件 application.yml，如果还想用多个配置，可以创建多个配置文件来存放不同的配置信息，通过指定 spring.profiles.active 参数指定应用不同的配置文件。这里的 namespace 概念与其类似，将不同的配置放到不同的配置 namespace 中。

Namespace 分为两种权限，分别为：

Namespace 分为三种类型，分别为：

1.4 本地缓存

Apollo 客户端会把从服务端获取到的配置在本地文件系统缓存一份，用于在遇到服务不可用，或网络不通的时候，依然能从本地恢复配置，不影响应用正常运行。

本地缓存路径默认位于以下路径，所以请确保/opt/data或C:\opt\data\目录存在，且应用有读写权限。

本地配置文件会以下面的文件名格式放置于本地缓存路径下：{appId}+{cluster}+{namespace}.properties

1.5 客户端设计

1.5.1 客服端拉取原理

1e4ea809f419849c182228307a2fa6ca_d4548c5606094c5b8a8b756a4ea516ee.jpeg

上图简要描述了Apollo客户端的实现原理

1.5.2 配置更新推送实现

前面提到了 Apollo 客户端和服务端保持了一个长连接，从而能第一时间获得配置更新的推送。长连接实际上我们是通过 Http Long Polling 实现的，具体而言：

1.6 总体设计

33cf4835a2047f33fc5411750834c666_294d7f6319b74231985daaa36225e5b7.jpeg

上图简要描述了Apollo的总体设计，我们可以从下往上看：

1.7 可用性考虑

配置中心作为基础服务，可用性要求非常高，下面的表格描述了不同场景下Apollo的可用性：

场景 影响 降级 原因
某台 config service 下线 无影响 Config service无状态，客户端重连其它config service
所有 config service 下线 客户端无法读取最新配置，Portal无影响 客户端重启时,可以读取本地缓存配置文件
某台 admin service 下线 无影响 Admin service无状态，Portal重连其它 admin service
所有 admin service 下线 客户端无影响，portal无法更新配置
某台 portal 下线 无影响 Portal域名通过slb绑定多台服务器，重试后指向可用的服务器
全部 portal 下线 客户端无影响，portal无法更新配置
某个数据中心下线 无影响 多数据中心部署，数据完全同步，Meta Server/Portal 域名通过 slb 自动切换到其它存活的数据中心

2 操作使用

创建一个 Apollo 的客户端项目，引用 Apollo 来实现配置动态更新，不过在此之前我们需要提前进入 Apollo Portal 界面，在里面提前创建一个项目并在其配置一个参数，方便后续客户端引入该配置参数，测试是否能动态变化。

2.1 配置Apollo

2.1.1 登录 Apollo

默认用户名：apollo
密 码：admin

2.1.2 修改与增加部门数据

在登录后创建项目时，选择部门默认只能选择 Apollo 自带的 测试部门1与测试部门2两个选项。

0a9254090c7917cda6fed62e01821cb8_5035517f1cb5441dba8d5075dc2b0bc8.png

开始这真让人迷糊，原来 Apoloo 没有修改或新增部门信息的管理节目，只能通过修改数据库，来新增或者修改数据，这里打开 Portal 对月的数据库中的表 ApolloPortalDB 修改 key 为 organizations 的 value 的 json 数据，改成自己对于的部门信息。

f7d8696246301eb5bbee7ec0fb90a74a_04925367423d4662b7bbe417f9b9eb3b.png

2.1.3 创建一个项目

修改完数据库部门信息后，重新登录 Apollo Portal，然后创建项目，这时候选择部门可以看到已经变成我们自己修改后的部门信息了，选择我们自定义部门，然后设置应用 ID 为 apollo-test，应用名为 apollo-demo

7d368a34be326a95a61f111afd4d8482_cfce87deeec94e9fb7f2afb51b96de25.png

创建完成后进入配置管理界面


4350055cc01215db74ce97fcc4a665e1_59e0cb4b3c0a427dba7874b6d381a312.png

2.1.4 创建一个配置参数

创建一个配置参数，方便后续 Apollo 客户端项目引入该参数，进行动态配置测试。

fa50449a9bb0fb3fc11d5b4a45d37e16_b07851ba04ee403a8160d520f97006a3.png

设置 key 为 test value 为 123456 然后设置一个备注，保存。


d6fd28a3d594b200a9de77275afa6653_a553d3a482b041459b052d298cba7488.png

创建完成后可以看到配置管理节目新增了一条配置


06dbfe3ae08d29c1b317d55487e12542_9044e16dff3d432b87412d13d6c4af9e.png

接下来我们将此配置通过发布按钮，进行发布。


fc9e9a1b3a5eaac60fc50e64e84abad5_55f7eb7af3d746c8bdd7a2131670c83d.png

2.2 创建客户端测试项目

这里创建一个 SpringBoot 项目，引入 Apollo 客户端来来实现与 Apollo 配置中心服务端交互。

2.2.1 pom.xml

 <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.1.8.RELEASE</version>
  </parent>


    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.ctrip.framework.apollo</groupId>
            <artifactId>apollo-client</artifactId>
            <version>1.4.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2.2.2 配置文件添加参数

在 application.yml 配置文件中添加下面参数，这里简单介绍下 Apollo 参数作用：

#应用配置
server:
  port: 8080
spring:
  application:
    name: apollo-demo

#Apollo 配置
app:
  id: apollo-test                            #应用ID
apollo:
  cacheDir: /opt/data/                       #配置本地配置缓存目录
  cluster: default                           #指定使用哪个集群的配置
  meta: http://192.168.2.11:30002            #DEV环境配置中心地址
  autoUpdateInjectedSpringProperties: true   #是否开启 Spring 参数自动更新
  bootstrap:                                
    enabled: true                            #是否开启 Apollo
    namespaces: application                  #设置 Namespace
    eagerLoad:
      enabled: false                         #将 Apollo 加载提到初始化日志系统之前

2.2.3 创建测试 Controller 类

写一个 Controller 类来输出 test 变量的值，使用了 Spring 的 @Value 注解，用于读取配置文件中的变量的值，这里来测试该值，项目启动后读取到的变量的值是设置在 application 配置文件中的默认值，还是远程 Apollo 中的值，如果是 Apollo 中配置的值，那么再测试在 Apollo 配置中心中改变该变量的值后，这里是否会产生变化。

@RestController
public class TestController {

    @Value("${test:默认值}")
    private String test;

    @GetMapping("/test")
    public String test(){
        return "test的值为:" + test;
    }
}

SpringBoot 项目启动类

@SpringBootApplication
public class Application {

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

}

2.2.4 JVM 启动参数添加启动参数

如果 Apollo 是部署在 Kubernetes 环境中的，JVM 参数中必须添加两个变量：

注意：上面 env 指定的环境，要和 apollo.meta 指定 Config 地址的环境一致，例如 -Denv=DEV 即使用开发环境，那么apollo.meta=http://xxx.xxx.xxx:8080这个url 的 Config 也是开发环境下的配置中心服务，而不能是 PRO 或者其它环境下的配置中心。

上一篇 下一篇

猜你喜欢

热点阅读