Apollo配置中心

Apollo介绍

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

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

  • application (应用)
  • environment (环境)
  • cluster (集群)
  • namespace (命名空间)
  • Apollo的优势

    正是基于配置的特殊性,所以Apollo从设计之初就立志于成为一个有治理能力的配置发布平台,目前提供了以下的特性:

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

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

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

  • 配置修改实时生效(热发布)

  • 用户在Apollo修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序
  • 提供了Java和.Net的原生客户端,方便应用集成
  • 支持Spring Placeholder, Annotation和Spring Boot的ConfigurationProperties,方便应用使用(需要Spring 3.1.1+)
  • 同时提供了Http接口,非Java和.Net应用也可以方便地使用
  • 提供开放平台API

  • Apollo自身提供了比较完善的统一配置管理界面,支持多环境、多数据中心配置管理、权限、流程治理等特性。不过Apollo出于通用性考虑,不会对配置的修改做过多限制,只要符合基本的格式就能保存,不会针对不同的配置值进行针对性的校验,如数据库用户名、密码,Redis服务地址等
  • 对于这类应用配置,Apollo支持应用方通过开放平台API在Apollo进行配置的修改和发布,并且具备完善的授权和权限控制
  • 配置中心作为基础服务,可用性要求非常高,这就要求Apollo对外部依赖尽可能地少
  • 目前唯一的外部依赖是MySQL,所以部署非常简单,只要安装好Java和MySQL就可以让Apollo跑起来
  • Apollo还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数
  • Apollo的优势还可以通过与Spring Cloud Config对比来体现出

    Apollo的核心概念介绍

    Namespace

    Namespace就相当于spring boot项目中的配置文件,例如namespace中有默认的application,格式为properties,则对应着application.properties。

    1 Namespace的格式

    配置文件有多种格式,例如:properties、xml、yml、yaml、json等。同样Namespace也具有这些格式。

    2 Namespace的获取权限分类

    Namespace的获取权限分为两种:

    private (私有的)
    public (公共的)
    这里的获取权限是相对于Apollo客户端来说的。

    2.1 private权限

    private权限的Namespace,只能被所属的应用获取到。一个应用尝试获取其它应用private的Namespace,Apollo会报“404”异常。

    2.2 public权限

    public权限的Namespace,能被任何应用获取。

    3. Namespace的类型

    Namespace类型有三种:

  • 关联类型(继承类型)
  • 3.1 私有类型

    私有类型的Namespace具有private权限。例如上文提到的“application” Namespace就是私有类型。

    3.2 公共类型
    3.2.1 含义
    公共类型的Namespace具有public权限。公共类型的Namespace相当于游离于应用之外的配置,且通过Namespace的名称去标识公共Namespace,所以公共的Namespace的名称必须全局唯一。

    3.2.2 使用场景

  • 部门级别共享的配置
  • 小组级别共享的配置
  • 几个项目之间共享的配置
  • 中间件客户端的配置
  • 3.3 关联类型

    3.3.1 含义

    关联类型又可称为继承类型,关联类型具有private权限。关联类型的Namespace继承于公共类型的Namespace,用于覆盖公共Namespace的某些配置。例如公共的Namespace有两个配置项

    k1 = v1

    k2 = v2

    然后应用A有一个关联类型的Namespace关联了此公共Namespace,且覆盖了配置项k1,新值为v3。那么在应用A实际运行时,获取到的公共Namespace的配置为:

    k1 = v3

    k2 = v2

    Apollo服务端(测试客户端用)

    1 准备工作

    apollo服务端要求1.8+

    apollo客户端要求1.7+

    1.2 MySQL

    版本要求5.6.5+

    1.3 下载Quick Start安装包

    从Github下载

  • checkout或下载 apollo-build-scripts 项目
  • 由于Quick Start项目比较大,所以放在了另外的repository,请注意项目地址
  • https://github.com/nobodyiam/apollo-build-scripts
  • 2. 安装步骤

    2.1 创建数据库

    Apollo服务端共需要两个数据库: ApolloPortalDB 和 ApolloConfigDB ,数据库、表的创建和样例数据都分别准备了sql文件,只需要导入数据库即可。

    验证方法:

    ApolloPortalDB:

      select `Id`, `AppId`, `Name` from ApolloPortalDB.App;
    

    ApolloConfigDB:

      select `NamespaceId`, `Key`, `Value`, `Comment` from ApolloConfigDB.Item;
    

    如果都有查询出结果那表示数据库创建成功。

    2.2 配置数据库连接信息

    Apollo服务端需要知道如何连接到你前面创建的数据库,所以需要编辑demo.sh,修改ApolloPortalDB和ApolloConfigDB相关的数据库连接串信息。

    注意:填入的用户需要具备对ApolloPortalDB和ApolloConfigDB数据的读写权限。

    # apollo config db info
    apollo_config_db_url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8
    apollo_config_db_username=用户名
    apollo_config_db_password=密码(如果没有密码,留空即可)
    # apollo portal db info
    apollo_portal_db_url=jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8
    apollo_portal_db_username=用户名
    apollo_portal_db_password=密码(如果没有密码,留空即可)
    

    3 启动Apollo配置中心

    Apollo的quick start脚本会在本地启动三个端口分别为8070、8080、8090的服务,需在确保端口未被占用的情况下执行脚本

    ./demo.sh start 
    

    eg:关闭服务的命令:

    ./demo.sh stop
    

    当看到如下输出后,就说明启动成功了!

    ==== starting service ====
    Service logging file is ./service/apollo-service.log
    Started [10768]
    Waiting for config service startup.......
    Config service started. You may visit http://localhost:8080 for service status now!
    Waiting for admin service startup....
    Admin service started
    ==== starting portal ====
    Portal logging file is ./portal/apollo-portal.log
    Started [10846]
    Waiting for portal startup......
    Portal started. You can visit http://localhost:8070 now!
    

    如果启动遇到了异常,可以分别查看service和portal目录下的log文件排查问题。

    注:在启动apollo-configservice的过程中会在日志中输出eureka注册失败的信息,如com.sun.jersey.api.client.ClientHandlerException: java.net.ConnectException: Connection refused。需要注意的是,这个是预期的情况,因为apollo-configservice需要向Meta Server(它自己)注册服务,但是因为在启动过程中,自己还没起来,所以会报这个错。后面会进行重试的动作,所以等自己服务起来后就会注册正常了。

    服务端使用

    通过访问http://localhost:8070/可访问web页面的服务端。

    初始账号/密码为:admin/apollo

    具体使用指南可参考官网

    该服务端只是用来初步体验和测试使用。

    Apollo的客户端

    Apollo支持基于Spring Boot、基于Java、基于XML等等多种方式的配置,具体详情可参考官网

    Apollo会在本地存一份缓存配置文件

  • Mac/Linux上文件位置为/opt/data/{appId}/config-cache
  • Windows上文件位置为C:\opt\data{appId}\config-cache
  • 本地配置文件会以{appId}+{cluster}+{namespace}.properties的文件名和格式存储,当获取不到网络配置时会从这个配置中取值
  • 下面我就介绍最常用、简便、快捷、通用的方式,即基于Spring Boot的集成方式。

    1 首先加入依赖

    <dependency>
        <groupId>com.ctrip.framework.apollo</groupId>
        <artifactId>apollo-client</artifactId>
        <version>1.1.0</version>
    </dependency>
    

    2 在服务应用的配置中加入以下配置(本例子中的文件为application.yml):

    id: test-app apollo: meta: http://localhost:8080 #cluster: myCluster #cacheDir: /opt/testDir bootstrap: enable: true namespaces: application env: DEV
  • app.id为在服务端web页面上创建的项目APP的id
  • apollo.meta为apollo服务端的地址
  • apollo.cluster为要配置的集群名称,如果没有可不填
  • apollo.cacheDir为自定义缓存路径
  • apollo.bootstrap.enable为是否在工程启动的bootstrap阶段向Spring容器注入被托管的namespaces中的配置
  • apollo.bootstrap.namespaces为要使用的namespaces,可在web页面上看到
  • env为要获取的配置环境,目前支持以下几个值(大小写不敏感):
  • DEV(Development environment)
  • FAT(Feature Acceptance Test environment)
  • UAT(User Acceptance Test environment)
  • PRO(Production environment)
  • 在启动Spring Boot的java文件中添加注解:

    @EnableApolloConfig
    

    Apollo客户端的使用

  • 通过@Value注解即可获取到值

  • 可以以类的方式作为bean加载入Spring,例如

     @EnableApolloConfig
     @Configuration
     Class A {
         @Bean
         public getB() {
             return new B();
     Class B {
         private int x;
         public void setX(int x) {
             this.x = x;
         public int getX() {
             return this.x;