分布式系列教程（18） -分布式配置中心Apollo安装与详解

代码已提交至Github，有兴趣的同学可以下载来看看：https://github.com/ylw-github/SpringBoot-Apollo-Demo

本文目录结构：

l____引言

l____ 1. Apollo简介

l________1.1 Apollo特点

l________1.2 Apollo整体架构原理

l____2. Apollo配置中心搭建

l________2.1 版本要求

l________2.2 Apollo数据库设计

l________2.3 Apollo服务搭建

l____3. SpringBoot客户端代码测试

l____总结

引言

项目中配置文件比较繁杂，而且不同环境的不同配置修改相对频繁，每次发布都需要对应修改配置，如果配置出现错误，需要重新打包发布，时间成本较高，因此需要做统一的分布式配置中心，能做到自动更新配置文件信息，解决以上问题。

常用的分布式配置中心框架：

• Disconf（依赖于zookpeer)
• Zookpeer(保证配置文件信息实时更新 -事件通知)
• diamond（阿里巴巴研发）
• Apollo阿波罗（携程研发）
• Redis
• xxl-conf

大型互联网公司自己内部都有自己独立分布式配置中心、独立RPC、独立分布式各种解决方案。

学习分布式配置中心之前，需要明确以下两个中心，区分好：

• 注册中心：主要解决rpc服务治理
• 分布式配置中心：主要解决分布式配置文件管理

本文主要以Apollo分布式配置中心为主题来讲解。

1. Apollo简介

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

1.1 Apollo特点

• 统一管理不同环境、不同集群的配置： 所有的配置发布都有版本概念，从而可以方便的支持配置的回滚。
• 配置修改实时生效（热发布）： 用户在Apollo修改完配置并发布后，客户端能实时（1秒）接收到最新的配置，并通知到应用程序
• 灰度发布：支持配置的灰度发布，比如点了发布后，只对部分应用实例生效，等观察一段时间没问题后再推给所有应用实例。
• 权限管理、发布审核、操作审计： 应用和配置的管理都有完善的权限管理机制，对配置的管理还分为了编辑和发布两个环节，从而减少人为的错误。所有的操作都有审计日志，可以方便的追踪问题。
• Apollo还提供了Java和.Net的原生客户端，方便应用集成支持Spring Placeholder, Annotation和Spring Boot的ConfigurationProperties，方便应用使用（需要Spring 3.1.1+）同时提供了Http接口，非Java和.Net应用也可以方便的使用。
• 提供开放平台API：Apollo自身提供了比较完善的统一配置管理界面，支持多环境、多数据中心配置管理、权限、流程治理等特性。不过Apollo出于通用性考虑，对配置的修改不会做过多限制，只要符合基本的格式就能够保存。对于有些使用方，它们的配置可能会有比较复杂的格式，如xml, json，需要对格式做校验。还有一些使用方如DAL，不仅有特定的格式，而且对输入的值也需要进行校验后方可保存，如检查数据库、用户名和密码是否匹配。对于这类应用，Apollo支持应用方通过开放接口在Apollo进行配置的修改和发布，并且具备完善的授权和权限控制。
• 部署简单 ：配置中心作为基础服务，可用性要求非常高，这就要求Apollo对外部依赖尽可能地少，目前唯一的外部依赖是MySQL，所以部署非常简单，只要安装好Java和MySQL就可以让Apollo跑起来，Apollo还提供了打包脚本，一键就可以生成所有需要的安装包，并且支持自定义运行时参数。

1.2 Apollo整体架构原理

2. Apollo配置中心搭建

Apollo配置中心的搭建分为两步：Apollo数据库设计和Apollo服务的搭建。

2.1 版本要求

Java：

• Apollo服务端：1.8+
• Apollo客户端：1.7+

MySQL：

• 版本要求：5.6.5+

虚拟机内存：

• 必须是2G以上，不然启动不了项目

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

2.2 Apollo数据库设计

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

• ApolloPortalDB下载地址（apolloportaldb.sql）：
  https://github.com/nobodyiam/apollo-build-scripts/blob/master/sql/apolloportaldb.sql
• ApolloConfigDB下载地址（apolloconfigdb.sql）：https://github.com/nobodyiam/apollo-build-scripts/blob/master/sql/apolloconfigdb.sql

在本地MySQL数据库执行apolloportaldb.sql和apolloconfigdb.sql文件：

apolloconfigdb	apolloportaldb

调整ApolloPortalDB.ServerConfig表：

字段解析，可以根据实际情况设置：

