java 日志打印（实战小记）

1.前言
 

前段时间上线的项目报错了，由于没有传参的参数日志打印，导致排查错误时一脸懵逼，不知道如何下手。

对于程序员来说，日志记录是重要的基本功。总结归纳记录后，自己在开发项目中记录日志的方法和最佳实践分享一下

2.实现

首先想到的就是“System.out.println” ，但是，ystem.out.println 是一个同步方法，每次调用都会导致 I/O 操作，比较耗时，频繁使用甚至会严重影响应用程序的性能，所以不建议在生产环境使用。

所以，简单的方式是使用 Lombok 工具库提供的 @Slf4j 注解，可以自动为当前类生成一个名为 log 的 SLF4J Logger 对象，简化了 Logger 的定义过程

由于每个接口都需要打印，所以为了简化代码量，采用AOP方式进行打印，话不多说直接上代码

import

import com.alibaba.fastjson2.JSONObject;
import eu.bitwalker.useragentutils.UserAgent;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
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.io.IOException;
import java.util.Map;
import java.util.Objects;


@Aspect
@Component
@Slf4j
public class LoggingAspect {

    private static final String START_TIME = "request-start";

    /**
     * 设置方法切入点
     */
    @Pointcut("execution(* com.edu.controller..*(..))")
    public void logging() {

    }


    /**
     * 前置操作
     *
     * @param joinPoint
     * 
     */
    @Before("logging()")
    public void logBeforeMethod(JoinPoint joinPoint) throws IOException {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
        Map<String, String[]> parameterMap = request.getParameterMap();
        StringBuffer sb = new StringBuffer();
        sb.append("\n【请求 URL】：").append(request.getRequestURL());
        sb.append("\n【请求 IP】：").append(getIp(request));
        sb.append("\n【请求类名】：").append(joinPoint.getSignature().getDeclaringTypeName());
        sb.append("\n【请求方法名】：").append(joinPoint.getSignature().getName());
        sb.append("\n【body】：").append(JSONObject.toJSONString(joinPoint.getArgs()));
        sb.append("\n【请求参数】：").append(JSONObject.toJSONString(parameterMap));
        Long start = System.currentTimeMillis();
        request.setAttribute(START_TIME, start);
        log.info(sb.toString());
    }

    /**
     * 环绕操作
     *
     * @param joinPoint 切入点
     * @return 
     * 
     */
    @Around("logging()")
    public Object aroundLog(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();

        // 执行目标方法（可修改参数）
        Object result = joinPoint.proceed();

        long endTime = System.currentTimeMillis();
        System.out.println("\n【方法执行耗时】: " + (endTime - startTime) + "ms");
        return result;
    }

    /**
     * 后置操作
     */
    @AfterReturning("logging()")
    public void afterReturning() {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
        StringBuffer sb = new StringBuffer();
        Long start = (Long) request.getAttribute(START_TIME);
        Long end = System.currentTimeMillis();
        sb.append("\n【请求耗时】：").append((end - start)).append("毫秒");

        String header = request.getHeader("User-Agent");
        UserAgent userAgent = UserAgent.parseUserAgentString(header);
        sb.append("\n【原始User-Agent】：").append(header);
        log.info(sb.toString());
    }

    /**
     * 获取请求的ip地址
     * @param request
     * @return
     */
    private String getIp(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }
        return ip;
    }

}

利用 AOP，还可以自动打印每个 service的请求参数和返回值，这样就不会错过任何一次调用信息了。

注意

不过这样做也有一个很危险的点，注意不要在日志中记录了敏感信息，比如用户密码。万一你的日志不小心泄露出去，就相当于泄露了用户信息。