Apollo配置中心

Posted 2020-12-22 roadlandscape

Apollo简介：

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

　　Apollo包括服务端和客户端两部分：

　　　　服务端基于Spring Boot和Spring Cloud开发，打包后可以直接运行，不需要额外安装Tomcat等应用容器。

　　　　Java客户端不依赖任何框架，能够运行于所有Java运行时环境，同时对Spring/Spring Boot环境也有较好的支持。

Apollo特性：

　　1.统一管理不同环境、不同集群的配置

　　　　Apollo 提供了一个统一界面集中式管理不同环境（environment）、不同集群（cluster）、不同命名空间（namespace）的配置。

　　　　同一份代码部署在不同的集群，可以有不同的配置，比如 zookeeper 的地址等

　　　　通过命名空间（ namespace）可以很方便地支持多个不同应用共享同一份配置，同时还允许应用对共享的配置进行覆盖

　　2.配置修改实时生效（热发布）

　　　　用户在 Apollo修改完配置并发布后，客户端能实时（1秒）接收到最新的配置，并通知到应用程序

　　3.版本发布管理

　　　　所有的配置发布都有版本概念，从而可以方便地支持配置的回滚

　　4.灰度发布

　　　　支持配置的灰度发布，比如点了发布后，只对部分应用实例生效，等观察一段时间没问题后再推给所有应用实例

　　5.权限管理、发布审核、操作审计

　　　　应用和配置的管理都有完善的权限管理机制，对配置的管理还分为了编辑和发布两个环节，从而减少人为的错误。

　　　　所有的操作都有审计日志，可以方便地追踪问题

　　6.客户端配置信息监控

　　　　可以在界面上方便地看到配置在被哪些实例使用

　　7.提供 Java和.Net原生客户端

　　　　提供了 Java和.Net的原生客户端，方便应用集成

　　　　支持 Spring Placeholder, Annotation和Spring Boot的ConfigurationProperties，方便应用使用（需要Spring 3.1.1+）

　　　　同时提供了 Http接口，非Java和.Net应用也可以方便地使用

　　8.提供开放平台 API

　　　　Apollo 自身提供了比较完善的统一配置管理界面，支持多环境、多数据中心配置管理、权限、流程治理等特性。不过Apollo出于通用性考虑，不会对配置的修改做过多限制，只要符合基本的格式就能保存，不会针对不同的配置值进行针对性的校验，如数据库用户名、密码，Redis服务地址等

　　　　对于这类应用配置， Apollo支持应用方通过开放平台API在Apollo进行配置的修改和发布，并且具备完善的授权和权限控制

Apollo 快速入门：

　　执行流程：

　　　　

 　　　　操作流程如下：

　　　　　　1、在Apollo配置中心修改配置

　　　　　　2、应用程序通过Apollo客户端从配置中心拉取配置信息
　　　　　　用户通过Apollo配置中心修改或发布配置后，会有两种机制来保证应用程序来获取最新配置：一种是Apollo配置中心会向客户端推送最新的配置；另外一种是Apollo客户端会定时从Apollo配置中心拉取最新的配置，通过以上两种机制共同来保证应用程序能及时获取到配置。

　　安装Apollo：

　　　　运行时环境：

　　　　　　Apollo 服务端：JDK1.8+　　Apollo 客户端：JDK1.7+

　　　　　　mysql版本要求： 5.6.5+　　Apollo的表结构对 timestamp 使用了多个default声明，所以需要5.6.5以上版本。

　　　　下载配置：https://github.com/ctripcorp/apollo/tags

　　　　　　

 　　　　创建数据库：

　　　　　　Apollo服务端共需要两个数据库： ApolloPortalDB 和 ApolloConfigDB ，ApolloPortalDB只需要在生产环境部署一个即可，而ApolloConfigDB需要在每个环境部署一套。

　　　　　　1. 创建ApolloPortalDB，sql脚本下载地址：https://github.com/ctripcorp/apollo/blob/v1.3.0/scripts/db/migration/configdb/V1.0.0__initialization.sql

　　　　　　2. 创建ApolloConfigDB，sql脚本下载地址：https://github.com/ctripcorp/apollo/blob/v1.3.0/scripts/db/migration/configdb/V1.0.0__initialization.sql

　　　　 启动Apollo：

　　　　　　1. 确保端口未被占用

　　　　　　　　Apollo默认会启动3个服务，分别使用8070, 8080, 8090端口，请确保这3个端口当前没有被使用

　　　　　　2. 启动apollo-configservice，在apollo目录下执行如下命令，可通过-Dserver.port=8080修改默认端口

java -Dserver.port=8080 -Xms256m -Xmx256m -Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8 -Dspring.datasource.username=root -Dspring.datasource.password=root -jar apollo-configservice-1.3.0.jar

　　　　　　3. 启动apollo-adminservice

java -Dserver.port=8090 -Xms256m -Xmx256m -Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8 -Dspring.datasource.username=root -Dspring.datasource.password=root -jar apollo-adminservice-1.3.0.jar

　　　　　　4. 启动apollo-portal

java -Dserver.port=8070 -Xms256m -Xmx256m -Ddev_meta=http://localhost:9090/ -Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8 -Dspring.datasource.username=root -Dspring.datasource.password=root -jar apollo-portal-1.3.0.jar

