SpringCloud 18 —— 配置中心之Apollo (下)

Apollo 准备工作

环境要求

Java: 1.7+
Guava: 15.0+
Apollo客户端默认会引用Guava 19,如果你的项目引用了其它版本,请确保版本号大于等于15.0

注:对于Apollo客户端,如果有需要的话,可以做少量代码修改来降级到Java 1.6,详细信息可以参考github上的Issue 4830

必选设置

Apollo客户端依赖于AppId,Apollo Meta Server等环境信息来工作,所以请确保阅读下面的说明并且做正确的配置:

AppId

AppId是应用的身份信息,是从服务端获取配置的一个重要信息。

有以下几种方式设置,按照优先级从高到低分别为:

  1. System Property
    Apollo 0.7.0+支持通过System Property传入app.id信息,如
	-Dapp.id=YOUR-APP-ID
  1. 操作系统的System Environment
    Apollo 1.4.0+支持通过操作系统的System Environment APP_ID来传入app.id信息,如
	APP_ID=YOUR-APP-ID
  1. Spring Boot application.properties
    Apollo 1.0.0+支持通过Spring Boot的application.properties文件配置,如
	app.id=YOUR-APP-ID
	#此配置方式不适用于多个war包部署在同一个tomcat的使用场景
  1. app.properties
    确保classpath:/META-INF/app.properties文件存在,并且其中内容形如:
	app.id=YOUR-APP-ID

Apollo Meta Server

Apollo支持应用在不同的环境有不同的配置,所以需要在运行提供给Apollo客户端当前环境的Apollo Meta Server信息。默认情况下,meta server和config service是部署在同一个JVM进程,所以meta server的地址就是config service的地址。

为了实现meta server的高可用,推荐通过SLB(Software Load Balancer)做动态负载均衡。Meta server地址也可以填入IP,如http://1.1.1.1:8080,httphttp:// 2.2.2.2:8080,不过生产环境还是建议使用域名(走slb),因为机器扩容、缩容等都可能导致IP列表的变化。

1.0.0版本开始支持以下方式配置apollo meta server信息,按照优先级从高到低分别为:

  1. 通过Java System Property apollo.meta

    • 可以通过Java的System Property apollo.meta来指定
    • 在Java程序启动脚本中,可以指定-Dapollo.meta=http://config-service-url
    • 也可以通过程序指定,如System.setProperty("apollo.meta", "http://config-service-url");
  2. 通过Spring Boot的配置文件

    该配置方式不适用于多个war包部署在同一个tomcat的使用场景

  3. 通过操作系统的System EnvironmentAPOLLO_META

    • 可以通过操作系统的System Environment APOLLO_META来指定
    • 注意key为全大写,且中间是_分隔
  4. 通过server.properties配置文件

    • 可以在server.properties配置文件中指定apollo.meta=http://config-service-url
    • 对于Mac/Linux,文件位置为/opt/settings/server.properties
    • 对于Windows,文件位置为C:\opt\settings\server.properties
  5. 通过app.properties配置文件

  6. 通过Java system property $_meta

  7. 通过操作系统的System Environment $_META (1.2.0版本开始支持)

    • 如果当前env是dev,那么用户可以配置操作系统的System Environment DEV_META=http://config-service-url
    • 注意key为全大写
    • 使用该配置方式,那么就必须要正确配置Environment,详见1.2.4.1 Environment
  8. 通过apollo-env.properties文件

    • 用户也可以创建一个apollo-env.properties,放在程序的classpath下,或者放在spring boot应用的config目录下
    • 使用该配置方式,那么就必须要正确配置Environment,详见1.2.4.1 Environment
    • 文件内容形如:
    	dev.meta=http://1.1.1.1:8080
    	fat.meta=http://apollo.fat.xxx.com
    	uat.meta=http://apollo.uat.xxx.com
    	pro.meta=http://apollo.xxx.com
    

如果通过以上各种手段都无法获取到Meta Server地址,Apollo最终会fallback到http://apollo.meta作为Meta Server地址

自定义Apollo Meta Server地址定位逻辑

在1.0.0版本中,Apollo提供了MetaServerProvider SPI,用户可以注入自己的MetaServerProvider来自定义Meta Server地址定位逻辑。

由于我们使用典型的Java Service Loader模式,所以实现起来还是比较简单的。

有一点需要注意的是,apollo会在运行时按照顺序遍历所有的MetaServerProvider,直到某一个MetaServerProvider提供了一个非空的Meta Server地址,因此用户需要格外注意自定义MetaServerProvider的Order。规则是较小的Order具有较高的优先级,因此Order=0的MetaServerProvider会排在Order=1的MetaServerProvider的前面。

如果你的公司有很多应用需要接入Apollo,建议封装一个jar包,然后提供自定义的Apollo Meta Server定位逻辑,从而可以让接入Apollo的应用零配置使用。比如自己写一个xx-company-apollo-client,该jar包依赖apollo-client,在该jar包中通过spi方式定义自定义的MetaServerProvider实现,然后应用直接依赖xx-company-apollo-client即可。

MetaServerProvider的实现可以参考LegacyMetaServerProviderDefaultMetaServerProvider

跳过Apollo Meta Server服务发现

适用于apollo-client 0.11.0及以上版本

一般情况下都建议使用Apollo的Meta Server机制来实现Config Service的服务发现,从而可以实现Config Service的高可用。不过apollo-client也支持跳过Meta Server服务发现,主要用于以下场景:

  1. Config Service部署在公有云上,注册到Meta Server的是内网地址,本地开发环境无法直接连接
  2. Config Service部署在docker环境中,注册到Meta Server的是docker内网地址,本地开发环境无法直接连接
  3. Config Service部署在kubernetes中,希望使用kubernetes自带的服务发现能力(Service)

针对以上场景,可以通过直接指定Config Service地址的方式来跳过Meta Server服务发现,按照优先级从高到低分别为:

  1. 通过Java System Property apollo.configService
  2. 通过操作系统的System EnvironmentAPOLLO_CONFIGSERVICE
    • 可以通过操作系统的System Environment APOLLO_CONFIGSERVICE来指定
    • 注意key为全大写,且中间是_分隔
  3. 通过server.properties配置文件
    • 可以在server.properties配置文件中指定apollo.configService=http://config-service-url:port
    • 对于Mac/Linux,文件位置为/opt/settings/server.properties
    • 对于Windows,文件位置为C:\opt\settings\server.properties

本地缓存路径

Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份,用于在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置,不影响应用正常运行。

本地缓存路径默认位于以下路径,所以请确保/opt/data或C:\opt\data\目录