-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
其它语言客户端接入指南
以下文档已不再维护，请转至 其它语言客户端接入指南 获取最新文档。
目前Apollo团队由于人力所限，只提供了Java和.Net的客户端，对于其它语言的应用，可以通过本文的介绍来直接通过Http接口获取配置。
另外，如果有团队/个人有兴趣的话，也欢迎帮助我们来实现其它语言的客户端，具体细节可以联系@nobodyiam和@lepdou。
注：目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端，更多信息可以参考Go、Python、NodeJS、PHP等客户端使用指南
首先需要在Apollo中接入你的应用，具体步骤可以参考应用接入文档。
该接口会从缓存中获取配置，适合频率较高的配置拉取请求，如简单的每30秒轮询一次配置。
由于缓存最多会有一秒的延时，所以如果需要配合配置推送通知实现实时更新配置的话，请参考1.3 通过不带缓存的Http接口从Apollo读取配置。
URL: {config_server_url}/configfiles/json/{appId}/{clusterName}/{namespaceName}?ip={clientIp}
Method: GET
参数说明：
| 参数名 | 是否必须 | 参数值 | 备注 |
|---|---|---|---|
| config_server_url | 是 | Apollo配置服务的地址 | |
| appId | 是 | 应用的appId | |
| clusterName | 是 | 集群名 | 一般情况下传入 default 即可。 如果希望配置按集群划分，可以参考集群独立配置说明做相关配置，然后在这里填入对应的集群名。 |
| namespaceName | 是 | Namespace的名字 | 如果没有新建过Namespace的话，传入application即可。 如果创建了Namespace，并且需要使用该Namespace的配置，则传入对应的Namespace名字。需要注意的是对于properties类型的namespace，只需要传入namespace的名字即可，如application。对于其它类型的namespace，需要传入namespace的名字加上后缀名，如datasources.json |
| ip | 否 | 应用部署的机器ip | 这个参数是可选的，用来实现灰度发布。 如果不想传这个参数，请注意URL中从?号开始的query parameters整个都不要出现。 |
该Http接口返回的是JSON格式、UTF-8编码，包含了对应namespace中所有的配置项。
返回内容Sample如下：
{
"portal.elastic.document.type":"biz",
"portal.elastic.cluster.name":"hermes-es-fws"
}通过
{config_server_url}/configfiles/{appId}/{clusterName}/{namespaceName}?ip={clientIp}可以获取到properties形式的配置
由于是Http接口，所以在URL组装OK之后，直接通过浏览器、或者相关的http接口测试工具访问即可。
该接口会直接从数据库中获取配置，可以配合配置推送通知实现实时更新配置。
URL: {config_server_url}/configs/{appId}/{clusterName}/{namespaceName}?releaseKey={releaseKey}&ip={clientIp}
Method: GET
参数说明：
| 参数名 | 是否必须 | 参数值 | 备注 |
|---|---|---|---|
| config_server_url | 是 | Apollo配置服务的地址 | |
| appId | 是 | 应用的appId | |
| clusterName | 是 | 集群名 | 一般情况下传入 default 即可。 如果希望配置按集群划分，可以参考集群独立配置说明做相关配置，然后在这里填入对应的集群名。 |
| namespaceName | 是 | Namespace的名字 | 如果没有新建过Namespace的话，传入application即可。 如果创建了Namespace，并且需要使用该Namespace的配置，则传入对应的Namespace名字。需要注意的是对于properties类型的namespace，只需要传入namespace的名字即可，如application。对于其它类型的namespace，需要传入namespace的名字加上后缀名，如datasources.json |
| releaseKey | 否 | 上一次的releaseKey | 将上一次返回对象中的releaseKey传入即可，用来给服务端比较版本，如果版本比下来没有变化，则服务端直接返回304以节省流量和运算 |
| ip | 否 | 应用部署的机器ip | 这个参数是可选的，用来实现灰度发布。 |
该Http接口返回的是JSON格式、UTF-8编码。
如果配置没有变化（传入的releaseKey和服务端的相等），则返回HttpStatus 304，response body为空。
如果配置有变化，则会返回HttpStatus 200，response body为对应namespace的meta信息以及其中所有的配置项。
返回内容Sample如下：
{
"appId": "100004458",
"cluster": "default",
"namespaceName": "application",
"configurations": {
"portal.elastic.document.type":"biz",
"portal.elastic.cluster.name":"hermes-es-fws"
},
"releaseKey": "20170430092936-dee2d58e74515ff3"
}由于是Http接口，所以在URL组装OK之后，直接通过浏览器、或者相关的http接口测试工具访问即可。
Apollo提供了基于Http long polling的配置更新推送通知，第三方客户端可以看自己实际的需求决定是否需要使用这个功能。
如果对配置更新时间不是那么敏感的话，可以通过定时刷新来感知配置更新，刷新频率可以视应用自身情况来定，建议在30秒以上。
如果需要做到实时感知配置更新（1秒）的话，可以参考下面的文档实现配置更新推送的功能。
这里建议大家可以参考Apollo的Java实现：RemoteConfigLongPollService.java，代码量200多行，总体上还是比较简单的。
首先需要确定哪些namespace需要配置更新推送，Apollo的实现方式是程序第一次获取某个namespace的配置时就会来注册一下，我们就知道有哪些namespace需要配置更新推送了。
初始化后的结果就是得到一个notifications的Map，内容是namespaceName -> notificationId（初始值为-1）。
运行过程中如果发现有新的namespace需要配置更新推送，直接塞到notifications这个Map里面即可。
有了notifications这个Map之后，就可以请求服务了。这里先描述一下请求服务的逻辑，具体的URL参数和说明请参见后面的接口说明。
- 请求远端服务，带上自己的应用信息以及notifications信息
- 服务端针对传过来的每一个namespace和对应的notificationId，检查notificationId是否是最新的
- 如果都是最新的，则保持住请求60秒，如果60秒内没有配置变化，则返回HttpStatus 304。如果60秒内有配置变化，则返回对应namespace的最新notificationId, HttpStatus 200。
- 如果传过来的notifications信息中发现有notificationId比服务端老，则直接返回对应namespace的最新notificationId, HttpStatus 200。
- 客户端拿到服务端返回后，判断返回的HttpStatus
- 如果返回的HttpStatus是304，说明配置没有变化，重新执行第1步
- 如果返回的HttpStauts是200，说明配置有变化，针对变化的namespace重新去服务端拉取配置，参见1.3 通过不带缓存的Http接口从Apollo读取配置。同时更新notifications map中的notificationId。重新执行第1步。
URL: {config_server_url}/notifications/v2?appId={appId}&cluster={clusterName}¬ifications={notifications}
Method: GET
参数说明：
| 参数名 | 是否必须 | 参数值 | 备注 |
|---|---|---|---|
| config_server_url | 是 | Apollo配置服务的地址 | |
| appId | 是 | 应用的appId | |
| clusterName | 是 | 集群名 | 一般情况下传入 default 即可。 如果希望配置按集群划分，可以参考集群独立配置说明做相关配置，然后在这里填入对应的集群名。 |
| notifications | 是 | notifications信息 | 传入本地的notifications信息，注意这里需要以array形式转为json传入，如：[{"namespaceName": "application", "notificationId": 100}, {"namespaceName": "FX.apollo", "notificationId": 200}]。需要注意的是对于properties类型的namespace，只需要传入namespace的名字即可，如application。对于其它类型的namespace，需要传入namespace的名字加上后缀名，如datasources.json |
注1：由于服务端会hold住请求60秒，所以请确保客户端访问服务端的超时时间要大于60秒。
注2：别忘了对参数进行url encode
该Http接口返回的是JSON格式、UTF-8编码，包含了有变化的namespace和最新的notificationId。
返回内容Sample如下：
[
{
"namespaceName": "application",
"notificationId": 101
}
]由于是Http接口，所以在URL组装OK之后，直接通过浏览器、或者相关的http接口测试工具访问即可。
Apollo从1.6.0版本开始增加访问密钥机制，从而只有经过身份验证的客户端才能访问敏感配置。如果应用开启了访问密钥，客户端发出请求时需要增加签名，否则无法获取配置。
需要设置的Header信息：
| Header | Value | 备注 |
|---|---|---|
| Authorization | Apollo ${appId}:${signature} | appId: 应用的appId，signature：使用访问密钥对当前时间以及所访问的URL加签后的值，具体实现可以参考Signature.signature |
| Timestamp | 从1970-1-1 00:00:00 UTC+0 到现在所经过的毫秒数 | 可以参考System.currentTimeMillis |
正常情况下，接口返回的Http状态码是200，下面列举了Apollo会返回的非200错误码说明。
客户端传入参数的错误，如必选参数没有传入等，客户端需要根据提示信息检查对应的参数是否正确。
客户端未授权，如服务端配置了访问密钥，客户端未配置或配置错误。
接口要访问的资源不存在，一般是URL或URL的参数错误，或者是对应的namespace还没有发布过配置。
接口访问的Method不正确，比如应该使用GET的接口使用了POST访问等，客户端需要检查接口访问方式是否正确。
其它类型的错误默认都会返回500，对这类错误如果应用无法根据提示信息找到原因的话，可以尝试查看服务端日志来排查问题。
-
设计文档
-
部署文档
-
开发文档
-
系统使用文档
-
FAQ
-
其它