aop统一打印请求内容

朱雀 2022-01-21 06:19 276阅读 0赞

参考[这篇文章][Link 1]

其实也就是通过aop来封装打印请求的内容，不用每次都手打印。

我之前也会遇到一个问题，就是debug的时候都不知道前端传来参数是什么，只能System.out.println去打印，debug

pom.xml

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
            
    
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>2.8.5</version>
            </dependency>

定义注解

@Target({ElementType.PARAMETER, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface PrintLog {
    
    }

通过aop实现注解

import com.google.gson.Gson;
    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.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.context.annotation.Profile;
    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.Enumeration;
    import java.util.HashMap;
    import java.util.Map;
    
    @Component
    @Aspect
    @Slf4j
    @Profile({"dev","test"})
    public class SystemLogAspect {
    
        @Pointcut("@annotation(com.example.demo.aop.PrintLog)")
        public void PrintLog() {
        }
    
        @Around("PrintLog()")
        public Object around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
            long time = System.nanoTime();
            Object result = proceedingJoinPoint.proceed();
            log.info("返回参数：" + new Gson().toJson(result));
            long time1 = System.nanoTime();
            log.info("耗时：" + (time1 - time) + "纳秒");
            return result;
        }
    
        @Before("PrintLog()")
        public void doBefore(JoinPoint joinPoint) {
            ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = servletRequestAttributes.getRequest();
            log.info("请求路径：" + request.getRequestURL().toString());
            //log.info("请求ip：" + request.getRemoteAddr());
            log.info("请求方法：{},{}",joinPoint.getSignature().getDeclaringTypeName(),joinPoint.getSignature().getName());
            Enumeration pNames = request.getParameterNames();
            Map map = new HashMap();
            while (pNames.hasMoreElements()) {
                String key = pNames.nextElement().toString();
                String result = request.getParameter(key);
                map.put(key, result);
            }
            log.info("请求参数：" + new Gson().toJson(map));
        }

可以看到around处理的是返回结果，还有计算时间

before的是打印require的参数等等

最后是配置开发环境，一般生产环境是不打印这些的。

@Profile({"dev","test"})

application.properties

spring.profiles.active=test

通过这个参数配置环境配置

操作

@RestController
    public class LogController {
    
        @RequestMapping("log")
        @PrintLog
        public String getLock(@RequestParam("id") int id,@RequestParam("name") int name){
            System.out.println("执行业务...");
            return "success";
        }
    
    }

控制台输出

2019-06-08 16:19:47.270  INFO 9668 --- [nio-8080-exec-1] c.example.demo.aop.impl.SystemLogAspect  : 请求路径：http://localhost:8080/log
    2019-06-08 16:19:47.270  INFO 9668 --- [nio-8080-exec-1] c.example.demo.aop.impl.SystemLogAspect  : 请求ip：0:0:0:0:0:0:0:1
    2019-06-08 16:19:47.272  INFO 9668 --- [nio-8080-exec-1] c.example.demo.aop.impl.SystemLogAspect  : 请求参数：{"name":"123","id":"1"}
    执行业务...
    2019-06-08 16:19:47.275  INFO 9668 --- [nio-8080-exec-1] c.example.demo.aop.impl.SystemLogAspect  : 返回参数："success"
    2019-06-08 16:19:47.275  INFO 9668 --- [nio-8080-exec-1] c.example.demo.aop.impl.SystemLogAspect  : 耗时：5385280毫秒

[Link 1]: https://mp.weixin.qq.com/s?__biz=MzA3ODQ0Mzg2OA==&mid=2649049700&idx=1&sn=bdf966758028aabe2d264ac6e9deb2f7&chksm=87534e57b024c741cf762b3b048606e1ebbfa10f8db3f3825fa8248dac2c5a379e4617181558&scene=0&xtrack=1#rd