GitHub - CharLemAznable/char-configservice: Config Service clients.

char-configservice

配置服务客户端, 定义接口读取apollo/diamond配置.

Maven Dependency

<dependency>
  <groupId>com.github.charlemaznable</groupId>
  <artifactId>char-configservice</artifactId>
  <version>2024.0.0</version>
</dependency>

Maven Dependency SNAPSHOT

<dependency>
  <groupId>com.github.charlemaznable</groupId>
  <artifactId>char-configservice</artifactId>
  <version>2024.0.1-SNAPSHOT</version>
</dependency>

1. 快速开始

1.1. 读取apollo配置

1.1.1. 简单配置

# namespace:XXX propertyName:YYY
ZZZ

@ApolloConfig(namespace = "XXX")
public interface MyConfig {
    @ApolloConfig("YYY")
    String value();
}

MyConfig myConfig = ApolloFactory.getApollo(MyConfig.class);
String value = myConfig.value(); // value: "ZZZ"

1.1.2. Properties配置

# namespace:XXX propertyName:YYY
key1=value1
key2=value2

@ApolloConfig(namespace = "XXX")
public interface MyConfig {
    @ApolloConfig("YYY")
    Properties value();
}

MyConfig myConfig = ApolloFactory.getApollo(MyConfig.class);
Properties value = myConfig.value();
String value1 = value.getProperty("key1"); // value1: "value1"
String value2 = value.getProperty("key2"); // value2: "value2"

1.1.3. Properties配置按键读取

# namespace:XXX propertyName:YYY
key1=value1
key2=value2

@ApolloConfig(namespace = "XXX", propertyName = "YYY")
public interface MyConfig {
    @ApolloConfig("key1")
    String key1();
    @ApolloConfig("key2")
    String key2();
}

MyConfig myConfig = ApolloFactory.getApollo(MyConfig.class);
String value1 = myConfig.key1(); // value1: "value1"
String value2 = myConfig.key2(); // value2: "value2"

1.2. 读取diamond配置

与apollo配置类似, diamond配置的group:dataId对应apollo配置的namespace:propertyName.

将java代码中的@ApolloConfig替换为@DiamondConfig, 将ApolloFactory.getApollo()替换为DiamondFactory.getDiamond()即可.

1.3. 读取etcd配置

与apollo配置类似, etcd配置的namespace:key对应apollo配置的namespace:propertyName.

将java代码中的@ApolloConfig替换为@EtcdConfig, 将ApolloFactory.getApollo()替换为EtcdFactory.getEtcd()即可.

2. 配置坐标的指定

编写配置客户端接口时, 需要使用@ApolloConfig/@DiamondConfig/@EtcdConfig注解, 在接口上标识其为配置客户端接口, 在接口或方法上指定配置读取的坐标.

当注解在接口上时, namespace/group/namespace的默认值为"application"/"DEFAULT_GROUP"/"application", propertyName/dataId/key/value的默认值为"".
当注解在方法上时, 上述注解属性的默认值都是"".

2.1. 默认坐标

@ApolloConfig
@DiamondConfig
@EtcdConfig
public interface MyConfig {
    @ApolloConfig // 可省略
    @DiamondConfig // 可省略
    @EtcdConfig // 可省略
    String value();
}

读取配置:

# apollo
namespace: application
propertyName: value

# diamond
group: DEFAULT_GROUP
dataId: value

# etcd
namespace: application
key: value

String value();方法返回配置完整内容字符串

2.2. 仅指定接口的namespace/group

@ApolloConfig(namespace = "XXX")
@DiamondConfig(group = "XXX")
@EtcdConfig(namespace = "XXX")
public interface MyConfig {
    @ApolloConfig // 可省略
    @DiamondConfig // 可省略
    @EtcdConfig // 可省略
    String value();
}

读取配置:

# apollo
namespace: XXX
propertyName: value

# diamond
group: XXX
dataId: value

# etcd
namespace: XXX
key: value

String value();方法返回配置完整内容字符串

2.3. 仅指定接口的propertyName/dataId/key

@ApolloConfig(propertyName = "YYY")
@DiamondConfig(dataId = "YYY")
@EtcdConfig(key = "YYY")
public interface MyConfig {
    @ApolloConfig // 可省略
    @DiamondConfig // 可省略
    @EtcdConfig // 可省略
    String value();
}

