Merge pull request #557 from ascrutae/feature/support-spring3-plugin

<!--

  ~ Copyright 2017, OpenSkywalking Organization 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.

  ~

  ~ Project repository: https://github.com/OpenSkywalking/skywalking

  -->

<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">

    <parent>

        <artifactId>spring-plugins</artifactId>

        <groupId>org.skywalking</groupId>

        <version>3.2.3-2017</version>

    </parent>

    <modelVersion>4.0.0</modelVersion>

    <artifactId>apm-springmvc-annotation-3.x-plugin</artifactId>

    <packaging>jar</packaging>

    <name>mvc-annotation-3.x-plugin</name>

    <url>http://maven.apache.org</url>

    <dependencies>

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-core</artifactId>

            <version>3.2.18.RELEASE</version>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-webmvc</artifactId>

            <version>3.2.18.RELEASE</version>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>javax.servlet</groupId>

            <artifactId>javax.servlet-api</artifactId>

            <version>3.0.1</version>

            <scope>provided</scope>

        </dependency>

    </dependencies>

</project>

/*

 * Copyright 2017, OpenSkywalking Organization 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.

 *

 * Project repository: https://github.com/OpenSkywalking/skywalking

 */

package org.skywalking.apm.plugin.spring.mvc.v3;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceConstructorInterceptor;

import org.springframework.web.bind.annotation.RequestMapping;

/**

 * {@link ControllerConstructorInterceptor} cache the value of {@link RequestMapping} annotation with method in class

 * annotation with {@link org.springframework.stereotype.Controller}.

 *

 * @author zhangxin

 */

public class ControllerConstructorInterceptor implements InstanceConstructorInterceptor {

    @Override

    public void onConstruct(EnhancedInstance objInst, Object[] allArguments) {

        String basePath = "";

        RequestMapping basePathRequestMapping = objInst.getClass().getAnnotation(RequestMapping.class);

        if (basePathRequestMapping != null) {

            if (basePathRequestMapping.value().length > 0) {

                basePath = basePathRequestMapping.value()[0];

            }

        }

        EnhanceRequireObjectCache enhanceCache = new EnhanceRequireObjectCache();

        enhanceCache.setPathMappingCache(new PathMappingCache(basePath));

        objInst.setSkyWalkingDynamicField(enhanceCache);

    }

}

/*

 * Copyright 2017, OpenSkywalking Organization 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.

 *

 * Project repository: https://github.com/OpenSkywalking/skywalking

 */

package org.skywalking.apm.plugin.spring.mvc.v3;

import java.lang.reflect.Method;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.skywalking.apm.agent.core.context.CarrierItem;

import org.skywalking.apm.agent.core.context.ContextCarrier;

import org.skywalking.apm.agent.core.context.ContextManager;

import org.skywalking.apm.agent.core.context.tag.Tags;

import org.skywalking.apm.agent.core.context.trace.AbstractSpan;

import org.skywalking.apm.agent.core.context.trace.SpanLayer;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;

import org.skywalking.apm.network.trace.component.ComponentsDefine;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.context.request.ServletRequestAttributes;

/**

 * {@link ControllerMethodInterceptor} create entry span when the client call the method annotation with {@link

 * RequestMapping} in the class  annotation with {@link org.springframework.stereotype.Controller}.

 *

 * @author zhangxin

 */

public class ControllerMethodInterceptor implements InstanceMethodsAroundInterceptor {

    @Override

    public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes,

