springboot AOP 日志，注解输出一

后台开发人员在开发时喜欢将日志级别设置为debug模式，便于日志输出和调试

但是面对下图这样的日志，好多人还是看着不太习惯，感觉不太清晰

下面本人在做项目的时候看到了比较好的日志输出，他很好的规范了接口，参数等输出，以下内容只用记录，非原创

简单加入各一个文件即可

package com.*****.config.auth;

import com.*****.controller.wechatpay.weixinpay.util.IpAddressUtil;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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 java.util.Arrays;

@Aspect
@Component
public class WebLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

//****表示这里针对项目名称进行了隐藏
//两个..代表所有子目录，最后括号里的两个..代表所有参数
//本人由于其他文件夹干扰所以拆分了路径；如果controller下的文件均需要输出日志则改为

//@Pointcut("execution( * com.***.controller..*.*(..))")

@Pointcut("execution( * com.****.controller.app.*.*(..)) ||

 " + "execution(* com.****.controller.client.*.*(..)) ||

" + "execution(* com.*****.controller.shop.*.*(..)) ||" 
+ "execution(* com.******.controller.manager.*.*(..))")
    public void logPointCut() {
    }

    @Before("logPointCut()")
    public void doBefore(JoinPoint joinPoint){
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        logger.info("请求地址 : " +request.getRequestURL().toString());
        logger.info("HTTP METHOD : " + request.getMethod());
        // 获取真实的ip地址
        logger.info("IP : " + IpAddressUtil.getIpAddr(request));
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                + joinPoint.getSignature().getName());
        logger.info("参数 : " + Arrays.toString(joinPoint.getArgs()));
    }
    @AfterReturning(returning = "ret", pointcut = "logPointCut()")// returning的值和doAfterReturning的参数名一致
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容(返回值太复杂时，打印的是物理存储空间的地址)
        logger.debug("返回值 : " + ret);
    }

    @Around("logPointCut()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object ob = pjp.proceed();// ob 为方法的返回值
        logger.info("耗时 : " + (System.currentTimeMillis() - startTime));
        return ob;
    }
}

ip获取工具文件

package com.****.util;

import javax.servlet.http.HttpServletRequest;

public class IpAddressUtil
{
    public static String getIpAddr(HttpServletRequest request)
    {
        if (request.getHeader("x-forwarded-for") == null)
        {
            return request.getRemoteAddr();
        }
        return request.getHeader("x-forwarded-for");
    }

    public static String formatIpAddr(HttpServletRequest request)
    {
        String ips = getIpAddr(request);
        if (ips.indexOf(",") != -1)
        {
            return ips.split(",")[0];
        }
        else
        {
            return ips;
        }
    }
}

　　这样控制台输出的结果为

这样更利用开发人员排查问题，很容易定位到调用接口，方法和参数，以及请求方的IP

springboot AOP 日志，注解输出一

猜你喜欢