快捷導(dǎo)航

java通過(guò)AOP實(shí)現(xiàn)全局日志打印詳解

更新時(shí)間：2022年01月18日 15:18:57 作者：小小張自由—>張有博

最近自己一直再看現(xiàn)有微服務(wù)的日志模塊,發(fā)現(xiàn)就是使用AOP來(lái)做controller層的日志處理,加上項(xiàng)目在進(jìn)行架構(gòu)優(yōu)化,這篇文章主要給大家介紹了關(guān)于java通過(guò)AOP實(shí)現(xiàn)全局日志打印的相關(guān)資料,需要的朋友可以參考下

幾個(gè)常用的切點(diǎn)注解，這次使用了@Before和@Around

1.@Before 前置增強(qiáng)（目標(biāo)方法執(zhí)行之前，執(zhí)行注解標(biāo)注的內(nèi)容）

2.@AfterReturning 后置增強(qiáng)（目標(biāo)方法正常執(zhí)行完畢后，執(zhí)行）

3.@Around 環(huán)繞增強(qiáng)（目標(biāo)方法執(zhí)行前后，分別執(zhí)行一些代碼）

4.@AfterThrowing 拋出增強(qiáng)（目標(biāo)方法發(fā)生異常，執(zhí)行）

5.@After Final增強(qiáng)（不管是拋出異常還是正常退出，該增強(qiáng)都會(huì)得到執(zhí)行。一般用于釋放資源，相當(dāng)于try{}finally{}）。

切Controller打印請(qǐng)求的接口、參數(shù)、返回值以及耗時(shí)情況。

package com.tfjy.arbackend.aop;
 
import com.alibaba.fastjson.JSONObject;
import com.tfjy.arbackend.util.FrontResult;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.List;
 
/**
 * 使用AOP切Controller打印日志
 *
 * @author Promsing(張有博)
 * @version 1.0.0
 * @since 2021/12/5 - 21:09
 */
@Aspect
@Component
public class RestAopConfig {
    /**
     * 控制是否開(kāi)啟日志
     */
    public static Boolean onOff = false;
    private static Log logger = LogFactory.getLog(RestAopConfig.class);
    @Pointcut("execution(public * com.tfjy.arbackend.controller..*.*(..))")
    public void pointCutRestDef(){
    }
    
    //環(huán)繞切點(diǎn)
    @Around("pointCutRestDef()")
    public Object processRst(ProceedingJoinPoint point) throws Throwable{
        Object returnValue = null;
        final List<Object> params = new ArrayList<>();
        //獲得請(qǐng)求信息
        ServletRequestAttributes sra  =(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
        if(sra==null){
            return point.proceed();
        }
        HttpServletRequest request = sra.getRequest();
        Object[] args = point.getArgs();
        //過(guò)濾出HttpServlet
        for (int i = 0; i < args.length; i++) {
            Object object = args[i];
            if (object instanceof HttpServletResponse){
                continue;
            }
            if (object instanceof HttpServletRequest){
                continue;
            }
            params.add(object);
        }
        logger.info(
                "rest method:——>"+point.getSignature().getDeclaringTypeName()+"."+point.getSignature().getName());
        String cloneParams = JSONObject.toJSONString(params);
        logger.info("rest param:——>"+cloneParams);
        long startTime = System.currentTimeMillis();
        //去執(zhí)行方法，這里的異常交給統(tǒng)一捕獲異常去處理
        returnValue = point.proceed(point.getArgs());
        //處理返回值
        if (returnValue instanceof FrontResult){
            FrontResult frontResult=(FrontResult)returnValue;
            logger.info("rest response:——>"+frontResult.toString());
        }
        long endTime = System.currentTimeMillis();
        logger.info("rest"+request.getRequestURI()+"----used time----"+(endTime - startTime));
        Boolean boolean1 =true;
        if (returnValue != null && !returnValue.equals(boolean1)){
            logger.info(JSONObject.toJSONString(returnValue));
        }
        return  returnValue;
    }
}

切Service打印日志，URL，請(qǐng)求方式，IP，類名，方法

package com.tfjy.arbackend.aop;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
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;
/**
 * 使用AOP切Service打印日志
 *
 * @author Promsing(張有博)
 * @version 1.0.0
 * @since 2021/12/5 - 21:09
 */
@Aspect    //注解將一個(gè)java類定義為切面類
@Component
public class AopGetService {
    private static Log logger = LogFactory.getLog(AopGetService.class);
    /*使用@Pointcut定義一個(gè)切入點(diǎn)，可以是一個(gè)規(guī)則表達(dá)式，比如下例中某個(gè)package下的所有函數(shù)，也可以是一個(gè)注解等。
        根據(jù)需要在切入點(diǎn)不同位置的切入內(nèi)容*/
    @Pointcut("execution(public * com.tfjy.arbackend.service..*.*(..))")//切入點(diǎn)描述 這個(gè)是service包的切入點(diǎn)
    public void getServiceJournal() {
    }//簽名，可以理解成這個(gè)切入點(diǎn)的一個(gè)名稱
    
    //前置切點(diǎn)
    @Before("getServiceJournal()")//在切入點(diǎn)開(kāi)始處切入內(nèi)容
    public void logBeforeService(JoinPoint joinPoint) {
        // 接收到請(qǐng)求，記錄請(qǐng)求內(nèi)容
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        if(requestAttributes==null){
             return ;
        }
        HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
        // 記錄下請(qǐng)求內(nèi)容
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + request.getMethod());
        logger.info("IP : " + request.getRemoteAddr());
        //下面這個(gè)getSignature().getDeclaringTypeName()是獲取包+類名的   然后后面的joinPoint.getSignature.getName()獲取了方法名
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
    }
}