【feature】优化yaml配置文件数据格式支持以及环境变量读取

(1)通过在属性appName上添加@ConfigFieldKey("app-name")注解，可以在yaml用中划线替换驼峰形式的键值(兼容驼峰形式)。 (2)xxx.xxx.appName将会直接以xxx.xxx.appName和解析为xxx.xxx.app.Name再通过KeyFormatter读取环境变量 (3)xxx.xxx.app-name将会被解析为xxx.xxx.app.Name再通过KeyFormatter读取环境变量
sermant-io · Aug 19, 2022 · 0fcd6b9 · 0fcd6b9
1 parent 8b8f3c8
commit 0fcd6b9
Show file tree

Hide file tree

Showing 3 changed files with 134 additions and 4 deletions.
diff --git a/...ore-core/src/main/java/com/huaweicloud/sermant/core/config/strategy/LoadYamlStrategy.java b/...ore-core/src/main/java/com/huaweicloud/sermant/core/config/strategy/LoadYamlStrategy.java
@@ -126,9 +126,15 @@ private Map fixEntry(Map typeMap, Class<?> cls) {
         Map fixedTypeMap = fixEntry(typeMap, cls.getSuperclass());
         for (Field field : cls.getDeclaredFields()) {
             final ConfigFieldKey configFieldKey = field.getAnnotation(ConfigFieldKey.class);
-            final String fieldKey = configFieldKey == null ? field.getName() : configFieldKey.value();
-            final Object subTypeVal =
-                configFieldKey == null ? fixedTypeMap.get(fieldKey) : fixedTypeMap.remove(fieldKey);
+            final String fieldKey;
+            final Object subTypeVal;
+            if (configFieldKey != null && fixedTypeMap.get(configFieldKey.value()) != null) {
+                subTypeVal = fixedTypeMap.remove(configFieldKey.value());
+                fieldKey = configFieldKey.value();
+            } else {
+                subTypeVal = fixedTypeMap.get(field.getName());
+                fieldKey = field.getName();
+            }
             if (subTypeVal == null) {
                 continue;
             }

diff --git a/...entcore-core/src/main/java/com/huaweicloud/sermant/core/config/utils/ConfigValueUtil.java b/...entcore-core/src/main/java/com/huaweicloud/sermant/core/config/utils/ConfigValueUtil.java
@@ -33,6 +33,8 @@
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /**
  * 对配置中参数值进行处理的工具
@@ -62,6 +64,11 @@ public class ConfigValueUtil {
      */
     private static final int MAP_KV_LEN = 2;
 
+    /**
+     * 驼峰匹配pattern
+     */
+    private static final Pattern PATTERN = Pattern.compile("[A-Z]");
+
     /**
      * 配置键格式化器, 针对不同环境变量格式读取
      * <p>若读取环境变量 service.meta.applicationName, 则会尝试从下面的变量进行读取， 否则取默认值</p>
@@ -87,6 +94,20 @@ public class ConfigValueUtil {
         key -> key.toLowerCase(Locale.ROOT).replace('.', '-'),
     };
 
+    /**
+     * 配置参考值获取表达式
+     * <p>优先级: 启动配置 > 环境变量 > 启动参数 > 配置文件</p>
+     */
+    private static final List<ValueReferFunction<String, Map<String, Object>, String>>
+            VALUE_REFER_FUNCTION = Arrays.asList(
+                (key, argsMap) -> {
+                final Object config = argsMap.get(key);
+                return config == null ? null : config.toString();
+                },
+                (key, argsMap) -> System.getenv(key),
+                (key, argsMap) -> System.getProperty(key)
+    );
+
     /**
      * 值获取表达式
      * <p>优先级: 启动配置 > 环境变量 > 启动参数 > 配置文件</p>
@@ -296,7 +317,7 @@ public static String fixValue(String configKey, String configVal, Map<String, Ob
                     configVal.substring(0, startIndex - ENV_PREFIX_LEN) + value + configVal.substring(endIndex + 1),
                     argsMap, provider);
         } else {
-            final String valFromEnv = getFormatKeyFixVal(configKey, configVal, argsMap, provider);
+            final String valFromEnv = getValByFixedKey(configKey, configVal, argsMap);
             if (valFromEnv != null) {
                 return valFromEnv;
             }
@@ -326,6 +347,86 @@ private static String getFormatKeyFixVal(String key, String defaultVal, Map<Stri
         return defaultVal;
     }
 
+    /**
+     * 获取配置键的参考值，优先级：入参 > 环境变量 > 系统变量 > 配置
+     * <p>修正不同配置格式获取值, 含'-','_','.',大写以及小写</p>
+     *
+     * @param key       键
+     * @param configVal 配置值
+     * @return 最终配置参考值
+     */
+    private static String getValByFixedKey(String key, String configVal, Map<String, Object> argsMap) {
+        String fixedValue;
+
+        // 1. xxx.xxx.appName直接获取 2. xxx.xxx.app-name处理为xxx.xxx.app.name再获取
+        String keyReplaceMiddleLine = transFromMiddleLine(key);
+        fixedValue = getValueByOrder(argsMap, keyReplaceMiddleLine);
+        if (fixedValue != null) {
+            return fixedValue;
+        }
+
+        // 3. xxx.xxx.appName分割为xxx.xxx.app.name
+        String keyWithoutCamel = transFromCamel(keyReplaceMiddleLine);
+        if (!keyReplaceMiddleLine.equals(keyWithoutCamel)) {
+            fixedValue = getValueByOrder(argsMap, keyWithoutCamel);
+            if (fixedValue != null) {
+                return fixedValue;
+            }
+        }
+        return configVal;
+    }
+
+    /**
+     * 由KeyFormatter处理后读取环境变量
+     * 优先级：入参 > 环境变量 > 系统变量 > 配置
+     *
+     * @param key     键
+     * @param argsMap 入参
+     * @return 最终配置参考值
+     */
+    private static String getValueByOrder(Map<String, Object> argsMap, String key) {
+        String fixedValue;
+        for (ValueReferFunction<String, Map<String, Object>, String> function : VALUE_REFER_FUNCTION) {
+            for (KeyFormatter keyFormatter : KEY_FORMATTERS) {
+                fixedValue = function.apply(keyFormatter.format(key), argsMap);
+                if (!StringUtils.isBlank(fixedValue)) {
+                    return fixedValue;
+                }
+            }
+        }
+        return null;
+    }
+
+    /**
+     * 配置键分割驼峰单词
+     * <p>若需读取环境变量，service.meta.applicationName先处理为service.meta.application.name再
+     * 由KeyFormatter处理后读取环境变量</p>
+     *
+     * @param key 需处理的键
+     * @return 处理后的键
+     */
+    private static String transFromCamel(String key) {
+        Matcher matcher = PATTERN.matcher(key);
+        StringBuffer sb = new StringBuffer();
+        while (matcher.find()) {
+            matcher.appendReplacement(sb, "." + matcher.group(0).toLowerCase(Locale.ROOT));
+        }
+        matcher.appendTail(sb);
+        return sb.toString();
+    }
+
+    /**
+     * 配置键中划线格式化
+     * <p>若需读取环境变量 service.meta.application-name, 则先处理为service.meta.application.name再
+     * 由KeyFormatter处理后读取环境变量</p>
+     *
+     * @param key 需处理的键
+     * @return 处理后的键
+     */
+    private static String transFromMiddleLine(String key) {
+        return key.replace("-", ".");
+    }
+
     /**
      * 通过环境变量或者系统变量获取 环境变量 > 系统变量
      *
@@ -361,6 +462,25 @@ interface ValueFixFunction<K, B, P, R> {
         R apply(K key, B bootstrapArgsMap, P sourceProvider);
     }
 
+    /**
+     * 配置值参考, 该类仅用于配置值参考
+     *
+     * @param <K> 键
+     * @param <B> 源数据
+     * @param <R> 结果
+     * @since 2022-08-18
+     */
+    interface ValueReferFunction<K, B, R> {
+        /**
+         * 应用修正
+         *
+         * @param key              键
+         * @param bootstrapArgsMap 启动参数Map
+         * @return 最终参考值
+         */
+        R apply(K key, B bootstrapArgsMap);
+    }
+
     /**
      * 配置键格式化器
      *

diff --git a/sermant-example/demo-plugin/src/main/java/com/huawei/example/demo/config/DemoConfig.java b/sermant-example/demo-plugin/src/main/java/com/huawei/example/demo/config/DemoConfig.java
@@ -36,7 +36,11 @@ public class DemoConfig implements PluginConfig { // 有设置拦截器别名需
 
     /**
      * 基础类型配置(除byte和char)
+     *
+     * <p>添加@ConfigFieldKey("int-field")后，config.yaml中配置demo.test.intField或demo.test.int-field皆可</p>
+     * <p>如果不添加注解，config.yaml中只能配置为demo.test.intField</p>
      */
+    @ConfigFieldKey("int-field")
     private int intField;
 
     /**