springMvc项目启动不执行Controller的RequestMapping映射

[panyi5202]

Please answer these questions before submitting your issue.

What version of sky-walking are you using?

3.2.3-2017

What version of your OS?

win10

What version of your JRE?

JDK1.8.0_31

What company or project?

spring-webmvc-3.2.16

What did you do?

If possible, provide a way for reproducing the error. e.g. demo application, component version.
背景：系统中对Controller做了切面，Controller没有实现接口。

• 当我直接启动时（未加入skywalking-agent的虚拟机参数），发现spring会生成Controller的Cglib代理对象，但是当我加入skywalking-agent的虚拟机参数启动时，spring会生成Controller的Jdk代理对象；
• 进一步debug发现，spring之所以生成Controller的Jdk代理，是因为发现Controller有一个接口：org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance；最终在spring的RequestMappingHandlerMapping类中就无法从代理类中获取到Controller类的标注了（Controller或RequestMapping），所以就不做url的映射了。

[wu-sheng]

org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance 这个接口确实我们会要求你的类动态实现，但是我不确定的问题是，动态实现接口，我并没有改变类的其他方法。就算用JDKProxy来代理，不应该影响标注生效吧？

难道如果Controller自己实现了一个接口，再AOP，Controller就失效了？如果可能，请用本地硬编码确认下，并提供controller以及AOP配置的示例。

FYI @ascrutae @wendal

[panyi5202]

我把spring几段关键代码贴一下。
类：org/springframework/web/servlet/handler/AbstractHandlerMethodMapping.java

protected void initHandlerMethods() {
		if (logger.isDebugEnabled()) {
			logger.debug("Looking for request mappings in application context: " + getApplicationContext());
		}

		String[] beanNames = (this.detectHandlerMethodsInAncestorContexts ?
				BeanFactoryUtils.beanNamesForTypeIncludingAncestors(getApplicationContext(), Object.class) :
				getApplicationContext().getBeanNamesForType(Object.class));

		for (String beanName : beanNames) {
			if (isHandler(getApplicationContext().getType(beanName))){
				detectHandlerMethods(beanName);
			}
		}
		handlerMethodsInitialized(getHandlerMethods());
	}

在这个方法中，会遍历所有的bean，如果是Controller则会做RequestMapping。这里面的关键方法是isHandler(beanClassType)；进入这个方法：

protected boolean isHandler(Class<?> beanType) {
		return ((AnnotationUtils.findAnnotation(beanType, Controller.class) != null) ||
				(AnnotationUtils.findAnnotation(beanType, RequestMapping.class) != null));
	}

会检查类是否有Controller标注或者RequestMapping标注。这里传入的beanType是代理对象的类型。
具体findAnnotation的代码也顺便贴一下：

public static <A extends Annotation> A findAnnotation(Class<?> clazz, Class<A> annotationType) {
		Assert.notNull(clazz, "Class must not be null");
		A annotation = clazz.getAnnotation(annotationType);
		if (annotation != null) {
			return annotation;
		}
		for (Class<?> ifc : clazz.getInterfaces()) {
			annotation = findAnnotation(ifc, annotationType);
			if (annotation != null) {
				return annotation;
			}
		}
		if (!Annotation.class.isAssignableFrom(clazz)) {
			for (Annotation ann : clazz.getAnnotations()) {
				annotation = findAnnotation(ann.annotationType(), annotationType);
				if (annotation != null) {
					return annotation;
				}
			}
		}
		Class<?> superclass = clazz.getSuperclass();
		if (superclass == null || superclass.equals(Object.class)) {
			return null;
		}
		return findAnnotation(superclass, annotationType);
	}

在这个过程中，如果是Cglib的代理对象的类型，则可以通过superclass找到原来的Controller类，如果是Jdk的代理对象的类型，就找不到了。

[wu-sheng]

@panyi5202 你这个问题的原因，我大致情况。现在主要是要找到解决办法。

Cause

• 原始情况： 原始类没有实现接口，所以Spring内核会使用cglib进行扩展，则类和方法保持不变
• 探针运行后： 原始类没有实现接口，Skywalking动态扩展接口后，Spring内核改而使用Proxy方式扩展，则方法变少，其他标准了mapping的方法消失（因为不是EnhancedClass接口的方法）

要修复这个问题，我个人想法是在Spring的内核上下一个埋点，如果class只实现了EnhancedClass接口，则也使用cglib，这个我觉得才能在不损失效率的情况下解决。

@panyi5202 你是否熟悉这段？能过找到Spring core中这段逻辑的位置？

cc @dyc87112 @JeffLi1993 你们能否帮我确认下，上面关于Spring使用cglib和proxy方式的描述是否准确？以及Spring源码中，在哪里判断的这段逻辑？

[panyi5202]

在这个类这里：org/springframework/aop/framework/DefaultAopProxyFactory.java:51

public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException {                          
	if (config.isOptimize() || config.isProxyTargetClass() || hasNoUserSuppliedProxyInterfaces(config)) {  
		Class targetClass = config.getTargetClass();                                                       
		if (targetClass == null) {                                                                         
			throw new AopConfigException("TargetSource cannot determine target class: " +                  
					"Either an interface or a target is required for proxy creation.");                    
		}                                                                                                  
		if (targetClass.isInterface()) {                                                                   
			return new JdkDynamicAopProxy(config);                                                         
		}                                                                                                  
		return CglibProxyFactory.createCglibProxy(config);                                                 
	}                                                                                                      
	else {                                                                                                 
		return new JdkDynamicAopProxy(config);                                                             
	}                                                                                                      
}                                                                                                          

[wu-sheng]

@ascrutae I have an idea about the solution. Maybe we provide spring-core-aop-patch.plugin to intercept this method, and provide our own implementations. What do you think?

if(onlyImplementEnhancedInstance(targetClass)){
    return CglibProxyFactory.createCglibProxy(config);             
}

[wu-sheng]

cc @flychao88

[wu-sheng]

cc @OpenSkywalking/pmc @OpenSkywalking/committer-team

[wu-sheng]

@panyi5202 你是否调试过，你这个类属于哪种条件情况？所以使用了JdkProxy。

[panyi5202]

public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException {                        
	if (config.isOptimize() || config.isProxyTargetClass() || hasNoUserSuppliedProxyInterfaces(config)) {
		Class targetClass = config.getTargetClass();                                                     
		if (targetClass == null) {                                                                       
			throw new AopConfigException("TargetSource cannot determine target class: " +                
					"Either an interface or a target is required for proxy creation.");                  
		}                                                                                                
		if (targetClass.isInterface()) {                                                                 
			return new JdkDynamicAopProxy(config);                                                       
		}                                                                                                
		return CglibProxyFactory.createCglibProxy(config);                                               
	}                                                                                                    
	else {    // 符合这个条件                                                                                           
		return new JdkDynamicAopProxy(config);                                                           
	}                                                                                                    
}                                                                                                        

具体原因在这个方法里：hasNoUserSuppliedProxyInterfaces(config)

private boolean hasNoUserSuppliedProxyInterfaces(AdvisedSupport config) {                                  
	Class[] interfaces = config.getProxiedInterfaces();                                                    
	return (interfaces.length == 0 || (interfaces.length == 1 && SpringProxy.class.equals(interfaces[0])));
}                                                                                                          

[wu-sheng]

那拦截hasNoUserSuppliedProxyInterfaces这个方法更好。

[wu-sheng]

@panyi5202 @ascrutae I think we have a solution. @ascrutae Please check your schedule, and set the milestone whether in 3.2.5 or next it.