读取配置:

# apollo
namespace: application
propertyName: YYY

# diamond
group: DEFAULT_GROUP
dataId: YYY

# etcd
namespace: application
key: YYY

String value();方法返回配置内容按Properties解析后的键value的配置值

2.4. 仅指定方法的namespace/group

@ApolloConfig
@DiamondConfig
@EtcdConfig
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ")
    @DiamondConfig(group = "ZZZ")
    @EtcdConfig(namespace = "ZZZ")
    String value();
}

读取配置:

# apollo
namespace: ZZZ
propertyName: value

# diamond
group: ZZZ
dataId: value

# etcd
namespace: ZZZ
key: value

String value();方法返回配置完整内容字符串

2.5. 仅指定方法的propertyName/dataId/key

@ApolloConfig
@DiamondConfig
@EtcdConfig
public interface MyConfig {
    @ApolloConfig(propertyName = "abc")
    @DiamondConfig(dataId = "abc")
    @EtcdConfig(key = "abc")
    String value();
}

读取配置:

# apollo
namespace: application
propertyName: abc

# diamond
group: DEFAULT_GROUP
dataId: abc

# etcd
namespace: application
key: abc

String value();方法返回配置完整内容字符串

2.6. 指定接口的namespace/group和propertyName/dataId/key

@ApolloConfig(namespace = "XXX", propertyName = "YYY")
@DiamondConfig(group = "XXX", dataId = "YYY")
@EtcdConfig(namespace = "XXX", key = "YYY")
public interface MyConfig {
    @ApolloConfig // 可省略
    @DiamondConfig // 可省略
    @EtcdConfig // 可省略
    String value();
}

读取配置:

# apollo
namespace: XXX
propertyName: YYY

# diamond
group: XXX
dataId: YYY

# etcd
namespace: XXX
key: YYY

String value();方法返回配置内容按Properties解析后的键value的配置值

2.7. 指定方法的namespace/group和propertyName/dataId/key

@ApolloConfig
@DiamondConfig
@EtcdConfig
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ", propertyName = "abc")
    @DiamondConfig(group = "ZZZ", dataId = "abc")
    @EtcdConfig(namespace = "ZZZ", key = "abc")
    String value();
}

读取配置:

# apollo
namespace: ZZZ
propertyName: abc

# diamond
group: ZZZ
dataId: abc

# etcd
namespace: ZZZ
key: abc

String value();方法返回配置完整内容字符串

2.8. 指定接口和方法的namespace/group

@ApolloConfig(namespace = "XXX")
@DiamondConfig(group = "XXX")
@EtcdConfig(namespace = "XXX")
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ")
    @DiamondConfig(group = "ZZZ")
    @EtcdConfig(namespace = "ZZZ")
    String value();
}

读取配置:

# apollo
namespace: ZZZ
propertyName: value

# diamond
group: ZZZ
dataId: value

# etcd
namespace: ZZZ
key: value

String value();方法返回配置完整内容字符串

2.9. 指定接口和方法的propertyName/dataId/key

@ApolloConfig(propertyName = "YYY")
@DiamondConfig(dataId = "YYY")
@EtcdConfig(key = "YYY")
public interface MyConfig {
    @ApolloConfig(propertyName = "abc")
    @DiamondConfig(dataId = "abc")
    @EtcdConfig(key = "abc")
    String value();
}

读取配置:

# apollo
namespace: application
propertyName: YYY

# diamond
group: DEFAULT_GROUP
dataId: YYY

# etcd
namespace: application
key: YYY

String value();方法返回配置内容按Properties解析后的键abc的配置值

2.10. 指定接口的namespace/group, 并指定方法的propertyName/dataId/key

@ApolloConfig(namespace = "XXX")
@DiamondConfig(group = "XXX")
@EtcdConfig(namespace = "XXX")
public interface MyConfig {
    @ApolloConfig(propertyName = "abc")
    @DiamondConfig(dataId = "abc")
    @EtcdConfig(key = "abc")
    String value();
}

读取配置:

# apollo
namespace: XXX
propertyName: abc

