Feat: Agent mode adapte SpringBoot 1.x 2.x 3.x And adapte Nacos、Apoll…

…o Config-Center
opengoofy · Oct 16, 2024 · 044aae9 · 044aae9
1 parent 95336d7
commit 044aae9
Show file tree

Hide file tree

Showing 43 changed files with 1,137 additions and 70 deletions.
diff --git a/agent/hippo4j-agent-bootstrap/pom.xml b/agent/hippo4j-agent-bootstrap/pom.xml
@@ -33,6 +33,7 @@
         <plugins>
             <plugin>
                 <artifactId>maven-shade-plugin</artifactId>
+                <version>3.4.1</version>
                 <executions>
                     <execution>
                         <phase>package</phase>

diff --git a/agent/hippo4j-agent-core/pom.xml b/agent/hippo4j-agent-core/pom.xml
@@ -78,16 +78,6 @@
             <artifactId>hippo4j-threadpool-infra-common</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>cn.hippo4j</groupId>
-            <artifactId>hippo4j-threadpool-dynamic-mode-config</artifactId>
-            <version>${project.version}</version>
-        </dependency>
-        <dependency>
-            <groupId>cn.hippo4j</groupId>
-            <artifactId>hippo4j-threadpool-kernel-monitor</artifactId>
-            <version>${project.version}</version>
-        </dependency>
     </dependencies>
 
     <build>
@@ -107,6 +97,7 @@
             </plugin>
             <plugin>
                 <artifactId>maven-shade-plugin</artifactId>
+                <version>3.4.1</version>
                 <executions>
                     <execution>
                         <phase>package</phase>

diff --git a/...in/src/main/java/cn/hippo4j/agent/plugin/apollo/ApolloDynamicThreadPoolChangeHandler.java b/...in/src/main/java/cn/hippo4j/agent/plugin/apollo/ApolloDynamicThreadPoolChangeHandler.java
@@ -29,7 +29,6 @@
 import com.ctrip.framework.apollo.ConfigService;
 import com.ctrip.framework.apollo.core.enums.ConfigFileFormat;
 import com.ctrip.framework.apollo.model.ConfigChange;
-import org.springframework.boot.context.properties.bind.Binder;
 
 import java.util.HashMap;
 import java.util.List;
