使用Aop的方式实现自动日志记录

长头发的程序猿

已于 2023-11-13 20:37:53 修改

阅读量2k

点赞数 2

文章标签： spring aop

于 2023-03-20 19:43:04 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_55076626/article/details/129674377

版权

该文章展示了如何在Java中创建一个自定义注解用于日志记录，并通过SpringAOP实现切面类，进行环绕通知，记录方法的执行时间、模块、操作、参数以及请求IP等信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、自定义一个注解

允许注解在方法和类上添加：

import java.lang.annotation.*;
 
/**
 * 日志注解
 */
 //ElementType.TYPE代表可以放在类上面  method代表可以放在方法上
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {
 
    String module() default "";
 
    String operation() default "";
}

以下注解在接口上添加：

2、编写日志记录切面类

2.1、先编写一个pt方法，此方法结合了上面自定义的注解：

2.2、然后编写log方法，对加了LogAnnotation注解的类或者方法实现环绕通知：

2.3、最后完善redcordlog方法来记录日志，并在控制台输出相关记录的日志：

完整代码：

import com.alibaba.fastjson.JSON;
import com.mszlu.blog.utils.HttpContextUtils;
import com.mszlu.blog.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;
 
/**
 * @Author ljm
 * @Date 2021/10/18 21:01
 * @Version 1.0
 */
@Component
@Aspect //切面 定义了通知和切点的关系
@Slf4j
public class LogAspect {
 
    @Pointcut("@annotation(com.mszlu.blog.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.operation());
 
        //请求的方法名
        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================================");
    }
 
}

redcordlog方法包含了两个工具类（用来获取当前接口ip地址的），如下：

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
import javax.servlet.http.HttpServletRequest;
 
/**
 * HttpServletRequest
 *
 */
public class HttpContextUtils {
 
    public static HttpServletRequest getHttpServletRequest() {
        return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
    }
 
}