Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
wrr-cat
apollo
提交
f0224e9c
apollo
项目概览
wrr-cat
/
apollo
与 Fork 源项目一致
从无法访问的项目Fork
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
apollo
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
f0224e9c
编写于
6月 02, 2016
作者:
J
Jason Song
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update apollo client readme
上级
8b78bf03
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
76 addition
and
2 deletion
+76
-2
apollo-client/README.md
apollo-client/README.md
+76
-2
apollo-client/doc/pic/app-id-location.png
apollo-client/doc/pic/app-id-location.png
+0
-0
未找到文件。
apollo-client/README.md
浏览文件 @
f0224e9c
## Maven Dependency
## I. Prerequisite
### I.I Mandatory Setup
Apollo client requires
`AppId`
and
`Environment`
information available to function properly, so please read the following and configure them properly:
#### 1. AppId
AppId is the identity for the application, which is a key information to retrieve the config from server.
AppId information should be put in
`classpath:/META-INF/app.properties`
with its key as
`app.id`
.
For example, you could place the file as the following screenshot:
![
app.properties example
](
doc/pic/app-id-location.png
)
And config the file as:
> app.id=YOUR-APP-ID
#### 2. Environment
Apollo supports config by multiple environments, so environment is another key information to retrieve the config from server.
Environment could be configured in 3 ways:
1.
As Java System Property
*
You could specify environment as java system property
`env`
*
For example, when starting the java application, it can be configured via
`-Denv=YOUR-ENVIRONMENT`
*
Please note the key should be lower case
2.
As OS System Environment
*
You could also specify environment as system environment
`ENV`
*
Please note the key should be UPPER CASE
3.
As Property File
*
You could create a file
`/opt/settings/server.properties`
on the target machine
*
And specify the environment in the file as
`env=YOUR-ENVIRONMENT`
*
Please note the key should be lower case
### I.II Optional Setup
#### Cluster
Apollo supports config separated by clusters, which means for one appId and one environment, you could have different configs.
If you need this functionality, you could specify the cluster as follows:
1.
As Java System Property
*
You could specify environment as java system property
`apollo.cluster`
*
For example, when starting the java application, it can be configured via
`-Dapollo.cluster=xxx`
*
Please note the key should be lower case
2.
As Property file
*
You could create a file
`/opt/settings/server.properties`
on the target machine
*
And specify the environment in the file as
`idc=xxx`
*
Please note the key should be lower case
##### Cluster Precedence
1.
If both
`apollo.cluster`
and
`idc`
are specified:
*
We will first try to load config from cluster specified as
`apollo.cluster`
*
If not found, we will fall back to cluster specified as
`idc`
*
If still not found, we will fall back to the default cluster
`default`
2.
If only
`apollo.cluster`
is specified:
*
We will first try to load config from cluster specified as
`apollo.cluster`
*
If not found, we will fall back to the default cluster
`default`
3.
If only
`idc`
is specified:
*
We will first try to load config from cluster specified as
`idc`
*
If not found, we will fall back to the default cluster
`default`
4.
If neither
`apollo.cluster`
nor
`idc`
is specified:
*
We will load config from the default cluster
`default`
## II. Maven Dependency
<dependency>
<groupId>
com.ctrip.framework.apollo
</groupId>
<artifactId>
apollo-client
</artifactId>
<version>
0.0.1
</version>
</dependency>
##
Client Usage
##
III.
Client Usage
### 1. Load config from default namespace(application)
```
java
...
...
apollo-client/doc/pic/app-id-location.png
0 → 100644
浏览文件 @
f0224e9c
12.4 KB
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录