CodeCheck修改

Signed-off-by: TLPC <470193496@qq.com>
sermant-io · Nov 21, 2023 · d326a9a · d326a9a
1 parent ba9c882
commit d326a9a
Show file tree

Hide file tree

Showing 71 changed files with 712 additions and 344 deletions.
diff --git a/...tcore-core/src/main/java/com/huaweicloud/sermant/core/classloader/ClassLoaderManager.java b/...tcore-core/src/main/java/com/huaweicloud/sermant/core/classloader/ClassLoaderManager.java
@@ -17,6 +17,7 @@
 package com.huaweicloud.sermant.core.classloader;
 
 import com.huaweicloud.sermant.core.common.CommonConstant;
+import com.huaweicloud.sermant.core.exception.FileCheckException;
 import com.huaweicloud.sermant.core.plugin.classloader.PluginClassFinder;
 import com.huaweicloud.sermant.core.plugin.classloader.PluginClassLoader;
 import com.huaweicloud.sermant.core.utils.FileUtils;
@@ -25,6 +26,8 @@
 import java.io.File;
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.security.AccessController;
+import java.security.PrivilegedAction;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -76,7 +79,12 @@ private static FrameworkClassLoader initFrameworkClassLoader(String path) throws
      * @return PluginClassLoader
      */
     public static PluginClassLoader createPluginClassLoader() {
-        return new PluginClassLoader(new URL[0], sermantClassLoader);
+        return AccessController.doPrivileged(new PrivilegedAction<PluginClassLoader>() {
+            @Override
+            public PluginClassLoader run() {
+                return new PluginClassLoader(new URL[0], sermantClassLoader);
+            }
+        });
     }
 
     public static SermantClassLoader getSermantClassLoader() {
@@ -99,11 +107,11 @@ public static PluginClassFinder getPluginClassFinder() {
     private static URL[] listCoreImplementUrls(String coreImplementPath) throws MalformedURLException {
         File coreImplementDir = new File(FileUtils.validatePath(coreImplementPath));
         if (!coreImplementDir.exists() || !coreImplementDir.isDirectory()) {
-            throw new RuntimeException("core implement directory is not exist or is not directory.");
+            throw new FileCheckException("core implement directory is not exist or is not directory.");
         }
         File[] jars = coreImplementDir.listFiles((file, name) -> name.endsWith(".jar"));
         if (jars == null || jars.length == 0) {
-            throw new RuntimeException("core implement directory is empty");
+            throw new FileCheckException("core implement directory is empty");
         }
         List<URL> urlList = new ArrayList<>();
         for (File jar : jars) {
@@ -115,11 +123,11 @@ private static URL[] listCoreImplementUrls(String coreImplementPath) throws Malf
     private static URL[] listCommonLibUrls(String commonLibPath) throws MalformedURLException {
         File commonLibDir = new File(FileUtils.validatePath(commonLibPath));
         if (!commonLibDir.exists() || !commonLibDir.isDirectory()) {
-            throw new RuntimeException("common lib is not exist or is not directory.");
+            throw new FileCheckException("common lib is not exist or is not directory.");
         }
         File[] jars = commonLibDir.listFiles((file, name) -> name.endsWith(".jar"));
         if (jars == null || jars.length == 0) {
-            throw new RuntimeException("common lib directory is empty");
+            throw new FileCheckException("common lib directory is empty");
         }
         List<URL> urlList = new ArrayList<>();
         for (File jar : jars) {

diff --git a/...rmant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/common/LoggerFactory.java b/...rmant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/common/LoggerFactory.java
@@ -18,6 +18,7 @@
 
 import com.huaweicloud.sermant.core.classloader.ClassLoaderManager;
 import com.huaweicloud.sermant.core.classloader.FrameworkClassLoader;
+import com.huaweicloud.sermant.core.exception.LoggerInitException;
 
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -35,9 +36,9 @@ public class LoggerFactory {
 
     private static final String LOGGER_INIT_METHOD = "init";
 
-    private static Logger defaultLogger;
+    private static volatile Logger defaultLogger;
 
-    private static Logger sermantLogger;
+    private static volatile Logger sermantLogger;
 
     private LoggerFactory() {
     }
@@ -46,19 +47,23 @@ private LoggerFactory() {
      * 初始化logback配置文件路径
      *
      * @param artifact 归属产品
-     * @throws RuntimeException RuntimeException
+     * @throws LoggerInitException LoggerInitException
      */
     public static void init(String artifact) {
         if (sermantLogger == null) {
-            FrameworkClassLoader frameworkClassLoader = ClassLoaderManager.getFrameworkClassLoader();
-            try {
-                Method initMethod = frameworkClassLoader
-                        .loadClass(LOGGER_FACTORY_IMPL_CLASS)
-                        .getMethod(LOGGER_INIT_METHOD, String.class);
-                sermantLogger = (Logger) initMethod.invoke(null, artifact);
-            } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException
-                     | InvocationTargetException e) {
-                throw new RuntimeException(e);
+            synchronized (LoggerFactory.class) {
+                if (sermantLogger == null) {
+                    FrameworkClassLoader frameworkClassLoader = ClassLoaderManager.getFrameworkClassLoader();
+                    try {
+                        Method initMethod = frameworkClassLoader
+                                .loadClass(LOGGER_FACTORY_IMPL_CLASS)
+                                .getMethod(LOGGER_INIT_METHOD, String.class);
+                        sermantLogger = (Logger) initMethod.invoke(null, artifact);
+                    } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException
+                             | InvocationTargetException e) {
+                        throw new LoggerInitException(e.getMessage());
+                    }
+                }
             }
         }
     }
@@ -75,7 +80,11 @@ public static Logger getLogger() {
 
         // 避免日志重复获取
         if (defaultLogger == null) {
-            defaultLogger = java.util.logging.Logger.getLogger("sermant");
+            synchronized (LoggerFactory.class) {
+                if (defaultLogger == null) {
+                    defaultLogger = java.util.logging.Logger.getLogger("sermant");
+                }
+            }
         }
         return defaultLogger;
     }

diff --git a/...rmant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/config/ConfigManager.java b/...rmant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/config/ConfigManager.java
@@ -205,6 +205,7 @@ private static LoadConfigStrategy<?> getLoadConfigStrategy(File configFile, Clas
      * <p>文件中声明的所有实现都将会进行遍历，每一个实现类都会通过spi获取实例，然后调用{@code configConsumer}进行消费
      *
      * @param configConsumer 配置处理方法
+     * @param classLoader 类加载器
      */
     private static void foreachConfig(ConfigConsumer configConsumer,
             ClassLoader classLoader) {

diff --git a/...entcore-core/src/main/java/com/huaweicloud/sermant/core/config/common/ConfigFieldKey.java b/...entcore-core/src/main/java/com/huaweicloud/sermant/core/config/common/ConfigFieldKey.java
@@ -16,18 +16,16 @@
 
 package com.huaweicloud.sermant.core.config.common;
 
-import com.huaweicloud.sermant.core.config.utils.ConfigKeyUtil;
-
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
  * 通用字段键注解
- * <p>用于修饰配置对象的属性，与{@link ConfigTypeKey}一并构建配置信息键
+ * <p>用于修饰配置对象的属性，与ConfigTypeKey一并构建配置信息键
  * <p>主要作用是修正成员属性和配置键之间的差异
- * <p>见{@link ConfigKeyUtil#getFieldKey(java.lang.reflect.Field)}
+ * <p>见ConfigKeyUtil#getFieldKey(java.lang.reflect.Field)
  *
  * @author HapThorin
  * @version 1.0.0
@@ -36,5 +34,10 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.FIELD})
 public @interface ConfigFieldKey {
+    /**
+     * 属性名
+     *
+     * @return 属性名
+     */
     String value();
 }
diff --git a/...gentcore-core/src/main/java/com/huaweicloud/sermant/core/config/common/ConfigTypeKey.java b/...gentcore-core/src/main/java/com/huaweicloud/sermant/core/config/common/ConfigTypeKey.java
@@ -16,8 +16,6 @@
 
 package com.huaweicloud.sermant.core.config.common;
 
-import com.huaweicloud.sermant.core.config.utils.ConfigKeyUtil;
-
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -27,7 +25,7 @@
  * 通用配置对象前缀
  * <p>如果配置对象中的所有属性对应的配置键都包含相同的前缀，那么可以使用该注解声明
  * <p>与{@link ConfigFieldKey}一同构建配置键，{@link ConfigFieldKey}不存在时，直接使用属性名
- * <p>见{@link ConfigKeyUtil#getTypeKey(Class)}
+ * <p>见ConfigKeyUtil#getTypeKey(Class)
  *
  * @author HapThorin
  * @version 1.0.0
@@ -36,5 +34,10 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
 public @interface ConfigTypeKey {
+    /**
+     * 类型名
+     *
+     * @return 类型名
+     */
     String value();
 }
diff --git a/...entcore-core/src/main/java/com/huaweicloud/sermant/core/config/utils/ConfigFieldUtil.java b/...entcore-core/src/main/java/com/huaweicloud/sermant/core/config/utils/ConfigFieldUtil.java
@@ -39,11 +39,34 @@ public class ConfigFieldUtil {
      */
     private static final Logger LOGGER = LoggerFactory.getLogger();
 
+    /**
+     * boolean类型的get或set方法中属性名的最短长度
+     */
+    private static final int FIELD_NAME_MIN_LENGTH = 3;
+
+    /**
+     * boolean类型的get或set方法中属性名的首字母下标
+     */
+    private static final int FIELD_NAME_CHECK_INDEX = 2;
+
+    /**
+     * boolean类型的get方法前缀，首字母小写字母
+     */
+    private static final String BOOLEAN_FUNCTION_PREFIX_LOWERCASE = "is";
+
+    /**
+     * boolean类型的get方法前缀，首字母大写字母
+     */
+    private static final String BOOLEAN_FUNCTION_PREFIX_UPPERCASE = "Is";
+
+    private ConfigFieldUtil() {
+    }
+
     /**
      * 设置值，优先查找{@code setter}调用，不存在时尝试直接赋值
      * <p>因此，要求配置对象的属性值需要拥有相应的{@code setter}，或者要求改属性值是公有的
      *
-     * @param obj   被设置值的对象
+     * @param obj 被设置值的对象
      * @param field 被设置的字段
      * @param value 被设置的字段值
      */
@@ -69,17 +92,16 @@ public static void setField(Object obj, Field field, Object value) {
     /**
      * 通过属性名称获取{@code setter}
      *
-     * @param cls       配置对象类
+     * @param cls 配置对象类
      * @param fieldName 属性名称
-     * @param type      属性类型
+     * @param type 属性类型
      * @return setter方法
      */
     private static Method getSetter(Class<?> cls, String fieldName, Class<?> type) {
         final String setterName;
-        if ((type == boolean.class || type == Boolean.class) &&
-                fieldName.length() >= 3 && (fieldName.startsWith("is") || fieldName.startsWith("Is")) &&
-                fieldName.charAt(2) >= 'A' && fieldName.charAt(2) <= 'Z') {
-            setterName = "set" + fieldName.substring(2);
+        if ((type == boolean.class || type == Boolean.class) && fieldName.length() >= FIELD_NAME_MIN_LENGTH
+                && checkFieldName(fieldName)) {
+            setterName = "set" + fieldName.substring(FIELD_NAME_CHECK_INDEX);
         } else {
             final char head = fieldName.charAt(0);
             setterName = "set" + (
@@ -109,6 +131,13 @@ private static void forceSet(Object obj, Field field, Object value) {
         }
     }
 
+    /**
+     * 获取属性对象
+     *
+     * @param obj 目标对象
+     * @param field 属性
+     * @return 属性对象
+     */
     public static Object getField(Object obj, Field field) {
         try {
             final Method getter = getGetter(field.getDeclaringClass(), field.getName(), field.getType());
@@ -130,10 +159,9 @@ public static Object getField(Object obj, Field field) {
 
     private static Method getGetter(Class<?> cls, String fieldName, Class<?> type) {
         final String getterName;
-        if ((type == boolean.class || type == Boolean.class) &&
-                fieldName.length() >= 3 && (fieldName.startsWith("is") || fieldName.startsWith("Is")) &&
-                fieldName.charAt(2) >= 'A' && fieldName.charAt(2) <= 'Z') {
-            getterName = "is" + fieldName.substring(2);
+        if ((type == boolean.class || type == Boolean.class) && fieldName.length() >= FIELD_NAME_MIN_LENGTH
+                && checkFieldName(fieldName)) {
+            getterName = BOOLEAN_FUNCTION_PREFIX_LOWERCASE + fieldName.substring(FIELD_NAME_CHECK_INDEX);
         } else {
             final char head = fieldName.charAt(0);
             getterName = "get" + (
@@ -168,4 +196,11 @@ private static Object forceGet(Object obj, Field field) {
     private static boolean checkMethod(Method method, Field field) {
         return method != null && Modifier.isStatic(method.getModifiers()) == Modifier.isStatic(field.getModifiers());
     }
+
+    private static boolean checkFieldName(String fieldName) {
+        return (fieldName.startsWith(BOOLEAN_FUNCTION_PREFIX_LOWERCASE) || fieldName.startsWith(
+                BOOLEAN_FUNCTION_PREFIX_UPPERCASE))
+                && fieldName.charAt(FIELD_NAME_CHECK_INDEX) >= 'A'
+                && fieldName.charAt(FIELD_NAME_CHECK_INDEX) <= 'Z';
+    }
 }
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
@@ -92,7 +92,7 @@ public class ConfigValueUtil {
             key -> key.toUpperCase(Locale.ROOT).replace('.', '-'),
             key -> key.toLowerCase(Locale.ROOT),
             key -> key.toLowerCase(Locale.ROOT).replace('.', '_'),
-            key -> key.toLowerCase(Locale.ROOT).replace('.', '-'),
+            key -> key.toLowerCase(Locale.ROOT).replace('.', '-')
     };
 
     /**
@@ -326,6 +326,7 @@ public static String fixValue(String configKey, String configVal, Map<String, Ob
      * @param key 键
      * @param defaultVal 默认值
      * @param provider 配置信息
+     * @param argsMap 参数Map
      * @return 环境变量或系统变量
      */
     private static String getFormatKeyFixVal(String key, String defaultVal, Map<String, Object> argsMap,
@@ -347,17 +348,18 @@ private static String getFormatKeyFixVal(String key, String defaultVal, Map<Stri
      *
      * @param key 键
      * @param configVal 配置值
+     * @param argsMap 参数Map
      * @return 最终配置参考值
      */
     private static String getValByFixedKey(String key, String configVal, Map<String, Object> argsMap) {
-        // 1. xxx.xxx.appName直接获取 2. xxx.xxx.app-name处理为xxx.xxx.app.name再获取
+        // appName直接获取、app-name处理为app.name再获取
         String keyReplaceMiddleLine = transFromMiddleLine(key);
         Optional<String> fixedValue = getValueByOrder(argsMap, keyReplaceMiddleLine);
         if (fixedValue.isPresent()) {
             return fixedValue.get();
         }
 
-        // 3. xxx.xxx.appName分割为xxx.xxx.app.name
+        // appName分割为app.name
         String keyWithoutCamel = transFromCamel(keyReplaceMiddleLine);
         if (!keyReplaceMiddleLine.equals(keyWithoutCamel)) {
             fixedValue = getValueByOrder(argsMap, keyWithoutCamel);

diff --git a/...src/main/java/com/huaweicloud/sermant/core/event/collector/FrameworkEventDefinitions.java b/...src/main/java/com/huaweicloud/sermant/core/event/collector/FrameworkEventDefinitions.java
@@ -88,6 +88,11 @@ public EventLevel getEventLevel() {
         return eventLevel;
     }
 
+    /**
+     * 获取范围
+     *
+     * @return framework
+     */
     public String getScope() {
         return "framework";
     }

diff --git a/...entcore-core/src/main/java/com/huaweicloud/sermant/core/exception/FileCheckException.java b/...entcore-core/src/main/java/com/huaweicloud/sermant/core/exception/FileCheckException.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2023-2023 Huawei Technologies Co., Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huaweicloud.sermant.core.exception;
+
+/**
+ * 文件检查异常
+ *
+ * @author tangle
+ * @since 2023-11-07
+ */
+public class FileCheckException extends RuntimeException {
+    private static final long serialVersionUID = 1339575470808108623L;
+
+    /**
+     * 文件检查异常
+     *
+     * @param message 异常信息
+     */
+    public FileCheckException(String message) {
+        super(message);
+    }
+}