        MethodInterceptResult result) throws Throwable {

        EnhanceRequireObjectCache pathMappingCache = (EnhanceRequireObjectCache)objInst.getSkyWalkingDynamicField();

        String requestURL = pathMappingCache.findPathMapping(method);

        if (requestURL == null) {

            requestURL = getRequestURL(method);

            pathMappingCache.addPathMapping(method, requestURL);

            requestURL = pathMappingCache.findPathMapping(method);

        }

        HttpServletRequest request =

            ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();

        ContextCarrier contextCarrier = new ContextCarrier();

        CarrierItem next = contextCarrier.items();

        while (next.hasNext()) {

            next = next.next();

            next.setHeadValue(request.getHeader(next.getHeadKey()));

        }

        AbstractSpan span = ContextManager.createEntrySpan(requestURL, contextCarrier);

        Tags.URL.set(span, request.getRequestURL().toString());

        Tags.HTTP.METHOD.set(span, request.getMethod());

        span.setComponent(ComponentsDefine.SPRING_MVC_ANNOTATION);

        SpanLayer.asHttp(span);

    }

    @Override

    public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes,

        Object ret) throws Throwable {

        HttpServletResponse response = ((EnhanceRequireObjectCache)objInst.getSkyWalkingDynamicField()).getHttpServletResponse();

        AbstractSpan span = ContextManager.activeSpan();

        if (response.getStatus() >= 400) {

            span.errorOccurred();

            Tags.STATUS_CODE.set(span, Integer.toString(response.getStatus()));

        }

        ContextManager.stopSpan();

        return ret;

    }

    @Override

    public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments,

        Class<?>[] argumentsTypes, Throwable t) {

        ContextManager.activeSpan().errorOccurred().log(t);

    }

    public String getRequestURL(Method method) {

        String requestURL = "";

        RequestMapping methodRequestMapping = method.getAnnotation(RequestMapping.class);

        if (methodRequestMapping.value().length > 0) {

            requestURL = methodRequestMapping.value()[0];

        }

        return requestURL;

    }

}

/*

 * Copyright 2017, OpenSkywalking Organization 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.

 *

 * Project repository: https://github.com/OpenSkywalking/skywalking

 */

package org.skywalking.apm.plugin.spring.mvc.v3;

import java.lang.reflect.Method;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.context.request.NativeWebRequest;

public class EnhanceRequireObjectCache {

    private PathMappingCache pathMappingCache;

    private NativeWebRequest nativeWebRequest;

    public void setPathMappingCache(PathMappingCache pathMappingCache) {

        this.pathMappingCache = pathMappingCache;

    }

    public HttpServletResponse getHttpServletResponse() {

        return (HttpServletResponse)nativeWebRequest.getNativeResponse();

    }

    public void setNativeWebRequest(NativeWebRequest nativeWebRequest) {

        this.nativeWebRequest = nativeWebRequest;

    }

    public String findPathMapping(Method method) {

        return pathMappingCache.findPathMapping(method);

    }

    public void addPathMapping(Method method, String url) {

        pathMappingCache.addPathMapping(method, url);

    }

    public PathMappingCache getPathMappingCache() {

        return pathMappingCache;

    }

}

/*

 * Copyright 2017, OpenSkywalking Organization 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.

 *

 * Project repository: https://github.com/OpenSkywalking/skywalking

 */

package org.skywalking.apm.plugin.spring.mvc.v3;

import java.lang.reflect.Method;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;

import org.springframework.web.context.request.NativeWebRequest;

/**

 * {@link GetBeanInterceptor} pass the {@link NativeWebRequest} object into the {@link

 * org.springframework.stereotype.Controller} object.

 *

 * @author zhangxin

 */

public class GetBeanInterceptor implements InstanceMethodsAroundInterceptor {

    @Override

    public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes,

        MethodInterceptResult result) throws Throwable {

    }

    @Override

    public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes,

        Object ret) throws Throwable {

        if (ret instanceof EnhancedInstance) {

            ((EnhanceRequireObjectCache)((EnhancedInstance)ret).getSkyWalkingDynamicField()).setNativeWebRequest((NativeWebRequest)objInst.getSkyWalkingDynamicField());

        }

        return ret;

    }

    @Override

    public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments,

        Class<?>[] argumentsTypes, Throwable t) {

    }

}