@@ -72,7 +71,7 @@ public void registerListener() {
     /**
      * Builds and binds the {@link BootstrapConfigProperties} from the given configuration map.
      * <p>
-     * This method uses Spring's {@link Binder} to bind the configuration values to an instance
+     * This method uses SpringPropertyBinder to bind the configuration values to an instance
      * of {@link BootstrapConfigProperties}, which can then be used to configure the thread pool
      * dynamically.
      *

diff --git a/agent/hippo4j-agent-plugin/nacos-plugin/pom.xml b/agent/hippo4j-agent-plugin/nacos-plugin/pom.xml
@@ -26,6 +26,12 @@
             <artifactId>hippo4j-threadpool-dynamic-mode-config</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context</artifactId>
+            <version>6.0.4</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>com.alibaba.nacos</groupId>
             <artifactId>nacos-client</artifactId>

diff --git a/...ugin/src/main/java/cn/hippo4j/agent/plugin/nacos/NacosDynamicThreadPoolChangeHandler.java b/...ugin/src/main/java/cn/hippo4j/agent/plugin/nacos/NacosDynamicThreadPoolChangeHandler.java
@@ -32,7 +32,6 @@
 import com.alibaba.nacos.api.PropertyKeyConst;
 import com.alibaba.nacos.api.config.ConfigService;
 import com.alibaba.nacos.api.config.listener.Listener;
-import org.springframework.boot.context.properties.bind.Binder;
 
 import java.io.IOException;
 import java.util.HashMap;
@@ -124,7 +123,7 @@ public Executor getExecutor() {
     /**
      * Builds and binds the {@link BootstrapConfigProperties} from the given configuration map.
      * <p>
-     * This method uses Spring's {@link Binder} to bind the configuration values to an instance
+     * This method uses SpringPropertyBinder to bind the configuration values to an instance
      * of {@link BootstrapConfigProperties}, which can then be used to configure the thread pool
      * dynamically.
      *

diff --git a/...ain/java/cn/hippo4j/agent/plugin/nacos/interceptor/NacosConfigConstructorInterceptor.java b/...ain/java/cn/hippo4j/agent/plugin/nacos/interceptor/NacosConfigConstructorInterceptor.java
@@ -49,7 +49,7 @@ public void onConstruct(EnhancedInstance objInst, Object[] allArguments) throws
             }
 
             // The Nacos plugin triggers before the Spring configuration plug-in.
-            // This means that when the Apollo plug-in executes, Spring's Environment is not yet ready,
+            // This means that when the Nacos plugin executes, Spring's Environment is not yet ready,
             // so the configuration cannot be read
             // After listening to the AGENT_SPRING_PROPERTIES_LOADER_COMPLETED event, register the listener for Nacos
             AbstractSubjectCenter.register(AbstractSubjectCenter.SubjectType.AGENT_SPRING_PROPERTIES_LOADER_COMPLETED, new NacosConfigPropertiesLoaderCompletedListener());

diff --git a/agent/hippo4j-agent-plugin/pom.xml b/agent/hippo4j-agent-plugin/pom.xml
@@ -38,6 +38,12 @@
             <groupId>cn.hippo4j</groupId>
             <artifactId>hippo4j-agent-core</artifactId>
             <version>${project.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.springframework</groupId>
+                    <artifactId>spring-core</artifactId>
+                </exclusion>
+            </exclusions>
             <scope>provided</scope>
         </dependency>
         <dependency>

diff --git a/agent/hippo4j-agent-plugin/spring-plugins/pom.xml b/agent/hippo4j-agent-plugin/spring-plugins/pom.xml
@@ -15,6 +15,7 @@
     <modules>
         <module>spring-boot-1x-plugin</module>
         <module>spring-boot-2x-plugin</module>
+        <module>spring-boot-3x-plugin</module>
         <module>spring-plugin-common</module>
     </modules>
 

diff --git a/agent/hippo4j-agent-plugin/spring-plugins/spring-boot-1x-plugin/pom.xml b/agent/hippo4j-agent-plugin/spring-plugins/spring-boot-1x-plugin/pom.xml
@@ -13,7 +13,6 @@
 
     <properties>
         <spring.boot.version>1.5.22.RELEASE</spring.boot.version>
-        <apollo.version>1.9.1</apollo.version>
     </properties>
 
     <dependencyManagement>

diff --git a/.../main/java/cn/hippo4j/agent/plugin/spring/boot/v1/boot/SpringBootV1PluginBootService.java b/.../main/java/cn/hippo4j/agent/plugin/spring/boot/v1/boot/SpringBootV1PluginBootService.java
@@ -0,0 +1,52 @@
+/*
+ * 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 cn.hippo4j.agent.plugin.spring.boot.v1.boot;
+
+import cn.hippo4j.agent.core.boot.BootService;
+import cn.hippo4j.agent.core.boot.DefaultImplementor;
+import cn.hippo4j.common.logging.api.ILog;
+import cn.hippo4j.common.logging.api.LogManager;
+
+/**
+ * SpringBoot v1 plugin boot service
+ */
+@DefaultImplementor
+public class SpringBootV1PluginBootService implements BootService {
+
+    private static final ILog LOGGER = LogManager.getLogger(SpringBootV1PluginBootService.class);
+
+    @Override
+    public void prepare() throws Throwable {
+
+    }
+
+    @Override
+    public void boot() throws Throwable {
+        LOGGER.info("Loader SpringBootV1PluginBootService...");
+    }
+
+    @Override
+    public void onComplete() throws Throwable {
+
+    }
+
+    @Override
+    public void shutdown() throws Throwable {
+
+    }
+}
diff --git a/...ne/ApplicationContextInstrumentation.java → ...blishingRunListenerInstrumentationV1.java b/...ne/ApplicationContextInstrumentation.java → ...blishingRunListenerInstrumentationV1.java
@@ -32,13 +32,13 @@
 import static net.bytebuddy.matcher.ElementMatchers.named;
 
 /**
- * Application Context Refresh instrumentation
+ * SpringBoot v1 EventPublishingRunListener Finished instrumentation
  */
-public class ApplicationContextInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class EventPublishingRunListenerInstrumentationV1 extends ClassInstanceMethodsEnhancePluginDefine {
 
     private static final String ENHANCE_CLASS = "org.springframework.boot.context.event.EventPublishingRunListener";
 
-    private static final String APPLICATION_CONTEXT_REFRESH_INTERCEPTOR = "cn.hippo4j.agent.plugin.spring.boot.v1.interceptor.ApplicationContextInterceptor";
+    private static final String EVENT_PUBLISHING_FINISHED_INTERCEPTOR_V1 = "cn.hippo4j.agent.plugin.spring.boot.v1.interceptor.EventPublishingRunListenerFinishedInterceptorV1";
 
     @Override
     protected ClassMatch enhanceClass() {
@@ -61,7 +61,7 @@ public ElementMatcher<MethodDescription> getMethodsMatcher() {
 
             @Override
             public String getMethodsInterceptor() {
-                return APPLICATION_CONTEXT_REFRESH_INTERCEPTOR;
+                return EVENT_PUBLISHING_FINISHED_INTERCEPTOR_V1;
             }
 
             @Override

diff --git a/...ceptor/ApplicationContextInterceptor.java → ...hingRunListenerFinishedInterceptorV1.java b/...ceptor/ApplicationContextInterceptor.java → ...hingRunListenerFinishedInterceptorV1.java
@@ -33,9 +33,9 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
- * Application Context Refresh interceptor
+ * EventPublishingRunListener Finished interceptor
  */
-public class ApplicationContextInterceptor implements InstanceMethodsAroundInterceptor {
+public class EventPublishingRunListenerFinishedInterceptorV1 implements InstanceMethodsAroundInterceptor {
 
     private static final AtomicBoolean isExecuted = new AtomicBoolean(false);
 
@@ -46,10 +46,9 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
 
     @Override
     public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, Object ret) throws Throwable {
-        // Since the refresh() method is a method of the AbstractApplicationContext class,
-        // the AbstractApplicationContext itself is an implementation class of the ApplicationContext.
-        // Therefore, can treat the class instance itself as an ApplicationContext object.
-        ConfigurableApplicationContext context = (ConfigurableApplicationContext) objInst;
+        // Since the finished() method is a method of the EventPublishingRunListener class,
+        // the EventPublishingRunListener the first parameter is ConfigurableApplicationContext
+        ConfigurableApplicationContext context = (ConfigurableApplicationContext) allArguments[0];
         if (context.getParent() != null) {
             // After the child container is started, the thread pool registration will be carried out
             // IDEA's runtime environment or debugging mechanisms make context refresh speeds different.
@@ -70,8 +69,12 @@ public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allA
         if (isExecuted.compareAndSet(false, true)) {
             ApplicationContextHolder contextHolder = new ApplicationContextHolder();
             contextHolder.setApplicationContext(context);
+            // Load Spring Properties
             SpringPropertiesLoader.loadSpringProperties(context.getEnvironment());
-            AbstractSubjectCenter.register(AbstractSubjectCenter.SubjectType.THREAD_POOL_DYNAMIC_REFRESH, new DynamicThreadPoolRefreshListener());
+            // register Dynamic ThreadPool Refresh Listener
+            if (AbstractSubjectCenter.get(AbstractSubjectCenter.SubjectType.THREAD_POOL_DYNAMIC_REFRESH) == null) {
+                AbstractSubjectCenter.register(AbstractSubjectCenter.SubjectType.THREAD_POOL_DYNAMIC_REFRESH, new DynamicThreadPoolRefreshListener());
+            }
         }
         return ret;
     }

diff --git a/...oot-1x-plugin/src/main/resources/META-INF/services/cn.hippo4j.agent.core.boot.BootService b/...oot-1x-plugin/src/main/resources/META-INF/services/cn.hippo4j.agent.core.boot.BootService
@@ -0,0 +1,17 @@
+# 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.
+
+cn.hippo4j.agent.plugin.spring.boot.v1.boot.SpringBootV1PluginBootService
diff --git a/...j-agent-plugin/spring-plugins/spring-boot-1x-plugin/src/main/resources/hippo4j-plugin.def b/...j-agent-plugin/spring-plugins/spring-boot-1x-plugin/src/main/resources/hippo4j-plugin.def
@@ -14,4 +14,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-spring-boot-1.x=cn.hippo4j.agent.plugin.spring.boot.v1.define.ApplicationContextInstrumentation
+spring-boot-1.x=cn.hippo4j.agent.plugin.spring.boot.v1.define.EventPublishingRunListenerInstrumentationV1
diff --git a/.../main/java/cn/hippo4j/agent/plugin/spring/boot/v2/boot/SpringBootV2PluginBootService.java b/.../main/java/cn/hippo4j/agent/plugin/spring/boot/v2/boot/SpringBootV2PluginBootService.java
@@ -23,7 +23,7 @@
 import cn.hippo4j.common.logging.api.LogManager;
 
 /**
- * SpringBoot v1 plugin boot service
+ * SpringBoot v2 plugin boot service
  */
 @DefaultImplementor
 public class SpringBootV2PluginBootService implements BootService {

diff --git a/...PublishingRunListenerInstrumentation.java → ...blishingRunListenerInstrumentationV2.java b/...PublishingRunListenerInstrumentation.java → ...blishingRunListenerInstrumentationV2.java
@@ -25,20 +25,21 @@
 import net.bytebuddy.description.method.MethodDescription;
 import net.bytebuddy.matcher.ElementMatcher;
 
-import java.util.Collections;
+import java.util.Arrays;
 import java.util.List;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static cn.hippo4j.agent.core.plugin.match.NameMatch.byName;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 /**
- * Event publishing run listener instrumentation
+ * SpringBoot v2 Event publishing run listener instrumentation
  */
-public class EventPublishingRunListenerInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class EventPublishingRunListenerInstrumentationV2 extends ClassInstanceMethodsEnhancePluginDefine {
 
     private static final String ENHANCE_CLASS = "org.springframework.boot.context.event.EventPublishingRunListener";
 
-    private static final String EVENT_PUBLISHING_FINISHED_INTERCEPTOR = "cn.hippo4j.agent.plugin.spring.boot.v2.interceptor.EventPublishingStartedInterceptor";
+    private static final String EVENT_PUBLISHING_STARTED_INTERCEPTOR_V2 = "cn.hippo4j.agent.plugin.spring.boot.v2.interceptor.EventPublishingStartedInterceptorV2";
     private static final String EVENT_PUBLISHING_ENVIRONMENT_PREPARED_INTERCEPTOR = "cn.hippo4j.agent.plugin.spring.common.interceptor.EventPublishingRunListenerEnvironmentPreparedInterceptor";
 
     @Override
@@ -63,7 +64,7 @@ public ElementMatcher<MethodDescription> getMethodsMatcher() {
 
                     @Override
                     public String getMethodsInterceptor() {
-                        return EVENT_PUBLISHING_FINISHED_INTERCEPTOR;
+                        return EVENT_PUBLISHING_STARTED_INTERCEPTOR_V2;
                     }
 
                     @Override
@@ -93,7 +94,17 @@ public boolean isOverrideArgs() {
 
     @Override
     protected List<WitnessMethod> witnessMethods() {
-        return Collections.singletonList(new WitnessMethod("org.springframework.boot.context.event.EventPublishingRunListener",
-                named("started")));
+        return Arrays.asList(
+                new WitnessMethod("org.springframework.boot.context.event.EventPublishingRunListener", named("started")),
+                new WitnessMethod("org.springframework.boot.context.event.EventPublishingRunListener", named("running")),
+                new WitnessMethod("org.springframework.boot.context.event.EventPublishingRunListener", not(named("ready")))
+        // new WitnessMethod("org.springframework.boot.context.properties.ConstructorBinding", not(isAnnotatedWith(Deprecated.class)))
+        );
     }
+
+    @Override
+    protected String[] witnessClasses() {
+        return new String[]{"org.springframework.boot.context.properties.ConstructorBinding"};
+    }
+
 }
diff --git a/...or/EventPublishingStartedInterceptor.java → .../EventPublishingStartedInterceptorV2.java b/...or/EventPublishingStartedInterceptor.java → .../EventPublishingStartedInterceptorV2.java
@@ -35,11 +35,11 @@
 /**
  * Event publishing started interceptor
  */
-public class EventPublishingStartedInterceptor implements InstanceMethodsAroundInterceptor {
+public class EventPublishingStartedInterceptorV2 implements InstanceMethodsAroundInterceptor {
 
     private static final AtomicBoolean isExecuted = new AtomicBoolean(false);
 
-    private static final ILog LOGGER = LogManager.getLogger(EventPublishingStartedInterceptor.class);
+    private static final ILog LOGGER = LogManager.getLogger(EventPublishingStartedInterceptorV2.class);
 
     @Override
     public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, MethodInterceptResult result) throws Throwable {
@@ -61,7 +61,9 @@ public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allA
             // Load Spring Properties
             SpringPropertiesLoader.loadSpringProperties(context.getEnvironment());
             // register Dynamic ThreadPool Refresh Listener
-            AbstractSubjectCenter.register(AbstractSubjectCenter.SubjectType.THREAD_POOL_DYNAMIC_REFRESH, new DynamicThreadPoolRefreshListener());
+            if (AbstractSubjectCenter.get(AbstractSubjectCenter.SubjectType.THREAD_POOL_DYNAMIC_REFRESH) == null) {
+                AbstractSubjectCenter.register(AbstractSubjectCenter.SubjectType.THREAD_POOL_DYNAMIC_REFRESH, new DynamicThreadPoolRefreshListener());
+            }
         }
 
         return ret;

diff --git a/...j-agent-plugin/spring-plugins/spring-boot-2x-plugin/src/main/resources/hippo4j-plugin.def b/...j-agent-plugin/spring-plugins/spring-boot-2x-plugin/src/main/resources/hippo4j-plugin.def
@@ -14,4 +14,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-spring-boot-2.x=cn.hippo4j.agent.plugin.spring.boot.v2.define.EventPublishingRunListenerInstrumentation
+spring-boot-2.x=cn.hippo4j.agent.plugin.spring.boot.v2.define.EventPublishingRunListenerInstrumentationV2
diff --git a/agent/hippo4j-agent-plugin/spring-plugins/spring-boot-3x-plugin/pom.xml b/agent/hippo4j-agent-plugin/spring-plugins/spring-boot-3x-plugin/pom.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cn.hippo4j</groupId>
+        <artifactId>hippo4j-agent-spring-plugins</artifactId>
+        <version>2.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>hippo4j-agent-spring-boot-3x-plugin</artifactId>
+
+    <properties>
+        <spring-boot.version>3.0.2</spring-boot.version>
+    </properties>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter</artifactId>
+            <version>${spring-boot.version}</version>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>cn.hippo4j</groupId>
+            <artifactId>hippo4j-agent-spring-plugin-common</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+    </dependencies>
+
+</project>