diff --git a/apollo-client/README.md b/apollo-client/README.md new file mode 100644 index 0000000000000000000000000000000000000000..490d88bfead3025a56fbe8fbdba011cd79d9af28 --- /dev/null +++ b/apollo-client/README.md @@ -0,0 +1,40 @@ +## Maven Dependency + + com.ctrip.apollo + apollo-client + 0.0.1-SNAPSHOT + + +## Client Usage + +### 1. Load config from default namespace(application) +```java +Config config = ConfigService.getAppConfig(); +String someKey = "someKeyFromDefaultNamespace"; +String someDefaultValue = "someDefaultValueForTheKey"; +System.out.println(config.getProperty(someKey, someDefaultValue)); +``` + +### 2. Register config change listener +```java +Config config = ConfigService.getAppConfig(); +config.addChangeListener(new ConfigChangeListener() { + @Override + public void onChange(ConfigChangeEvent changeEvent) { + System.out.println("Changes for namespace " + changeEvent.getNamespace()); + for (String key : changeEvent.changedKeys()) { + ConfigChange change = changeEvent.getChange(key); + System.out.println(String.format("Change - key: %s, oldValue: %s, newValue: %s, changeType: %s", change.getPropertyName(), change.getOldValue(), change.getNewValue(), change.getChangeType())); + } + } +}); +``` + +### 3. Load config from public namespace +```java +String somePublicNamespace = "CAT"; +Config config = ConfigService.getConfig(somePublicNamespace); +String someKey = "someKeyFromPublicNamespace"; +String someDefaultValue = "someDefaultValueForTheKey"; +System.out.println(config.getProperty(someKey, someDefaultValue)); +``` \ No newline at end of file