AOP日志功能实现

转载自b站：码神之路

1、添加两个工具类

HttpContextUtils

用于获取当前请求的 HttpServletRequest 对象，以便在 Spring等环境中，进行一些基于HTTP 请求的操作。

package com.example.demo.utils;

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;


import javax.servlet.http.HttpServletRequest;

public class HttpContextUtils {
    
    
    public static HttpServletRequest getHttpServletRequest() {
    
    
        return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
    }

}

IpUtils

该工具类用于实现了获取客户端 IP 地址的功能，在具体开发中可用于统计或记录用户访问日志等需求场景。

在使用反向代理软件（如 Nginx 等）时，调用 HttpServletRequest 的 getRemoteAddr() 方法无法准确获取客户端的 IP 地址，因此需要通过解析 HTTP 请求头中的一些字段信息来近似地确定用户的 IP 地址。

package com.example.demo.utils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;

import javax.servlet.http.HttpServletRequest;

/****
 * 从http请求中获取ip地址
 * @ClassName: IPUtils
 */
public class IpUtils {
    
    

    private static Logger logger = LoggerFactory.getLogger(IpUtils.class);

    /**
     * 获取IP地址
     * 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
     * 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
     */
    public static String getIpAddr(HttpServletRequest request) {
    
    
        String ip = null;
        try {
    
    
            ip = request.getHeader("x-forwarded-for");
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
    
    
                ip = request.getHeader("Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
    
    
                ip = request.getHeader("WL-Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
    
    
                ip = request.getHeader("HTTP_CLIENT_IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
    
    
                ip = request.getHeader("HTTP_X_FORWARDED_FOR");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
    
    
                ip = request.getRemoteAddr();
            }
        } catch (Exception e) {
    
    
            logger.error("IPUtils ERROR ", e);
        }
        // 使用代理，则获取第一个IP地址
        if (StringUtils.isEmpty(ip) && ip.length() > 15) {
    
    
            if (ip.indexOf(",") > 0) {
    
    
                ip = ip.substring(0, ip.indexOf(","));
            }
        }
        return ip;
    }
}

2、新建一个接口为 LogAnnotation

这段代码实现了一个自定义的注解 @LogAnnotation，可用于标识需要记录日志的目标方法。该注解在声明时指定模块和操作人员信息。

• @Target：表示该注解可以放置在哪些地方，此处说明可以放在类或者方法上。
• @Retention：表示该注解保留的阶段，此处设为运行时。
• @Documented：表示该注解会生成到文档中。
• module()：表示所属模块的描述信息。
• operator()：表示执行的具体操作。

在使用该注解时，只需要在需要进行记录日志的目标方法上，添加
@LogAnnotation(module="xxx",operator="xxx") 注解即可根据注解中的信息进行日志的记录。

实现了一个自定义的用于标识需要记录日志的注解@LogAnnotation，可以通过其快速标识方法所属模块和操作人员信息，从而提高程序开发与维护的效率。

LogAnnotation

package com.example.demo.common.aop;

import java.lang.annotation.*;
//Type 代表可以放在类上面  Methon代表可以放在方法上
@Target({
    
    ElementType.TYPE_USE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {
    
    
    String module() default "";
    String operator() default "";
}

3、新建一个类 LogAspect

这段代码实现了一个基于 AOP 的日志记录器，将记录方法执行的耗时、操作人员、请求参数和返回结果等。

通过在方法上添加 @LogAnnotation注解，指示需要进行日志记录。在记录日志时，该工具类访问方法签名、注解信息搜集，并保存请求参数与响应结果。通过HttpServletRequest获取IP地址，并使用ipUtils获取真实访问者IP地址，最终打印日志信息。

总之，这段代码可以用于较方便地为系统中的各个模块统计操作数据、调查异常情况等。同时，由于能够记录下参数、访问时间等，有助于后期分析性能瓶颈或优化调整工作。

LogAspect

package com.example.demo.common.aop;

import com.alibaba.fastjson.JSON;
import com.example.demo.utils.HttpContextUtils;
import com.example.demo.utils.IpUtils;
import lombok.extern.slf4j.Slf4j;
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.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;

@Component
@Aspect //切面 定义了通知和切点的关系
@Slf4j
public class LogAspect {
    
    

    @Pointcut("@annotation(com.example.demo.common.aop.LogAnnotation)")
    public void pt(){
    
    
    }

    //环绕通知
    @Around("pt()")
    public Object log(ProceedingJoinPoint point) throws Throwable {
    
    
        long beginTime = System.currentTimeMillis();
        //执行方法
        Object result = point.proceed();
        //执行时长(毫秒)
        long time = System.currentTimeMillis() - beginTime;
        //保存日志
        recordLog(point, time);
        return result;

    }

    private void recordLog(ProceedingJoinPoint joinPoint, long time) {
    
    
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        LogAnnotation logAnnotation = method.getAnnotation(LogAnnotation.class);
        log.info("=====================log start================================");
        log.info("module:{}",logAnnotation.module());
        log.info("operation:{}",logAnnotation.operator());

        //请求的方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        log.info("request method:{}",className + "." + methodName + "()");

        //请求的参数
        Object[] args = joinPoint.getArgs();
        String params = JSON.toJSONString(args[0]);
        log.info("params:{}",params);

        //获取request 设置IP地址
        HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
        log.info("ip:{}", IpUtils.getIpAddr(request));


        log.info("excute time : {} ms",time);
        log.info("=====================log end================================");
    }

}

4、使用自定义注解 @LogAnnotation

在需要实现日志功能的方法上添加注解@LogAnnotation（module为名字，operator为方法的操作名称）

@LogAnnotation(module="用户",operator="获取用户列表")

5、运行结果

6、项目结构