# diamond
group: XXX
dataId: abc

# etcd
namespace: XXX
key: abc

String value();方法返回配置完整内容字符串

2.11. 指定接口的propertyName/dataId/key, 指定方法的namespace/group

@ApolloConfig(propertyName = "YYY")
@DiamondConfig(dataId = "YYY")
@EtcdConfig(key = "YYY")
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ")
    @DiamondConfig(group = "ZZZ")
    @EtcdConfig(namespace = "ZZZ")
    String value();
}

读取配置:

# apollo
namespace: application
propertyName: YYY

# diamond
group: DEFAULT_GROUP
dataId: YYY

# etcd
namespace: application
key: YYY

String value();方法返回配置内容按Properties解析后的键ZZZ.value的配置值

2.12. 不指定接口的namespace/group

@ApolloConfig(propertyName = "YYY")
@DiamondConfig(dataId = "YYY")
@EtcdConfig(key = "YYY")
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ", propertyName = "abc")
    @DiamondConfig(group = "ZZZ", dataId = "abc")
    @EtcdConfig(namespace = "ZZZ", key = "abc")
    String value();
}

读取配置:

# apollo
namespace: application
propertyName: YYY

# diamond
group: DEFAULT_GROUP
dataId: YYY

# etcd
namespace: application
key: YYY

String value();方法返回配置内容按Properties解析后的键ZZZ.abc的配置值

2.13. 不指定接口的propertyName/dataId/key

@ApolloConfig(namespace = "XXX")
@DiamondConfig(group = "XXX")
@EtcdConfig(namespace = "XXX")
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ", propertyName = "abc")
    @DiamondConfig(group = "ZZZ", dataId = "abc")
    @EtcdConfig(namespace = "ZZZ", key = "abc")
    String value();
}

读取配置:

# apollo
namespace: ZZZ
propertyName: abc

# diamond
group: ZZZ
dataId: abc

# etcd
namespace: ZZZ
key: abc

String value();方法返回配置完整内容字符串

2.14. 不指定方法的namespace/group

@ApolloConfig(namespace = "XXX", propertyName = "YYY")
@DiamondConfig(group = "XXX", dataId = "YYY")
@EtcdConfig(namespace = "XXX", key = "YYY")
public interface MyConfig {
    @ApolloConfig(propertyName = "abc")
    @DiamondConfig(dataId = "abc")
    @EtcdConfig(key = "abc")
    String value();
}

读取配置:

# apollo
namespace: XXX
propertyName: YYY

# diamond
group: XXX
dataId: YYY

# etcd
namespace: XXX
key: YYY

String value();方法返回配置内容按Properties解析后的键abc的配置值

2.15. 不指定方法的propertyName/dataId/key

@ApolloConfig(namespace = "XXX", propertyName = "YYY")
@DiamondConfig(group = "XXX", dataId = "YYY")
@EtcdConfig(namespace = "XXX", key = "YYY")
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ")
    @DiamondConfig(group = "ZZZ")
    @EtcdConfig(namespace = "ZZZ")
    String value();
}

读取配置:

# apollo
namespace: XXX
propertyName: YYY

# diamond
group: XXX
dataId: YYY

# etcd
namespace: XXX
key: YYY

String value();方法返回配置内容按Properties解析后的键ZZZ.value的配置值

2.16. 全部指定坐标

@ApolloConfig(namespace = "XXX", propertyName = "YYY")
@DiamondConfig(group = "XXX", dataId = "YYY")
@EtcdConfig(namespace = "XXX", key = "YYY")
public interface MyConfig {
    @ApolloConfig(namespace = "ZZZ", propertyName = "abc")
    @DiamondConfig(group = "ZZZ", dataId = "abc")
    @EtcdConfig(namespace = "ZZZ", key = "abc")
    String value();
}

读取配置:

# apollo
namespace: XXX
propertyName: YYY

# diamond
group: XXX
dataId: YYY

# etcd
namespace: XXX
key: YYY

String value();方法返回配置内容按Properties解析后的键ZZZ.abc的配置值

3. 指定坐标时使用环境变量

指定坐标值时, 可使用${key}标识环境变量.

环境变量源为类路径中的configservice.env.props配置文件和Arguments启动参数.