1. apollo.portal.envs - 可支持的环境列表:默认值是dev，如果portal需要管理多个环境的话，以逗号分隔即可（大小写不敏感），例如：DEV,FAT,UAT,PRO。
2. organizations - 部门列表：Portal中新建的App都需要选择部门，所以需要在这里配置可选的部门信息。
3. superAdmin - Portal超级管理员： 默认值apollo（默认用户），多个账号以英文逗号分隔(,)。
4. consumer.token.salt - consumer token salt： 如果会使用开放平台API的话，可以设置一个token salt。如果不使用，可以忽略。
5. wiki.address： portal上“帮助”链接的地址，默认是Apollo github的wiki首页，可自行设置。
6. admin.createPrivateNamespace.switch： 是否允许项目管理员创建private namespace。设置为true允许创建，设置为false则项目管理员在页面上看不到创建private namespace的选项。

3.调整ApolloConfigDB.ServerConfig表

字段解析，可以根据实际情况设置：

1. eureka.service.url - Eureka服务Url: apollo-configservice和apollo-adminservice都需要向eureka服务注册，需要配置eureka服务地址。默认apollo-configservice本身就是一个eureka服务，所以只需要填入apollo-configservice的地址即可（本文以此讲解）。如果希望将Config
   Service和Admin Service注册到公司统一的Eureka上，需修改Config Service。
   
2. namespace.lock.switch - 一次发布只能有一个人修改开关:用于发布审核，这是一个功能开关，如果配置为true的话，那么一次配置发布只能是一个人修改，另一个发布。
3. config-service.cache.enabled - 是否开启配置缓存:这是一个功能开关，如果配置为true的话，config
   service会缓存加载过的配置信息，从而加快后续配置获取性能。(默认为false，开启前请先评估总配置大小并调整config
   service内存配置。)

2.3 Apollo服务搭建

下载Quick Start安装包：https://github.com/nobodyiam/apollo-build-scripts，安装包有58M，所以下载挺慢的，因为是一个可以自启动的jar包，里面包含了所有依赖jar包以及一个内置的tomcat容器。

1.上传到部署的服务器（我的服务器地址是：192.168.162.131）：

2.解压并修改demo.sh文件：

unzip apollo-build-scripts-master.zip 
cd apollo-build-scripts-master
vi demo.sh

3.启动项目：

因为是启动3个项目，所以要耐心等候。

./demo.sh start

等了大概5分钟，3个服务终于全部跑起来了，可以看到占内存1.2G，挺好资源的：

3.登录注册中心（ConfigService）和Apollo门户（Portal）看看：

登录注册中心：http://192.168.162.131:8080/，可以看到adminservice和configservice都注册上了。

登录Apollo门户（http://192.168.162.131:8070/signin），登录账号：apollo，密码：admin

可以看到apollo的主界面是这样的：

3. SpringBoot客户端代码测试

代码已上传到Github，可以下载来参考：https://github.com/ylw-github/SpringBoot-Apollo-Demo

在没有引入Apollo之前，每次修改配置信息都要重启服务器，需要先在配置文件里配置参数，例如（application.yml）：

server:
  port: 8090
spring:
  application:
    name: apollo-test
login:
  userName: ylw
  passWord: 123

Controller:

package com.ylw.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class IndexController {
    @Value("${login.userName}")
    private String userName;
    @Value("${login.passWord}")
    private String passWord;
    @RequestMapping("/getLoginMsg")
    public String setString() {
        return userName + " ---- " + passWord;
    }
}

浏览器请求：http://localhost:8090/getLoginMsg，如果需要修改userName和passWord，那么就需要重启服务器。

这个时候分布式配置中心概念就出来了，百花齐放，本文的Apollo分布式配置中心亦如此。下面看看客户端如何集成Apollo分布式配置中心：

1.首先配置文件不需要写配置内容了，删去：

server:
  port: 8090
spring:
  application:
    name: apollo-test
#login:
#  userName: ylw
#  passWord: 123

2.Java代码当然也需要修改，不然代码编译的时候会报错，设置个默认值default。

package com.ylw.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class IndexController {
    @Value("${login.userName:default}")
    private String userName;
    @Value("${login.passWord:default}")
    private String passWord;
    @RequestMapping("/getLoginMsg")
    public String setString() {
        return userName + " ---- " + passWord;
    }
}

3.添加依赖

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

4.启动类添加注解：

@Configuration
@EnableApolloConfig

5.新建app.properties，并配置apollo信息（src/main/resources/META-INF/app.properties）:

6.在Apollo平台新建任务

7.添加配置信息：

8.启动客户端项目

9.发布

点击发布：

可以看到已发布：

浏览器输入（http://localhost:8090/getLoginMsg），可以看到配置信息被修改了：

这样就实现了没有重启服务器来修改配置文件。

最后附上Apollo配置中心设计原理官方链接：https://github.com/ctripcorp/apollo/wiki/Apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83%E8%AE%BE%E8%AE%A1

总结