*support springboot3

Signed-off-by: provenceee <[email protected]>
provenceee · Nov 12, 2024 · afbc366 · afbc366
1 parent 6692b83
commit afbc366
Show file tree

Hide file tree

Showing 16 changed files with 132 additions and 242 deletions.
diff --git a/.../sermant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/AgentCoreEntrance.java b/.../sermant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/AgentCoreEntrance.java
@@ -85,11 +85,12 @@ public static void install(String artifact, Map<String, Object> argsMap, Instrum
             agentType = AgentType.AGENTMAIN.getValue();
         }
         artifactCache = artifact;
-        adviserCache = new DefaultAdviser();
 
         // 初始化默认日志，在未加载日志引擎前保证日志可用
         LoggerFactory.initDefaultLogger(artifact);
 
+        adviserCache = new DefaultAdviser();
+
         // 初始化框架类加载器
         ClassLoaderManager.init(argsMap);
 

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
@@ -92,7 +92,7 @@ public static Logger getLogger() {
         if (defaultLogger == null) {
             synchronized (LoggerFactory.class) {
                 if (defaultLogger == null) {
-                    defaultLogger = java.util.logging.Logger.getLogger("sermant");
+                    defaultLogger = java.util.logging.Logger.getLogger("sermant.default");
                 }
             }
         }

diff --git a/sermant-plugins/sermant-router/spring-router-plugin/pom.xml b/sermant-plugins/sermant-router/spring-router-plugin/pom.xml
@@ -61,12 +61,6 @@
             <version>${jakarta.el.version}</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-web</artifactId>
-            <version>${spring.version}</version>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-webflux</artifactId>

diff --git a/...clarer/HandlerExecutionChainDeclarer.java → ...g/declarer/DispatcherServletDeclarer.java b/...clarer/HandlerExecutionChainDeclarer.java → ...g/declarer/DispatcherServletDeclarer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022-2022 Huawei Technologies Co., Ltd. All rights reserved.
+ * Copyright (C) 2022-2024 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.
@@ -19,23 +19,24 @@
 import com.huaweicloud.sermant.core.plugin.agent.matcher.ClassMatcher;
 
 /**
- * 通过拦截增加注入拦截器，注入spring web拦截器
+ * 获取http请求数据
  *
  * @author provenceee
  * @since 2022-07-12
  */
-public class HandlerExecutionChainDeclarer extends AbstractDeclarer {
-    private static final String ENHANCE_CLASS = "org.springframework.web.servlet.HandlerExecutionChain";
+public class DispatcherServletDeclarer extends AbstractDeclarer {
+    private static final String ENHANCE_CLASS
+            = "org.springframework.web.servlet.DispatcherServlet";
 
     private static final String INTERCEPT_CLASS
-            = "com.huaweicloud.sermant.router.spring.interceptor.HandlerExecutionChainInterceptor";
+            = "com.huaweicloud.sermant.router.spring.interceptor.DispatcherServletInterceptor";
 
-    private static final String METHOD_NAME = "applyPreHandle";
+    private static final String METHOD_NAME = "doService";
 
     /**
      * 构造方法
      */
-    public HandlerExecutionChainDeclarer() {
+    public DispatcherServletDeclarer() {
         super(ENHANCE_CLASS, INTERCEPT_CLASS, METHOD_NAME);
     }
 

diff --git a/...n/java/com/huaweicloud/sermant/router/spring/interceptor/DiscoveryManagerInterceptor.java b/...n/java/com/huaweicloud/sermant/router/spring/interceptor/DiscoveryManagerInterceptor.java
@@ -59,6 +59,7 @@ public ExecuteContext before(ExecuteContext context) {
             Object serviceName = ReflectUtils.getFieldValue(obj, "serviceName").orElse(null);
             if (serviceName instanceof String) {
                 AppCache.INSTANCE.setAppName((String) serviceName);
+                configService.init(RouterConstant.SPRING_CACHE_NAME, (String) serviceName);
             } else {
                 LOGGER.warning("Service name is null or not instanceof string.");
             }
@@ -69,7 +70,6 @@ public ExecuteContext before(ExecuteContext context) {
 
     @Override
     public ExecuteContext after(ExecuteContext context) {
-        configService.init(RouterConstant.SPRING_CACHE_NAME, AppCache.INSTANCE.getAppName());
         return context;
     }
 }
diff --git a/.../interceptor/RouteHandlerInterceptor.java → ...rceptor/DispatcherServletInterceptor.java b/.../interceptor/RouteHandlerInterceptor.java → ...rceptor/DispatcherServletInterceptor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022-2022 Huawei Technologies Co., Ltd. All rights reserved.
+ * Copyright (C) 2022-2024 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.
@@ -16,6 +16,8 @@
 
 package com.huaweicloud.sermant.router.spring.interceptor;
 
+import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
 import com.huaweicloud.sermant.core.plugin.service.PluginServiceManager;
 import com.huaweicloud.sermant.router.common.handler.Handler;
 import com.huaweicloud.sermant.router.common.utils.CollectionUtils;
@@ -25,9 +27,7 @@
 import com.huaweicloud.sermant.router.spring.handler.LaneRequestTagHandler;
 import com.huaweicloud.sermant.router.spring.handler.RouteRequestTagHandler;
 import com.huaweicloud.sermant.router.spring.service.SpringConfigService;
-
-import org.springframework.web.servlet.HandlerInterceptor;
-import org.springframework.web.servlet.ModelAndView;
+import com.huaweicloud.sermant.router.spring.utils.SpringRouterUtils;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -38,24 +38,21 @@
 import java.util.Map;
 import java.util.Set;
 
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-
 /**
- * spring拦截器
+ * 获取http请求数据
  *
  * @author provenceee
  * @since 2022-07-12
  */
-public class RouteHandlerInterceptor implements HandlerInterceptor {
+public class DispatcherServletInterceptor extends AbstractInterceptor {
     private final List<AbstractRequestTagHandler> handlers;
 
     private final SpringConfigService configService;
 
     /**
      * 构造方法
      */
-    public RouteHandlerInterceptor() {
+    public DispatcherServletInterceptor() {
         configService = PluginServiceManager.getPluginService(SpringConfigService.class);
         handlers = new ArrayList<>();
         handlers.add(new LaneRequestTagHandler());
@@ -64,38 +61,43 @@ public RouteHandlerInterceptor() {
     }
 
     @Override
-    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object obj) {
+    public ExecuteContext before(ExecuteContext context) {
         Set<String> matchKeys = configService.getMatchKeys();
         Set<String> injectTags = configService.getInjectTags();
         if (CollectionUtils.isEmpty(matchKeys) && CollectionUtils.isEmpty(injectTags)) {
             // 染色标记为空，代表没有染色规则，直接return
-            return true;
+            return context;
         }
+        Object request = context.getArguments()[0];
         Map<String, List<String>> headers = getHeaders(request);
-        Map<String, String[]> parameterMap = request.getParameterMap();
-        String path = request.getRequestURI();
-        String method = request.getMethod();
+        Map<String, String[]> parameterMap = SpringRouterUtils.getParameterMap(request);
+        String path = SpringRouterUtils.getRequestUri(request);
+        String method = SpringRouterUtils.getMethod(request);
         handlers.forEach(handler -> ThreadLocalUtils.addRequestTag(
                 handler.getRequestTag(path, method, headers, parameterMap, new Keys(matchKeys, injectTags))));
-        return true;
+        return context;
     }
 
     @Override
-    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object obj,
-            ModelAndView modelAndView) {
+    public ExecuteContext after(ExecuteContext context) {
+        ThreadLocalUtils.removeRequestData();
+        ThreadLocalUtils.removeRequestTag();
+        return context;
     }
 
     @Override
-    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object obj, Exception ex) {
+    public ExecuteContext onThrow(ExecuteContext context) {
+        ThreadLocalUtils.removeRequestData();
         ThreadLocalUtils.removeRequestTag();
+        return context;
     }
 
-    private Map<String, List<String>> getHeaders(HttpServletRequest request) {
+    private Map<String, List<String>> getHeaders(Object request) {
         Map<String, List<String>> headers = new HashMap<>();
-        Enumeration<?> enumeration = request.getHeaderNames();
+        Enumeration<?> enumeration = SpringRouterUtils.getHeaderNames(request);
         while (enumeration.hasMoreElements()) {
             String key = (String) enumeration.nextElement();
-            headers.put(key, enumeration2List(request.getHeaders(key)));
+            headers.put(key, enumeration2List(SpringRouterUtils.getHeaders(request, key)));
         }
         return headers;
     }

diff --git a/...n/java/com/huaweicloud/sermant/router/spring/interceptor/EurekaHttpClientInterceptor.java b/...n/java/com/huaweicloud/sermant/router/spring/interceptor/EurekaHttpClientInterceptor.java
@@ -53,14 +53,14 @@ public ExecuteContext before(ExecuteContext context) {
         if (argument instanceof InstanceInfo) {
             InstanceInfo instanceInfo = (InstanceInfo) argument;
             AppCache.INSTANCE.setAppName(instanceInfo.getAppName());
+            configService.init(RouterConstant.SPRING_CACHE_NAME, instanceInfo.getAppName());
             SpringRouterUtils.putMetaData(instanceInfo.getMetadata(), routerConfig);
         }
         return context;
     }
 
     @Override
     public ExecuteContext after(ExecuteContext context) {
-        configService.init(RouterConstant.SPRING_CACHE_NAME, AppCache.INSTANCE.getAppName());
         return context;
     }
 }
diff --git a/...a/com/huaweicloud/sermant/router/spring/interceptor/HandlerExecutionChainInterceptor.java b/...a/com/huaweicloud/sermant/router/spring/interceptor/HandlerExecutionChainInterceptor.java
diff --git a/...in/java/com/huaweicloud/sermant/router/spring/interceptor/ServiceRegistryInterceptor.java b/...in/java/com/huaweicloud/sermant/router/spring/interceptor/ServiceRegistryInterceptor.java
@@ -66,6 +66,7 @@ public ExecuteContext before(ExecuteContext context) {
                         serviceRegistration.getClass().getDeclaredMethod("getRegistration"))
                         .invoke(serviceRegistration);
                 AppCache.INSTANCE.setAppName(registration.getServiceId());
+                configService.init(RouterConstant.SPRING_CACHE_NAME, registration.getServiceId());
                 SpringRouterUtils.putMetaData(registration.getMetadata(), routerConfig);
             } catch (InvocationTargetException | IllegalAccessException | NoSuchMethodException ex) {
                 LOGGER.log(Level.WARNING, "Can not get the registration.", ex);
@@ -76,7 +77,6 @@ public ExecuteContext before(ExecuteContext context) {
 
     @Override
     public ExecuteContext after(ExecuteContext context) {
-        configService.init(RouterConstant.SPRING_CACHE_NAME, AppCache.INSTANCE.getAppName());
         return context;
     }
 }
diff --git a/...r-plugin/src/main/java/com/huaweicloud/sermant/router/spring/utils/SpringRouterUtils.java b/...r-plugin/src/main/java/com/huaweicloud/sermant/router/spring/utils/SpringRouterUtils.java
@@ -22,6 +22,7 @@
 import com.huaweicloud.sermant.router.common.utils.ReflectUtils;
 import com.huaweicloud.sermant.router.spring.cache.AppCache;
 
+import java.util.Enumeration;
 import java.util.Locale;
 import java.util.Map;
 
@@ -39,6 +40,57 @@ public class SpringRouterUtils {
     private SpringRouterUtils() {
     }
 
+    /**
+     * 获取请求中的parameter
+     *
+     * @param obj HttpServletRequest
+     * @return parameter
+     */
+    public static Map<String, String[]> getParameterMap(Object obj) {
+        return (Map<String, String[]>) ReflectUtils.invokeWithNoneParameter(obj, "getParameterMap");
+    }
+
+    /**
+     * 获取请求中的uri
+     *
+     * @param obj HttpServletRequest
+     * @return uri
+     */
+    public static String getRequestUri(Object obj) {
+        return ReflectUtils.invokeWithNoneParameterAndReturnString(obj, "getRequestURI");
+    }
+
+    /**
+     * 获取请求中的方法
+     *
+     * @param obj HttpServletRequest
+     * @return method
+     */
+    public static String getMethod(Object obj) {
+        return ReflectUtils.invokeWithNoneParameterAndReturnString(obj, "getMethod");
+    }
+
+    /**
+     * 获取请求中的所有请求头的key
+     *
+     * @param obj HttpServletRequest
+     * @return key
+     */
+    public static Enumeration<?> getHeaderNames(Object obj) {
+        return (Enumeration<?>) ReflectUtils.invokeWithNoneParameter(obj, "getHeaderNames");
+    }
+
+    /**
+     * 获取元数据
+     *
+     * @param obj HttpServletRequest
+     * @param key header key
+     * @return 元数据
+     */
+    public static Enumeration<?> getHeaders(Object obj, String key) {
+        return (Enumeration<?>) ReflectUtils.invokeWithParameter(obj, "getHeaders", key, String.class);
+    }
+
     /**
      * 获取元数据
      *

diff --git a/...urces/META-INF/services/com.huaweicloud.sermant.core.plugin.agent.declarer.PluginDeclarer b/...urces/META-INF/services/com.huaweicloud.sermant.core.plugin.agent.declarer.PluginDeclarer
@@ -2,9 +2,9 @@ com.huaweicloud.sermant.router.spring.declarer.AbstractHandlerMappingDeclarer
 com.huaweicloud.sermant.router.spring.declarer.BaseLoadBalancerDeclarer
 com.huaweicloud.sermant.router.spring.declarer.ClientHttpRequestDeclarer
 com.huaweicloud.sermant.router.spring.declarer.DiscoveryManagerDeclarer
+com.huaweicloud.sermant.router.spring.declarer.DispatcherServletDeclarer
 com.huaweicloud.sermant.router.spring.declarer.EurekaHttpClientDeclarer
 com.huaweicloud.sermant.router.spring.declarer.FeignClientDeclarer
-com.huaweicloud.sermant.router.spring.declarer.HandlerExecutionChainDeclarer
 com.huaweicloud.sermant.router.spring.declarer.HystrixActionDeclarer
 com.huaweicloud.sermant.router.spring.declarer.LoadBalancerClientFilterDeclarer
 com.huaweicloud.sermant.router.spring.declarer.NopInstanceFilterDeclarer

diff --git a/...va/com/huaweicloud/sermant/router/spring/interceptor/DiscoveryManagerInterceptorTest.java b/...va/com/huaweicloud/sermant/router/spring/interceptor/DiscoveryManagerInterceptorTest.java
@@ -104,15 +104,6 @@ public void testBefore() {
         context.getArguments()[0] = new TestObject(null);
         interceptor.before(context);
         Assert.assertEquals("foo", AppCache.INSTANCE.getAppName());
-    }
-
-    /**
-     * 测试after方法
-     */
-    @Test
-    public void testAfter() {
-        AppCache.INSTANCE.setAppName("foo");
-        interceptor.after(context);
         Assert.assertEquals(RouterConstant.SPRING_CACHE_NAME, configService.getCacheName());
         Assert.assertEquals("foo", configService.getServiceName());
     }