其中Arguments变量的优先级高于配置文件.

4. 类型转换

默认根据方法返回类型解析读取到的配置值, 并做类型转换.

基本类型和字符串会直接转换并返回
Map及其子类型, 将返回Properties类型对象
非集合类型的泛型类型, 将使用DiamondUtils.parseObject()方法进行解析
集合类型将使用DiamondUtils.parseObjects()方法进行解析
可在方法上添加@ConfigValueParse注解, 进行自定义解析

5. 配置默认值

当未读取到指定坐标的配置值时, 可使用配置默认值返回缺省配置值.

可使用注解中的defaultValue属性, 或方法调用的第一个入参配置默认值.

方法入参的优先级高于defaultValue属性.

defaultValue属性配置的默认值也可使用使用环境变量, 也会进行类型转换.

可在方法上添加@DefaultEmptyValue注解, 配置默认值为""而非null.

6. 配置读取并缓存

可使用注解中的cacheSeconds属性, 指定配置读取到内存后的缓存时长(单位: 秒).

7. 通用配置读取

配置客户端接口继承ConfigGetter接口, 即可使用通用方法按键读取配置值.

8. 支持TOML格式

当配置内容以# toml开头时, 将按TOML格式读取配置为Properties对象.

9. 兼容使用apollo/diamond/etcd

配置客户端接口同时添加@ApolloConfig, @DiamondConfig和@EtcdConfig注解, 或添加@Config注解.

使用ConfigFactory.getConfig()方法获取客户端实例.

当类路径中仅包含apollo-client或diamond-client或etcdconf-client时, 将自动选取对应的配置实现.

当类路径中同时包含apollo-client/diamond-client/etcdconf-client时, 根据环境变量中设置的ConfigService值选取对应的配置实现.

# configservice.env.props
ConfigService=apollo

# Arguments
--ConfigService=apollo

10. 在Spring中使用

使用@ApolloScan/@DiamondScan/@EtcdScan/@ConfigScan指定扫描加载包路径.

包路径中所有添加@ApolloConfig/@DiamondConfig/@EtcdConfig/@Config注解的接口都将生成对应的配置客户端实例并注入SpringContext.

11. 在Guice中使用

使用ApolloModular/DiamondModular/EtcdModular/ConfigModular按类或包路径扫描加载.

创建的Module中将包含对应的配置客户端实例.

Name		Name	Last commit message	Last commit date
Latest commit History 82 Commits
.github/workflows		.github/workflows
src		src
.gitignore		.gitignore
.gitpod.Dockerfile		.gitpod.Dockerfile
.gitpod.yml		.gitpod.yml
LICENSE		LICENSE
README.md		README.md
lombok.config		lombok.config
pom.xml		pom.xml

License

CharLemAznable/char-configservice

Folders and files

Latest commit

History

Repository files navigation

char-configservice

Maven Dependency

Maven Dependency SNAPSHOT

1. 快速开始

1.1. 读取apollo配置

1.2. 读取diamond配置

1.3. 读取etcd配置

2. 配置坐标的指定

2.1. 默认坐标

2.2. 仅指定接口的namespace/group

2.3. 仅指定接口的propertyName/dataId/key

2.4. 仅指定方法的namespace/group

2.5. 仅指定方法的propertyName/dataId/key

2.6. 指定接口的namespace/group和propertyName/dataId/key

2.7. 指定方法的namespace/group和propertyName/dataId/key

2.8. 指定接口和方法的namespace/group

2.9. 指定接口和方法的propertyName/dataId/key

2.10. 指定接口的namespace/group, 并指定方法的propertyName/dataId/key

2.11. 指定接口的propertyName/dataId/key, 指定方法的namespace/group

2.12. 不指定接口的namespace/group

2.13. 不指定接口的propertyName/dataId/key

2.14. 不指定方法的namespace/group

2.15. 不指定方法的propertyName/dataId/key

2.16. 全部指定坐标

3. 指定坐标时使用环境变量

4. 类型转换

5. 配置默认值

6. 配置读取并缓存

7. 通用配置读取

8. 支持TOML格式

9. 兼容使用apollo/diamond/etcd

10. 在Spring中使用

11. 在Guice中使用

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages