## 一、Spring Boot应用集成apollo客户端 我们以aservice-sms（前面章节已经多次介绍）为例来集成apollo客户端，集成apollo客户端的配置方式有很多种，此处我只选择我推荐的那一种方式。（想学习多种方式，看本文末尾的附录） **先通过maven坐标引入apollo-client** ~~~ <dependency> <groupId>com.ctrip.framework.apollo</groupId> <artifactId>apollo-client</artifactId> <version>1.6.0</version> </dependency> ~~~ **在resources目录下新建apollo-env.properties文件** 为每一种环境指定获取配置的configservice地址，configservice地址可以制定多个，用逗号分隔 ~~~ dev.meta=http://192.168.161.3:9431,http://192.168.161.4:9431,http://192.168.161.5:9431 #pro.meta=http://localhost:8081 //我们暂时没有在apollo中心添加生产环境，注释掉 ~~~ **配置appid和metaservice(configservice)服务地址** ~~~ app: id: dongbb-cloud-aservice-sms apollo: bootstrap: enabled: true meta: http://192.168.161.3:9431,http://192.168.161.4:9431,http://192.168.161.5:9431 ~~~ * appid要与apollo服务配置中心新建项目时候，配置的appid一致 * apollo.meta作用是：当apollo客户端从apollo-env.properties配置的configservice无法取得连接时，会找apollo.meta配置信息去获取连接。所以它是起到一个备份的作用（我们目前只搭建了DEV环境，就和dev.meta配置一样就可以） * apollo.bootstrap.enabled=true表示在应用一启动的时候，就去加载配置信息。这对于SpringBoot中的一些配置装载类的正确执行来说很重要。 **启用apollo配置开关** 在应用的启动类添加`@EnableApolloConfig`注解即可：  ## 二、配置信息发布 首先我们去apollo配置中心新增一个项目：dongbb-cloud-aservice-sms，对应我们dongbb项目的aservice-sms子服务模块。  项目创建完成之后，我们就要添加配置了，我们先来看一下aservice-sms有哪些配置信息  从上图看配置信息可以分为两大块 * 第一块：apollo服务的配置信息（图中蓝色部分） * 第二块：spring boot项目配置信息（图中红色部分）。需要注意的是我们项目使用eureka，就没有必要单独搭建了。因为apollo的configservice中默认包含了eureka。就指向这个地址就可以了。（图中橘色部分） 因为我们要进行集中的配置管理，所以需要把图中红色部分的配置放到apollo服务配置中心里面进行发布。我们的项目是使用yaml进行配置管理的，apollo配置中心目前只支持properties格式，所以我们需要转换一下：[可以使用这个网址在线转换](https://www.toyaml.com/index.html)  然后copy左侧properties配置信息，到apollo配置中心“发布”配置。（发布到DEV环境的dongbb-cloud-aservice-sms项目，注意下图中左侧红色部分）  ## 三、应用启动与验证 apollo的配置发布之后，我们就可以启动应用了，在启动之前我们需要去配置启动参数：`-Denv=DEV`，也就是告诉springboot应用去加载DEV环境的配置信息。  在linux环境下启动，使用如下命令： ~~~ java -jar aservice-sms-1.0.jar -Denv=ENV ~~~ 怎么样算是成功了呢？ 1. 访问eureka界面：[http://192.168.161.3:9431/](http://192.168.161.3:9431/)，显示ASERVICE-SMS服务启动状态为UP 2. apollo的项目视图中，“实例列表”显示我们启动的实例，已经正确的将配置信息获取到  3. 启动日志不报错，明确显示如下信息  **集成了apollo客户端之后，以后所有的需要写入application.yml配置文件的配置信息，就不要再写到application.yml配置文件里面了，而是去apollo服务配置中心进行增加或者修改。** ## 附录: Apollo客户端配置详解 Apollo客户端依赖于AppId，Apollo Meta Server等环境信息来工作，所以请确保下面的配置正确。每种配置都有好几种实现方式，我们在实际的开发中，只使用其中一种就可以，我会在我选择的那种上加上“推荐”二字： ### Environment Environment可以通过以下3种方式的任意一个配置： * 通过Java System Property（推荐） * 在Java程序启动脚本中，可以指定-Denv=YOUR-ENVIRONMENT * 如果是运行jar文件，需要注意格式是java -Denv=YOUR-ENVIRONMENT -jar xxx.jar 注意key为全小写 * 通过操作系统的System Environment * 还可以通过操作系统的System Environment 的ENV环境变量来指定，注意key为全大写 * 通过配置文件 * 对于Mac/Linux，文件位置为/opt/settings/server.properties * 对于Windows，文件位置为C:\\opt\\settings\\server.properties * 文件内容形如：env=DEV 目前，env支持以下几个值（大小写不敏感）： DEV FAT UAT PRO ### AppId配置方法 AppId是应用的身份信息，是配置中心的一个项目id，一般和应用名称保持一致，是从服务端获取配置的一个重要信息。有以下3种方式设置，按照优先级从高到底分别为： * System Property 通过System Property传入app.id信息，如：`-Dapp.id=YOUR-APP-ID` * Spring Boot application.properties（.yml）（**推荐**） 通过Spring Boot的application.properties文件配置，如：`app.id=YOUR-APP-ID` * app.properties 确保classpath:/META-INF/app.properties文件存在，并且其中内容形如：`app.id=YOUR-APP-ID` ### Apollo Meta Server Apollo支持应用在不同的环境有不同的配置，所以需要在运行提供给Apollo客户端当前环境信息。默认情况下，meta server和config service是部署在同一个JVM进程，所以meta server的地址就是config service的地址。支持以下方式配置apollo meta server信息，按照优先级从高到底分别为： * 可以通过Java的System Property apollo.meta来指定 * 启动脚本中，格式为： -Dapollo.meta=http://config-service-url * 运行jar文件，格式为：java -Dapollo.meta=http://config-service-url -jar xxx.jar * 程序指定，如System.setProperty("apollo.meta", "[http://config-service-url](http://config-service-url/)"); * 通过Spring Boot的配置文件（推荐） * 可以在Spring Boot的application.properties或bootstrap.properties中指定apollo.meta=http://config-service-url * 通过操作系统的System Environment  APOLLO\_META * 可以通过操作系统的System Environment  APOLLO\_META来指定，key为全大写，且中间是\_分隔 * 通过server.properties配置文件 * 可以在server.properties配置文件中指定apollo.meta=http://config-service-url * 对于Mac/Linux，文件位置为/opt/settings/server.properties * 对于Windows，文件位置为C:\\opt\\settings\\server.properties * 通过app.properties配置文件 * 可以在classpath:/META-INF/app.properties指定apollo.meta=http://config-service-url * 通过Java system property  ${env}\_meta * 如果当前env是dev，那么用户可以配置-Ddev\_meta=http://config-service-url * 通过apollo-env.properties文件（推荐） * **这种方法可以根据环境的不同，去不同的configservice获取配置信息**，从而达到区分环境加载配置信息的作用，所以推荐 * 用户也可以创建一个apollo-env.properties，放在程序的classpath下，或者放在spring boot应用的config目录下，文件内容形如： * 如果通过下面的各种环境metaservice都无法获取到Meta Server地址，Apollo最终会fallback到http://apollo.meta作为Meta Server地址 ~~~ 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 ~~~ ### 默认本地缓存路径 Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份，用于在遇到服务不可用，或网络不通的时候，依然能从本地恢复配置，不影响应用正常运行。 本地缓存路径默认位于以下路径，所以请确保/opt/data或C:\\opt\\data\\目录存在，且应用有读写权限。 * Mac/Linux: /opt/data/{appId}/config-cache * Windows: C:\\opt\\data{appId}\\config-cache 本地配置文件会以下面的文件名格式放置于本地缓存路径下：{appId}+{cluster}+{namespace}.properties * appId就是应用自己的appId，如100004458 * cluster就是应用使用的集群，一般在本地模式下没有做过配置的话，就是default * namespace就是应用使用的配置namespace，默认是application * 文件内容以properties格式存储，key:value。 ### 自定义缓存路径 Apollo 1.0.0版本开始支持以下方式自定义缓存路径，按照优先级从高到底分别为： * 通过Java System Property apollo.cacheDir * 在Java程序启动脚本中，可以指定-Dapollo.cacheDir=/opt/data/some-cache-dir * 如果是运行jar文件，需要注意格式是java -Dapollo.cacheDir=/opt/data/some-cache-dir -jar xxx.jar * 也可以通过程序指定，如System.setProperty("apollo.cacheDir", "/opt/data/some-cache-dir"); * 通过Spring Boot的配置文件 * 可以在Spring Boot的application.properties或bootstrap.properties中指定apollo.cacheDir=/opt/data/some-cache-dir * 通过操作系统的System Environment APOLLO\_CACHEDIR * 可以通过操作系统的System Environment APOLLO\_CACHEDIR来指定 注意key为全大写，且中间是\_分隔 * 通过server.properties配置文件 * 可以在server.properties配置文件中指定apollo.cacheDir=/opt/data/some-cache-dir * 对于Mac/Linux，文件位置为/opt/settings/server.properties * 对于Windows，文件位置为C:\\opt\\settings\\server.properties 注：**本地缓存路径也可用作于容灾目录，如果应用在所有config service都挂掉的情况下需要扩容，那么也可以先把配置从已有机器上的缓存路径复制到新机器上的相同缓存路径。**