快捷導(dǎo)航

解析springboot集成AOP實(shí)現(xiàn)日志輸出的方法

更新時(shí)間：2021年11月08日 09:24:17 作者：張童瑤

如果這需要在每一個(gè)controller層去寫的話代碼過(guò)于重復(fù)，于是就使用AOP定義切面對(duì)其接口調(diào)用前后進(jìn)行攔截日志輸出。接下來(lái)通過(guò)本文給大家介紹springboot集成AOP實(shí)現(xiàn)日志輸出,需要的朋友可以參考下

開(kāi)發(fā)接口系統(tǒng)中主要的一環(huán)就是日志輸出，如果系統(tǒng)出現(xiàn)問(wèn)題，日志能幫我們?nèi)ザㄎ粏?wèn)題，最常見(jiàn)的日志是調(diào)用方所調(diào)用的IP 接口地址對(duì)應(yīng)方法參數(shù)值以及接口方接收到請(qǐng)求所返回的參數(shù)。如果這需要在每一個(gè)controller層去寫的話代碼過(guò)于重復(fù)，于是就使用AOP定義切面對(duì)其接口調(diào)用前后進(jìn)行攔截日志輸出。

1、加入依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2、定義切面組件

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import io.swagger.annotations.ApiOperation;
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.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;

 /**
 * 日志切面工具
 * @author tongyao
 */
@Aspect
@Component
public class LogAspect {

    private final Logger logger = LoggerFactory.getLogger(LogAspect.class);

    /**
     * 定義切入點(diǎn) 就是需要攔截的切面
     */
    @Pointcut("execution(public * cn.com.antMap.tree.controller.*.*(..))")
    public void controllerMethod() {}




    /**
     * 進(jìn)入方法請(qǐng)求執(zhí)行前
     *
     * @param joinPoint
     * @throws Exception
     */
    @Before("controllerMethod()")
    public void LogRequestInfo(JoinPoint joinPoint) {
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
        StringBuilder requestLog = new StringBuilder();
        Signature signature = joinPoint.getSignature();
        // 打印請(qǐng)求內(nèi)容
        logger.info("===============請(qǐng)求內(nèi)容開(kāi)始===============");
        logger.info("請(qǐng)求地址:" + request.getRequestURL().toString());
        logger.info("請(qǐng)求IP:" + request.getRemoteAddr());
        logger.info("請(qǐng)求方式:" + request.getMethod());
        logger.info("請(qǐng)求類方法:" + joinPoint.getSignature());
        logger.info("請(qǐng)求類方法參數(shù)值:" + Arrays.toString(joinPoint.getArgs()));
        // 處理請(qǐng)求參數(shù)
        String[] paramNames = ((MethodSignature) signature).getParameterNames();
        Object[] paramValues = joinPoint.getArgs();
        int paramLength = null == paramNames ? 0 : paramNames.length;
        if (paramLength == 0) {
            requestLog.append("請(qǐng)求參數(shù) = {} ");
        } else {
            requestLog.append("請(qǐng)求參數(shù) = [");
            for (int i = 0; i < paramLength - 1; i++) {
                requestLog.append(paramNames[i]).append("=").append(JSONObject.toJSONString(paramValues[i])).append(",");
            }
            requestLog.append(paramNames[paramLength - 1]).append("=").append(JSONObject.toJSONString(paramValues[paramLength - 1])).append("]");
        }
        logger.info("請(qǐng)求參數(shù)明細(xì):"+requestLog.toString());
        logger.info("===============請(qǐng)求內(nèi)容結(jié)束===============");
    }

    /**
     * 進(jìn)入方法請(qǐng)求執(zhí)行后
     *
     * @param o
     * @throws Exception
     */
    @AfterReturning(returning = "o", pointcut = "controllerMethod()")
    public void logResultVOInfo(Object o){
        logger.info("--------------返回內(nèi)容開(kāi)始----------------");
        logger.info("Response內(nèi)容:" + JSON.toJSONString(o));
        logger.info("--------------返回內(nèi)容結(jié)束----------------");
    }

    /**
     * 該切面發(fā)生異常信息時(shí)進(jìn)行攔截
     * @param joinPoint
     * @param ex
     */
    @AfterThrowing(pointcut = "controllerMethod()", throwing = "ex")
    public void doAfterThrowing(JoinPoint joinPoint, Exception ex) {
        String methodName = joinPoint.getSignature().getName();
        List<Object> args = Arrays.asList(joinPoint.getArgs());
        System.out.println("連接點(diǎn)方法為：" + methodName + ",參數(shù)為：" + args + ",異常為：" + ex);

    }
}

其中spring.aop.auto屬性默認(rèn)是開(kāi)啟的，也就是說(shuō)只要引入了AOP依賴后，默認(rèn)已經(jīng)增加了@EnableAspectJAutoProxy。
aop組件中用到了 @Pointcut(“execution(public * cn.com.antMap.tree.controller..(…))”)定義切面切入點(diǎn) 就是攔截這個(gè)包路徑下的所有請(qǐng)求的方法
@Before(“controllerMethod()”) 切入點(diǎn)調(diào)用邏輯之前進(jìn)行攔截
@AfterReturning(returning = “o”, pointcut = “controllerMethod()”) 切入點(diǎn)調(diào)用邏輯完成后進(jìn)行攔截輸出
@AfterThrowing(pointcut = “controllerMethod()”, throwing = “ex”) 切入點(diǎn)發(fā)生異常是進(jìn)行攔截

在這里插入圖片描述