Apollo客户端使用文档

编辑时间2018.10.12 20.20

最新的文档查看< wiki - Java客户端使用指南 >   

一.客户端使用步骤:

步骤1.添加配置

1.1必须配置

app.id=spring-boot-logger  
apollo.meta=http://139.199.193.xxx:8761 

说明:
app.id应用Id
apollo.meta为apollo元服务地址.因为edp的元服务分离到独立的eureka地址上面去.故此次写eureka地址即可

1.2非必须配置

在bootstrap阶段注入非默认application namespace或多个namespace.使用方式很简单，只需要在application.properties/bootstrap.properties中按照如下样例配置即可。

<!-- 多个namespace-->
apollo.bootstrap.enabled = true  
apollo.bootstrap.namespaces = application,FX.apollo

说明:
FX.apollo指fx部门编码.
apollo为部门下的项目配置.此处仅为举例说明.实际请以具体配置为准

步骤2. 添加Maven Dependency

Apollo的客户端jar包已经上传到中央仓库，应用在实际使用时只需要按照如下方式引入即可。如:

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

步骤3.启动项目验证.

---

二.功能说明:

1.是否具体缓存:具备

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
参考 官方文档 1.2.3 本地缓存路径
参考 官方文档 1.2.3.1 自定义缓存路径

2.是否具备恢复:不具备

apollo不具备自动恢复功能.但可以通过人为的去缓存获取配置.在粘贴到apollo
参考 官方文档 3.2.4 已有配置迁移

3.是否覆盖:会覆盖

如果本地application.yml有一个key(keyName=local),apollo也有一个key(keyName=apollo),那么获取值时:keyName=apollo

---

参考 官方文档:https://github.com/ctripcorp/apollo/wiki/Java客户端使用指南