使用AOP拦截所有请求并打印日志

使用AOP拦截所有请求并打印日志

导入依赖

        <!--spring aop -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

切面

package com.hsh.maoduo.aspect;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
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.CodeSignature;
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.LinkedHashMap;
import java.util.Objects;

@Aspect
@Component
@Slf4j
public class ControllerAspect {

    /**
     * 声明切点，后续使用时直接使用 controllerMethod() 即可
     * 等价于不声明直接使用  @Around( pointcut="execution( * com.hsh.maoduo.controller..*.*(..))")
     */
    @Pointcut("execution(* com.hsh.maoduo.controller..*.*(..))")
    public void controllerMethod() {
    }

    /**
     * 环绕通知
     * 输出 url，参数，返回等内容
     *
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("controllerMethod()")
    public Object aroundController(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        StringBuilder logInfo = new StringBuilder();
        logInfo.append(":\n");
        logInfo.append("========================================= Start ==========================================\n");
        //获得request
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
        // 记录请求url
        logInfo.append("-- URL       : ").append(request.getRequestURL()).append("\n");
        //参数
        logInfo.append("-- 请求参数   : ").append(getParams(proceedingJoinPoint)).append("\n");
        Object result;
        try {
            //对原始操作的调用
            result = proceedingJoinPoint.proceed();
        } catch (Exception e) {
            //异常时，将异常消息作为返回值打印出来，
            //也可以自定义response，设置返回码200，将异常作为成功访问返回前端
            result = e.getMessage() + "\n" + e.getStackTrace()[0].toString();
        }
        //返回结果
        logInfo.append("-- 返回结果   : ").append(JSON.toJSON(result)).append("\n");
        logInfo.append("========================================== End ===========================================\n");
        log.info(logInfo.toString());
        return result;
    }


    /**
     * 获取切点的参数
     *
     * @param joinPoint
     * @return Json格式的字符串
     */
    public String getParams(JoinPoint joinPoint) {
        LinkedHashMap<String, Object> map = new LinkedHashMap<>();
        CodeSignature signature = (CodeSignature) joinPoint.getSignature();
        String[] names = signature.getParameterNames();
        Object[] value = joinPoint.getArgs();
        for (int i = 0; i < names.length; i++) {
            map.put(names[i], value[i]);
        }
        return JSONObject.toJSONString(map);
    }
}

实体类Student

package com.hsh.maoduo.pojo.other;

import lombok.Data;

@Data
public class Student {
    private String id;

    private String name;
}

测试Controller

package com.hsh.maoduo.controller;

import com.hsh.maoduo.pojo.dto.GoodsDTO;
import com.hsh.maoduo.pojo.entity.Goods;
import com.hsh.maoduo.pojo.other.Student;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * @Author hsh
 * @DateTime 2023/08/29 17:39
 **/
@RestController
public class TestRestController {


    @GetMapping("/test")
    public String test(Student student) throws Exception{
        if (student.getId() == null){
            throw new Exception("异常----学生id为空");
        }
        return "测试返回----"+student.getId()+"----"+student.getName();
    }

}

测试结果