[improve] extra project configuration common filed to constants (apac…

…he#2540) Signed-off-by: yuluo-yx <[email protected]> Co-authored-by: Calvin <[email protected]> Co-authored-by: tomsun28 <[email protected]>
Calvin979 · Aug 22, 2024 · bad28bc · bad28bc
1 parent eea68d2
commit bad28bc
Show file tree

Hide file tree

Showing 25 changed files with 341 additions and 327 deletions.
diff --git a/alerter/src/main/java/org/apache/hertzbeat/alert/AlerterProperties.java b/alerter/src/main/java/org/apache/hertzbeat/alert/AlerterProperties.java
@@ -19,16 +19,20 @@
 
 import lombok.Getter;
 import lombok.Setter;
+import org.apache.hertzbeat.common.config.BaseKafkaProperties;
+import org.apache.hertzbeat.common.constants.ConfigConstants;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
 
 /**
  * alerter prop config
  */
-@Component
-@ConfigurationProperties(prefix = "alerter")
+
 @Getter
 @Setter
+@Component
+@ConfigurationProperties(prefix =
+        ConfigConstants.FunctionModuleConstants.ALERTER)
 public class AlerterProperties {
 
     /**
@@ -92,25 +96,13 @@ public static class EntranceProperties {
          */
         @Getter
         @Setter
-        public static class KafkaProperties {
+        public static class KafkaProperties extends BaseKafkaProperties {
+
             /**
              * Whether the kafka data entry is started
              */
             private boolean enabled = true;
-
-            /**
-             * kafka's connection server url
-             */
-            private String servers = "127.0.0.1:9092";
-            /**
-             * The name of the topic that receives the data
-             */
-            private String topic;
-            /**
-             * Consumer Group ID
-             */
-            private String groupId;
-
         }
     }
+
 }
diff --git a/alerter/src/main/java/org/apache/hertzbeat/alert/config/AlerterAutoConfiguration.java b/alerter/src/main/java/org/apache/hertzbeat/alert/config/AlerterAutoConfiguration.java
@@ -17,6 +17,8 @@
 
 package org.apache.hertzbeat.alert.config;
 
+import org.apache.hertzbeat.common.constants.ConfigConstants;
+import org.apache.hertzbeat.common.constants.SignConstants;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.context.annotation.ComponentScan;
 
@@ -25,6 +27,8 @@
  */
 
 @AutoConfiguration
-@ComponentScan(basePackages = "org.apache.hertzbeat.alert")
+@ComponentScan(basePackages = ConfigConstants.PkgConstant.PKG
+		+ SignConstants.DOT
+		+ ConfigConstants.FunctionModuleConstants.ALERT)
 public class AlerterAutoConfiguration {
 }
diff --git a/...ector/src/main/java/org/apache/hertzbeat/collector/config/CollectorAutoConfiguration.java b/...ector/src/main/java/org/apache/hertzbeat/collector/config/CollectorAutoConfiguration.java
@@ -17,6 +17,8 @@
 
 package org.apache.hertzbeat.collector.config;
 
+import org.apache.hertzbeat.common.constants.ConfigConstants;
+import org.apache.hertzbeat.common.constants.SignConstants;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.context.annotation.ComponentScan;
 
@@ -26,6 +28,8 @@
  */
 
 @AutoConfiguration
-@ComponentScan(basePackages = "org.apache.hertzbeat.collector")
+@ComponentScan(basePackages = ConfigConstants.PkgConstant.PKG
+		+ SignConstants.DOT
+		+ ConfigConstants.FunctionModuleConstants.COLLECTOR)
 public class CollectorAutoConfiguration {
 }
diff --git a/collector/src/main/java/org/apache/hertzbeat/collector/dispatch/CollectorInfoProperties.java b/collector/src/main/java/org/apache/hertzbeat/collector/dispatch/CollectorInfoProperties.java
@@ -17,16 +17,19 @@
 
 package org.apache.hertzbeat.collector.dispatch;
 
+import org.apache.hertzbeat.common.constants.ConfigConstants;
+import org.apache.hertzbeat.common.constants.SignConstants;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
 
 /**
  * Collector info configuration Properties
  */
 @Component
-@ConfigurationProperties(prefix = CollectorInfoProperties.INFO_PREFIX)
+@ConfigurationProperties(prefix = ConfigConstants.FunctionModuleConstants.COLLECTOR
+        + SignConstants.DOT
+        + ConfigConstants.FunctionModuleConstants.INFO)
 public class CollectorInfoProperties {
-    protected static final String INFO_PREFIX = "collector.info";
 
     private String version;
     private String ip;

diff --git a/collector/src/main/java/org/apache/hertzbeat/collector/dispatch/DispatchProperties.java b/collector/src/main/java/org/apache/hertzbeat/collector/dispatch/DispatchProperties.java
@@ -17,21 +17,20 @@
 
 package org.apache.hertzbeat.collector.dispatch;
 
+import org.apache.hertzbeat.common.constants.ConfigConstants;
+import org.apache.hertzbeat.common.constants.SignConstants;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
 
 /**
  * Schedule Distribution Task Configuration Properties
  */
 @Component
-@ConfigurationProperties(prefix = DispatchProperties.DISPATCH_PREFIX)
+@ConfigurationProperties(prefix = ConfigConstants.FunctionModuleConstants.COLLECTOR
+        + SignConstants.DOT
+        + ConfigConstants.FunctionModuleConstants.DISPATCH)
 public class DispatchProperties {
 
-    /**
-     * Schedule Distribution Task Configuration Properties
-     */
-    protected static final String DISPATCH_PREFIX = "collector.dispatch";
-
     /**
      * Scheduling entry configuration properties
      */

diff --git a/common/src/main/java/org/apache/hertzbeat/common/config/BaseKafkaProperties.java b/common/src/main/java/org/apache/hertzbeat/common/config/BaseKafkaProperties.java
@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.hertzbeat.common.config;
+
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Kafka properties
+ */
+
+@Getter
+@Setter
+public class BaseKafkaProperties {
+
+    /**
+     * kafka's connection server url
+     */
+    private String servers = "127.0.0.1:9092";
+
+    /**
+     * The name of the topic that receives the data
+     */
+    private String topic;
+
+    /**
+     * Consumer Group ID
+     */
+    private String groupId;
+
+}
diff --git a/common/src/main/java/org/apache/hertzbeat/common/config/CommonConfig.java b/common/src/main/java/org/apache/hertzbeat/common/config/CommonConfig.java
@@ -17,6 +17,8 @@
 
 package org.apache.hertzbeat.common.config;
 
+import org.apache.hertzbeat.common.constants.ConfigConstants;
+import org.apache.hertzbeat.common.constants.SignConstants;
 import org.apache.hertzbeat.common.util.AesUtil;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -27,7 +29,9 @@
  */
 
 @AutoConfiguration
-@ComponentScan(basePackages = "org.apache.hertzbeat.common")
+@ComponentScan(basePackages = ConfigConstants.PkgConstant.PKG
+        + SignConstants.DOT
+        + ConfigConstants.FunctionModuleConstants.COMMON)
 @EnableConfigurationProperties(CommonProperties.class)
 public class CommonConfig {