app.myoss.cloud.apm.log.method.aspectj.MonitorMethodAfter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of myoss-starter-apm Show documentation
myoss open source project, myoss-starter written in Java
There is a newer version: 2.3.1.RELEASE
/*
 * Copyright 2018-2018 https://github.com/myoss
 *
 * 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.
 *
 */

package app.myoss.cloud.apm.log.method.aspectj;

import java.lang.reflect.Method;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.alibaba.fastjson.JSONObject;

import app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAfter;
import app.myoss.cloud.apm.log.method.aspectj.annotation.MonitorMethodAdvice;
import lombok.extern.slf4j.Slf4j;

/**
 * 记录方法的返回值，使用注解： {@link LogMethodAfter}
 * 
 * 非private/final的方法，非AOP调用的方法也是不支持的
 *
 * @author Jerry.Chen
 * @since 2018年4月11日 下午12:14:56
 * @see LogMethodAfter
 */
@Slf4j(topic = "MonitorMethod")
@Aspect
@MonitorMethodAdvice
public class MonitorMethodAfter extends AbstractMonitorMethod {

    /**
     * 排除哪些方法
     * 

     * 排除方法上有@ExceptionHandler注解，Controller的异常处理:
     * @org.springframework.web.bind.annotation.ExceptionHandler
     * 
排除方法上有@Scheduled注解，Spring Task定时任务:
     * @org.springframework.scheduling.annotation.Scheduled
     * 
排除方法、类上有@LogUnMonitor注解，自定义Log注解:
     * @app.myoss.cloud.apm.log.method.aspectj.annotation.LogUnMonitor
     * 
排除方法、类上有@LogMethodAround注解，自定义Log注解:
     * @app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAround
     * 
     *
     * @see org.springframework.aop.aspectj.AspectJExpressionPointcut#matches(Method,
     *      Class, boolean)
     */
    @Pointcut("execution(@org.springframework.web.bind.annotation.ExceptionHandler * *(..))"
            + " || execution(@org.springframework.scheduling.annotation.Scheduled * *(..))"
            // 放在class上有效，method上无效
            + " || @within(app.myoss.cloud.apm.log.method.aspectj.annotation.LogUnMonitor)"
            // 放在class上无效，method上有效
            + " || @annotation(app.myoss.cloud.apm.log.method.aspectj.annotation.LogUnMonitor)"
            + " || @within(app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAround)"
            + " || @annotation(app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAround)")
    public void unWantToMatch() {
        // Do nothing
    }

    /**
     * 监控哪些方法
     * 
     * 方法、类上有@LogMethodAfter注解，自定义Log注解:
     * @app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAfter
     * 
     */
    @Pointcut("@within(app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAfter)"
            // 放在class上有效，method上无效
            + " || @annotation(app.myoss.cloud.apm.log.method.aspectj.annotation.LogMethodAfter)"
    // 放在class上无效，method上有效
    )
    public void wantToMatch() {
        // Do nothing
    }

    /**
     * 监控规则
     */
    @Pointcut("wantToMatch() && ! unWantToMatch()")
    public void allWantToMatch() {
        // Do nothing
    }

    /**
     * 使用 AOP 记录方法的返回值
     *
     * @param joinPoint AOP JoinPoint
     * @param result 方法返回值
     */
    @AfterReturning(value = "allWantToMatch()", returning = "result")
    public void doAfterReturning(JoinPoint joinPoint, Object result) {
        Signature signature = joinPoint.getSignature();
        String methodName = signature.getDeclaringTypeName() + "#" + signature.getName();
        Logger logger = LoggerFactory.getLogger(methodName);
        JSONObject jsonAfter = new JSONObject();
        jsonAfter.put("end", System.currentTimeMillis());
        jsonAfter.put("result", result);
        jsonAfter.put("app", properties.getAppName());
        logger.info(toJSONString(jsonAfter));
    }

}