SpringCloud 整合 Apollo 配置中心

介绍

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

 

Apollo 优点

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

  • Apollo提供了一个统一界面集中式管理不同环境（environment）、不同集群（cluster）、不同命名空间（namespace）的配置。
  • 同一份代码部署在不同的集群，可以有不同的配置，比如zk的地址等
  • 通过命名空间（namespace）可以很方便的支持多个不同应用共享同一份配置，同时还允许应用对共享的配置进行覆盖

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

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

• 版本发布管理

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

• 灰度发布

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

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

  • 应用和配置的管理都有完善的权限管理机制，对配置的管理还分为了编辑和发布两个环节，从而减少人为的错误。
  • 所有的操作都有审计日志，可以方便的追踪问题。

• 客户端配置信息监控

  • 可以方便的看到配置在被哪些实例使用

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

  • 提供了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还提供了打包脚本，一键就可以生成所有需要的安装包，并且支持自定义运行时参数

 

更多详细介绍见官网

官方github：https://github.com/ctripcorp/apollo

 

部署Apollo

环境要求

Apollo 服务端: java 1.8+

Apollo 客户端: java 1.7+

Mysql : 5.6.5+.

 

部署Apollo只需要三步

1. 创建数据库

获取 apolloportaldb.sql , 与 apolloconfigdb.sql

运行sql文件创建数据库

portalDB 验证:

执行sql: select `Id`, `Key`, `Value`, `Comment` from `ApolloPortalDB`.`ServerConfig` limit 1;

查询结果：

Id	Key	Value	Comment
1	apollo.portal.envs	dev	可支持的环境列表

 

 

configDB 验证:

执行sql: select `Id`, `Key`, `Value`, `Comment` from `ApolloConfigDB`.`ServerConfig` limit 1;

执行结果：

Id	Key	Value	Comment
1	eureka.service.url	http://127.0.0.1:8080/eureka/	Eureka服务Url

 

 

 

2. 下载工程

从官方下载: apollo-configservice、apollo-adminservice、apollo-portal 三个工程,  分别解压三个工程目录

 

 

3. 修改各工程配置

apollo-configservice, apollo-adminservice 配置修改:

修改两个目录下的 config/application-github.properties 文件, 配置为数据库连接信息, 连接到数据库: apolloconfigdb

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/apolloconfigdb?characterEncoding=utf8
spring.datasource.username = username
spring.datasource.password = password

 

apollo-portal 配置修改:

portal 使用的是 apolloportaldb 数据库

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8
spring.datasource.username = username
spring.datasource.password = password

修改meta service 信息

Apollo Portal 需要在不同的环境访问不同的 meta service(apollo-configservice) 地址，所以我们需要在配置中提供这些信息。默认情况下，meta service 和 config service 是部署在同一个 JVM进程，所以 meta service 的地址就是 config service 的地址。配置文件 /config/apollo-env.properties, 这里是将所有环境配置成一样的, 如果不需要这些环境可以删掉

local.meta=http://localhost:8080
dev.meta=http://localhost:8080
fat.meta=http://localhost:8080
uat.meta=http://localhost:8080
lpt.meta=${lpt_meta}
pro.meta=http://localhost:8080

启动Apollo

每个工程下都有 scripts 目录, 该目录下包含 startup.sh 启动脚本 以及 shutdown.sh 关闭脚本

三个工程的启动顺序: apollo-configservice、apollo-adminservice、apollo-portal

也可以自己写个脚本， 方便一次分别先后启动三个工程

startup.sh:

#!/bin/bash
sh apollo-adminservice/scripts/startup.sh
sh apollo-configservice/scripts/startup.sh
sh apollo-portal/scripts/startup.sh

shutdown.sh: 

sh apollo-adminservice/scripts/shutdown.sh
sh apollo-configservice/scripts/shutdown.sh
sh apollo-portal/scripts/shutdown.sh

Apollo 已经自带 Eureka 注册中心, 启动完毕之后访问 localhost:8080 可见

 

接下来访问 localhost:8070, Apollo 管理员界面

默认账号密码为:

apollo

admin

 

可以看到配置中心管控端的界面。

 

创建项目后 点击发布

 

点击新增配置

 

 

新增或修改配置之后可见提示, 配置需要发布之后才可生效

 

namespace

可以创建多个namespace 来适用不同的配置

 

一般情况下推荐创建私有的, properties格式

   

 

Apollo 客户端

添加pom依赖

<apollo.version>1.1.0</apollo.version>

<dependency>
    <groupId>com.ctrip.framework.apollo</groupId>
    <artifactId>apollo-client</artifactId>
    <version>${apollo.version}</version>
</dependency>

application.yml:

app:
  # 与apollo的admin管理界面添加的 appId 一致
  id: spring-cloud
apollo:
  # meta的url
  meta: http://localhost:8080
  bootstrap:
    enabled: true
    # 从 namespace 中获取配置, 多个以逗号隔开, namespace的配置非properties格式的需要加后缀名
    namespaces: application,gateway,redis
    eagerLoad:
      enabled: true

 

最后在Appliction 类加上 @EnableApolloConfig 注解

启动之后, 配置将被拉取到客户端中

 

 

测试:

创建一个 controller

使用 @value 注入配置信息

访问controller 输出@Value 信息

修改配置中心配置后点击发布, 再次访问controller 输出@value 注入的信息

 

以上就是SpringCloud与 Apollo 整合的基础内容了, 后续详解 Apollo 项目管理、配置、灰度发布、环境以及集群的使用