java客户端线上Apollo服务端的实现

Java客户端可以通过Apollo的Java客户端SDK来访问Apollo服务端配置。下面是使用Java客户端线上Apollo服务端的实现攻略。

步骤一：引入Java客户端SDK

在Java项目的pom.xml文件内引入如下依赖。

<dependency>
    <groupId>com.ctrip.framework.apollo</groupId>
    <artifactId>apollo-client</artifactId>
    <version>1.9.0</version>
</dependency>

步骤二：配置Apollo客户端

在Java代码中初始化Apollo客户端。

public class ApolloClientApplication {

    public static void main(String[] args) {
        ApolloClient apolloClient = ApolloClient.builder()
                .withAppId("yourAppId")
                .withEnv("yourEnv")
                .withCluster("yourCluster")
                .withCacheDir(new File("/tmp"))
                .withMetaServerDomain("http://config-service-url")
                .build();

        Config config = apolloClient.getConfig();
    }
}

• withAppId：指定Apollo服务端中的应用ID。
• withEnv：指定环境，默认为dev。
• withCluster：指定集群，默认为default。
• withCacheDir：缓存目录，默认为/tmp/apolloConfigCache。
• withMetaServerDomain：元数据API的域名。

步骤三：读取配置

使用下面代码可以读取Apollo服务端的配置。

public class ApolloClientApplication {

    public static void main(String[] args) {
        ApolloClient apolloClient = ApolloClient.builder()
                .withAppId("yourAppId")
                .withEnv("yourEnv")
                .withCluster("yourCluster")
                .withCacheDir(new File("/tmp"))
                .withMetaServerDomain("http://config-service-url")
                .build();

        Config config = apolloClient.getConfig();

        String someKey = "yourKey";
        String someDefaultValue = "someDefaultValue";
        String value = config.getProperty(someKey, someDefaultValue);

        System.out.println("Value : " + value);
    }
}

假设你的配置文件中有下面这一属性：

yourKey=yourValue

上面的代码将输出：

Value : yourValue

示例一：使用注解实时刷新配置

Apollo客户端提供了一个@ApolloConfigChangeListener注解，可以使用该注解来监听Apollo服务端配置变化并及时更新本地配置。下面是一个使用该注解实时刷新配置的示例。

@Component
public class ConfigChangePrinter {

    @ApolloConfigChangeListener
    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()));
        }
    }
}

当Apollo服务端的配置发生变化后，上面的代码将输出该变化的详细信息。

示例二：使用Spring Cloud Config作为Apollo客户端

Spring Cloud Config可以作为Apollo客户端访问Apollo服务端。下面是一个使用Spring Cloud Config访问Apollo服务端的示例。

spring:
  profiles:
    active: apollo

apollo:
  meta:
    http://localhost:8080
  appId: yourAppId
  env: yourEnv
  cluster: yourCluster

在上面的配置中，spring.profiles.active设置为apollo，表示使用Apollo作为配置中心。同时，Apollo的环境、应用ID和集群也在配置文件中指定了。

在使用Spring Cloud Config的代码中，只需使用@Value注解读取配置即可。

@RestController
public class HelloController {

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

    @GetMapping("/hello")
    public String hello() {
        return "Hello " + yourKey;
    }
}

当Apollo服务端的配置发生变化时，Spring Cloud Config将自动刷新本地配置。