如何利用AOP切面编程来记录方法的调用日志

只要有人调用接口,就记录日志,那么就需要使用AOP(切面编程),只对代码进行增强,不改变原有的东西。

如何利用AOP开启日志记录功能?

只需要写一个配置文件即可,不需要其他的操作

package com.powernode.aspect;

import cn.hutool.core.util.ObjectUtil;
import com.alibaba.fastjson.JSONObject;
import io.swagger.annotations.ApiOperation;
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.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;

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

/**
 * 记录系统操作日志AOP
 */
@Component
@Aspect
@Slf4j
public class SysLogAspect {

    /**
     * 切入点表达式
     * 解释 * com.powernode.controller.*.*(..)
     * 表示com.powernode.controller下的所有方法
     * 当controller包下的方法被调用时,会自动触发这个日志记录功能
     */
    public static final String POINT_CUT = "execution (* com.powernode.controller.*.*(..))";

    @Around(value = POINT_CUT)
    public Object logAround(ProceedingJoinPoint joinPoint) {
        Object result = null;
        // 获取请求对象
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        // 获取请求路径
        String path = request.getRequestURI();
        // 获取ip地址
        String remoteHost = request.getRemoteHost();
        // 获取请求参数
        Object[] args = joinPoint.getArgs();
        // 获取请求方法
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        String methodName = method.toString();
        // 获取目标方法上的ApiOperation注解
        ApiOperation apiOperation = method.getDeclaredAnnotation(ApiOperation.class);
        // 判断该注解对象是否为空
        String operation = "";
        if (ObjectUtil.isNotNull(apiOperation)) {
            // 获取apiOperation注解的描述
            operation = apiOperation.value();
        }

        String finalArgs = "";
        // 判断参数类型
        if (ObjectUtil.isNotNull(args) && args.length != 0 && args[0] instanceof MultipartFile) {
            // 说明当前参数为文件对象
            finalArgs = "file";
        } else {
            // 将参数对象转换为json格式的字符串
            finalArgs = JSONObject.toJSONString(apiOperation);
        }

        // 记录开始时间
        long startTime = System.currentTimeMillis();
        try {
            // 执行方法
            result = joinPoint.proceed(args);
        } catch (Throwable e) {
            throw new RuntimeException(e);
        }
        // 记录结束时间
        long endTime = System.currentTimeMillis();

        // 方法执行时长
        long execTime = endTime - startTime;


        log.info("调用时间:{},请求接口路径:{},请求IP地址:{},方法名称:{},执行时长:{},方法描述:{}",
                new Date(),
                path,
                remoteHost,
                methodName,
                execTime,
                operation);

        return result;
    }
}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值