Java学习笔记 - Apollo分布式配置中心

 

一、Apollo概述

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

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

• 统一管理不同环境、不同集群的配置
  • Apollo提供了一个统一界面，集中式管理不同环境（environment）、不同集群（cluster）、不同命名空间（namespace）的配置。
  • 同一份代码部署在不同的集群，可以有不同的配置，比如zookeeper的地址等。
  • 通过命名空间（namespace）可以很方便地支持多个不同应用共享同一份配置，同时还允许应用对共享的配置进行覆盖。
• 配置修改实时生效（热发布）
  • 用户在Apollo修改完配置并发布后，客户端能实时（1秒）接收到最新的配置，并通知到应用程序。
• 版本发布管理
  • 所有的配置发布都有版本概念，从而可以方便地支持配置的回滚。
• 灰度发布
  • 支持配置的灰度发布，比如点了发布后，只对部分应用实例生效，等观察一段时间没问题后再推给所有应用。
• 权限管理、发布审核、操作审计
  • 应用和配置的管理都有完善的权限管理机制，对配置的管理还分为了编辑和发布两个环节，从而减少人为的错误。
  • 所有的操作都有审计日志，可以方便地追踪问题。
• 客户端配置信息监控
  • 可以在界面上方便地看到配置在被哪些实例使用。
• 提供Java和.Net原生客户端
  • 提供了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实现过程

 

上图简要描述了Apollo客户端的实现原理：
（1）客户端和服务端保持了一个长连接，从而能第一时间获得配置更新的推送。
（2）客户端还会定时从Apollo配置中心服务端拉取应用的最新配置。

这是一个fallback机制，为了防止推送机制失效导致配置不更新。

客户端定时拉取会上报本地版本，所以一般情况下，对于定时拉取的操作，服务端都会返回 304 - Not Modified。

定时频率默认为每5分钟拉取一次，客户端也可以通过在运行时指定 System Property: apollo.refreshInterval 来覆盖，单位为分钟。

（3）客户端从Apollo配置中心服务端获取到应用的最新配置后，会保存在内存中。
（4）客户端会把从服务端获取到的配置在本地文件系统缓存一份。

在遇到服务不可用或网络不通的时候，依然能从本地恢复配置。

（5）应用程序从Apollo客户端获取最新的配置、订阅配置更新通知。
 

三、搭建Apollo服务端

 
Apollo配置中心运行在linux系统中。

环境要求：

• Java
  Apollo服务端：1.8+
  Apollo客户端：1.7+
  由于需要同时运行服务端和客户端，所以建议安装Java 1.8+。

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

环境搭建
（1）下载Apollo安装包
通过官网提供的 https://github.com/apolloconfig/apollo-build-scripts 下载安装包，然后解压即可。

（2）配置数据库
Apollo服务端共需要两个数据库： ApolloPortalDB 和 ApolloConfigDB ，在安装包的sql文件夹中有这两个数据库的sql文件（创建数据库、创建表和生成样例数据），只需要导入MySQL数据库即可。如果本地已经创建过Apollo数据库，请注意备份数据，因为sql文件会清空Apollo相关的表。

（3）配置数据库连接
Apollo服务端需要知道如何连接到前面创建的 ApolloPortalDB 和 ApolloConfigDB 数据库，所以需要编辑demo.sh，修改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个服务，分别使用8070、8080、8090端口，请确保这3个端口当前没有被使用。

./demo.sh start

（4） 访问网址
通过浏览器打开 http://ip地址:8080可以访问Eureka服务注册中心，可以注册客户端微服务到该注册中心。
通过浏览器打开 http://ip地址:8070 可以访问Apollo配置中心的前端页面，输入默认用户名/密码（apollo/admin）即可登录。
 

四、客户端集成

 
（1）登录Apollo配置中心的前端页面后点击 创建项目，先创建一个AppId为user-server的项目。


（2）在客户端微服务中的pom.xml导入以下依赖。

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

（3）Spring Boot支持通过application.properties/bootstrap.properties来配置，该方式能使配置在更早的阶段注入，比如使用 @ConditionalOnProperty 的场景或者是有一些spring-boot-starter在启动阶段就需要读取配置做一些事情，所以对于Spring Boot环境建议通过以下方式来接入Apollo(需要0.10.0及以上版本）。

• 在application.yml中加入如下配置。

apollo:
  bootstrap: # 开启apollo
    enabled: true
  meta: http://ip地址:8080
app:
  id: user-server # 指定apollo配置中心的AppId

（4）点击 Edit Configurations 进入启动配置，在VM options中加入 -Denv=DEV ，设置配置环境为apllo配置中心的前端页面中的DEV，最后运行该客户端即可。

（5）发布新增配置（例子）
在application.yml文件中，比如例子1中的name代表配置属性的key，zhangsan代表配置属性的value。比如例子2中的server.port代表配置属性的key，9000代表配置属性的value。

# 例子1
name: zhangsan 
# 例子2
server:
  port: 9000

点击新增配置按钮，添加新的配置。


点击发布按钮，发布新增配置。