apollo入门到二次开发

囧囧有神璐璐
469 阅读6分钟

Apollo 是什么？

其官方文档自我介绍如下：

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

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

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

.Net 客户端不依赖任何框架，能够运行于所有 .Net 运行时环境。

核心功能

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

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

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

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

单机部署图

  • Apollo Config Service：提供配置的读取、推送等功能，服务对象是 Apollo 客户端。

  • Apollo Admin Service：提供配置的修改、发布等功能，服务对象是Apollo Portal（管理界面）。
    为什么 Config Service 和 Admin Service 分离呢？在图中，我们可以看到 Config Service 和 Admin Service 读取的是相同的 ApolloPortalDB 数据库，理论上来说可以做成一个服务。

    不过 Admin Service 因为需要不断开发 API 接口提供给 Apollo Portal，因此可能会不定期重启。而 Config Service 功能比较单纯，基本不会有太多更新，因此基本不太会重启。所以，将 Admin Service 和 Config Service 拆分成两个服务。

  • Apollo Portal：Apollo 的管理界面，进行配置和发布，服务对象是开发者和开放平台 API。

    为什么 Admin Service 和 Portal 分离呢？在 Apollo 的设计中，不同的 DEV、FAT、UAT、PROD 环境，会部署在不同的网络环境下，进行隔离。

    因此，每个环境会部署一套 Admin Service + Config Service。而 Portal 通过调用不同环境部署的 Admin Service 提供的 API 接口，进行不同环境的配置管理。

    另外，权限管理、开放平台 API 都是由 Portal 统一实现来提供的。

快速启动

1:把apollo项目下载下来

2:按照如下链接启动项目

www.apolloconfig.com/#/zh/deploy…

客户端使用

Java客户端使用：www.apolloconfig.com/#/zh/usage/…

.NET客户端使用：www.apolloconfig.com/#/zh/usage/…

其他客户端使用：www.apolloconfig.com/#/zh/usage/…

页面使用指南

www.apolloconfig.com/#/zh/usage/…

二次开发

非常好的文档

验证码:coke

www.iocoder.cn/categories/…

涉及到研发经常使用方法

Spring Annotation支持

Apollo同时还增加了几个新的Annotation来简化在Spring环境中的使用。

  1. @ApolloConfig
    • 用来自动注入Config对象
  2. @ApolloConfigChangeListener
    • 用来自动注册ConfigChangeListener
  3. @ApolloJsonValue
    • 用来把配置的json字符串自动注入为对象

使用样例

public class TestApolloAnnotationBean {  @ApolloConfig  private Config config; //inject config for namespace application  @ApolloConfig("application")  private Config anotherConfig; //inject config for namespace application  @ApolloConfig("FX.apollo")  private Config yetAnotherConfig; //inject config for namespace FX.apollo  @ApolloConfig("application.yml")  private Config ymlConfig; //inject config for namespace application.yml    /**   * ApolloJsonValue annotated on fields example, the default value is specified as empty list - []   * <br />   * jsonBeanProperty=[{"someString":"hello","someInt":100},{"someString":"world!","someInt":200}]   */  @ApolloJsonValue("${jsonBeanProperty:[]}")  private List<JsonBean> anotherJsonBeans;   @Value("${batch:100}")  private int batch;     //config change listener for namespace application  @ApolloConfigChangeListener  private void someOnChange(ConfigChangeEvent changeEvent) {    //update injected value of batch if it is changed in Apollo    if (changeEvent.isChanged("batch")) {      batch = config.getIntProperty("batch", 100);    }  }    //config change listener for namespace application  @ApolloConfigChangeListener("application")  private void anotherOnChange(ConfigChangeEvent changeEvent) {    //do something  }    //config change listener for namespaces application, FX.apollo and application.yml  @ApolloConfigChangeListener({"application", "FX.apollo", "application.yml"})  private void yetAnotherOnChange(ConfigChangeEvent changeEvent) {    //do something  }   //example of getting config from Apollo directly  //this will always return the latest value of timeout  public int getTimeout() {    return config.getIntProperty("timeout", 200);  }   //example of getting config from injected value  //the program needs to update the injected value when batch is changed in Apollo using @ApolloConfigChangeListener shown above  public int getBatch() {    return this.batch;  }   private static class JsonBean{    private String someString;    private int someInt;  }}

在Configuration类中按照下面的方式使用：

@Configuration@EnableApolloConfigpublic class AppConfig {  @Bean  public TestApolloAnnotationBean testApolloAnnotationBean() {    return new TestApolloAnnotationBean();  }}

覆盖系统属性

适用于2.1.0及以上版本

apollo.override-system-properties 标识Apollo的远程属性是否应该覆盖Java的系统属性。默认为 true。

配置方式按照优先级从高到低分别为：

  1. 通过Java System Property apollo.override-system-properties
    • 可以通过Java的System Property apollo.override-system-properties来指定
    • 在Java程序启动脚本中，可以指定-Dapollo.override-system-properties=true
      • 如果是运行jar文件，需要注意格式是java -Dapollo.override-system-properties=true -jar xxx.jar
    • 也可以通过程序指定，如System.setProperty("apollo.override-system-properties", "true");
  2. 通过Spring Boot的配置文件
    • 可以在Spring Boot的application.properties或bootstrap.properties中指定apollo.override-system-properties=true
  3. 通过app.properties配置文件
    • 可以在[classpath:/META-INF/app.properties](http://classpath/META-INF/app.properties)指定apollo.override-system-properties=true

参考文档

apollo开发指南：www.apolloconfig.com/#/zh/develo…

源码分析：www.iocoder.cn/categories/…

apollo使用指南：www.apolloconfig.com/#/zh/usage/…

avatar
文章
阅读
粉丝