　　　　　　5. 也可以使用提供的runApollo.bat快速启动三个服务（需要先编辑修改数据库连接地址，数据库以及密码）

　　　　　　6.待启动成功后，访问 http://localhost:9092/ 默认登录账号密码 apollo/admin 

　　代码实现：

　　　　1.发布配置

　　　　　　新建项目：apollo-quickstart

　　　　　　　　

 　　　　　　新增配置：新增配置后还要发布，才能被应用程序读取到

　　　　　　　　

 　　　　2.应用读取配置

　　　　　　新建Maven工程，添加apollo依赖：

    <dependencies>
        <dependency>
            <groupId>com.ctrip.framework.apollo</groupId>
            <artifactId>apollo‐client</artifactId>
            <version>1.1.0</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.27</version>
        </dependency>
    </dependencies>

　　　　　　编写测试类GetConfigTest，读取sms.enable的值：

public class GetConfigTest {
    public static void main(String[] args) {
        Config config = ConfigService.getAppConfig();
        // Config config = ConfigService.getConfig("namespace");
        String key = "sms.enable";
        String value = config.getProperty(key, null); // 第二个参数表示取不到值则采用默认值
        System.out.println(value);
    }
}

　　　　　　测试：需要配置VM options，设置系统属性

　　　　　　　　-Dapp.id=apollo-quickstart -Denv=DEV -Ddev_meta=http://localhost:8080

　　　　　　如果需要读取配置中心集群中的配置：

 

 

 

 　　　　　　　　

Apollo 应用：

　　核心概念：

　　　　1. application (应用)
　　　　　　实际使用配置的应用，Apollo客户端在运行时需要知道当前应用是谁，从而可以去获取对应的配置
　　　　　　关键字：appId
　　　　2. environment (环境)
　　　　　　配置对应的环境，Apollo客户端在运行时需要知道当前应用处于哪个环境，从而可以去获取应用的配置
　　　　　　关键字：env
　　　　3. cluster (集群)
　　　　　　一个应用下不同实例的分组，比如典型的可以按照数据中心分，把上海机房的应用实例分为一个集群，把北京机房的应用实例分为另一个集群。
　　　　　　关键字：cluster
　　　　4. namespace (命名空间)
　　　　　　一个应用下不同配置的分组，可以简单地把namespace类比为文件，不同类型的配置存放在不同的文件中，如数据库配置文件，RPC配置文件，应用自身的配置文件等
　　　　　　关键字：namespaces

　　　　

Apollo 应用于分布式系统：

　　1.Spring Boot应用集成

　　　　创建工程，引入依赖：

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <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.3.0</version>
        </dependency>
    </dependencies>

　　　　application.properties配置文件：

#这项也可以交给配置中心管理，下面的三项不可以
server.port = 63000

app.id = account-service
apollo.bootstrap.enabled = true
apollo.bootstrap.namespaces = application,micro_service

　　　　apollo控制台创建对应上面配置文件的项目，以及添加配置文件：

　　　　　　

 　　　　　　

　　　　Apollo Meta Server：

　　　　　　Apollo支持应用在不同的环境有不同的配置，常用的指定方式有如下两种：

　　　　　　　　第一种：通过 Java System Property的apollo.meta： -D环境.meta=http://localhost:8080　　根据不同环境可以指定多个

　　　　　　　　第二种：在 resources目录下新建apollo-env.properties文件

dev.meta = http://localhost:8080
pro.meta = http://localhost:8081

　　　　本地缓存路径：

　　　　　　Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份，用于在遇到服务不可用，或网络不通的时候，依然能从本地恢复配置，不影响应用正常运行。本地配置文件会以下面的文件名格式放置于配置的本地缓存路径下：{appId}+{cluster}+{namespace}.properties

　　　　　　可以通过如下方式指定缓存路径，通过Java System Property的apollo.cacheDir：

　　　　　　　　‐Dapollo.cacheDir=d:/apollo‐config

　　　　Environment：

　　　　　　通过Java System Property的env来指定环境： - Denv=DEV

　　　　　　此参数决定了 Apollo Meta Server 使用哪个配置中心

　　　　Cluster（集群）：

　　　　　　通过Java System Property的apollo.cluste来指定集群： - Dapollo.cluster=DEFAULT

　　　　控制层读取apollo中的配置：

@RestController
public class AccountController {

    @Value("${sms.enable}")
    private Boolean smsEnable;

    @GetMapping("/sms")
    public String getSmsConfig() {
        return "smsEnable: " + smsEnable;
    }

    @GetMapping("/timeout")
    public Long getTimeout(@Value("${timeout}") Long timeout) {
        return timeout;
    }
}

　　　　启动类：启动类需要添加 @EnableApolloConfig 注解

@SpringBootApplication
@EnableApolloConfig
public class AccountApplication {
    public static void main(String[] args) {
        SpringApplication.run(AccountApplication.class, args);
    }
}

　　　　启动访问 http://localhost:63000/sms  http://localhost:63000/timeout 响应成功

生产环境部署：

　　在企业中常用的部署方案为：Apollo-adminservice和Apollo-configservice两个服务分别在线上环境(pro)，仿真环境(uat)和开发环境(dev)各部署一套，Apollo-portal作为管理端只部署一套，统一管理上述三套环境。