攜程配置中心Apollo的Java客戶端API的使用

1、SpringBoot集成

1.發佈配置信息

• 設置本機爲DEV環境：Linux在/opt/settings/server.properties增長配置env=DEV，windows在c:\opt\settings\server.properties

<div align=center>

圖1

<div align=left>

• 在apollo portal上新建項目後，默認就有了application命名空間。在DEV環境下新建一個名爲test_namespace的命名空間。
• 在application上發佈：spring.applicaton.name=apollo_demo，server.port=9000。
• 在test_name上發佈：name=name1, value=value2。

2.引入依賴

<dependency>
       <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-stater</artifactId>
</dependency>

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
        <scope>provided</scope>
</dependency>

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

3.項目配置

1. 在項目的application.properties(applicaiton.yml)或者/META-INF/app.properties填入app.id=appId(在apollo-portal上新建項目時填寫的appId，表示獲取的是那個配置項目的配置信息)。
2. resources目錄下新建apollo-env.properties，填寫各個環境的meta server地址：

<div align=center>

圖2

<div align=left> 3) 或者不在項目配置apollo-env.properties，而是直接在application.properties指定apollo.meta=ip:port的方式來執行須要讀取配置的的服務

4. 使用application命名空間的配置信息來啓動SpringBoot應用 入口方法增長@EnableApolloConfig註解

@SpringBootApplication
@EnableApolloConfig
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

若是不使用@EnableApolloConfig註解，能夠在application.properties裏面配置apollo.bootstrap.enabled=true，效果同樣。 使用apollo.bootstrap.namespaces = application,test_namespace能夠指定命名空間。

啓動項目：

<div align=center>

圖3

<div align=left> 能夠看到應用在啓動前從配置中心獲取配置信息來啓動應用。 `@EnableApolloConfig`默認是從application命名空間獲取配置的，至關於`@EnableApolloConfig("application")`.。

4.獲取配置

application命名空間配置信息 java bean:

@Component
@EnableApolloConfig
@Getter
@Setter
@ToString
public class AppNamespace {

    @Value("${spring.application.name:}")
    private String name;

    @Value("${server.port:}")
    private String value;
}

java bean:

@Component
@EnableApolloConfig("CASE.test_namespace")
@Getter
@Setter
@ToString
public class TestNamespace {

    @Value("${name}")
    private String name;

    @Value("${value}")
    private String value;
}

使用:

@RestController
public class DemoController {

    @Autowired
    private TestNamespace demo;

    @Autowired
    private AppNamespace application;

    @ApolloConfig
    private Config appConfig;

    @ApolloConfig("CASE.test_namespace")
    private Config testConfig1;

    private Config testConfig2 = ConfigService.getConfig("CASE.test_namespace");
}

以上兩種方式獲取配置信息的值，會跟配置中心的更改同步(1秒內)；還能夠使用@ConfigurationProperties來獲取配置信息，但這種方式不會同步更新，須要額外的編碼配置才能實現，具體查看官方文檔。

5.其餘

@ApolloJsonValue註解，做用至關於@Value，將JSON字符串轉成對象。

@ApolloConfigChangeListener註解:：

@ApolloConfigChangeListener
private void someOnChange(ConfigChangeEvent changeEvent) {
        //update injected value of batch if it is changed in Apollo
        if (changeEvent.isChanged("key")) {
                System.out.println(config.getIntProperty("key", ""));
        }
}

@ApolloConfigChangeListener至關於@ApolloConfigChangeListener("application")

至關於：

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("Found change - key: %s, oldValue: %s, newValue: %s, changeType: %s", change.getPropertyName(), change.getOldValue(), change.getNewValue(), change.getChangeType()));
        }
    }
});

若是同時以兩種方式綁定changeListener的方式，只有ConfigService實例的監聽器會生效。

2.其餘

Quick start鏈接