一套高可用的spring AOP controller 层请求日志记录方法

骑猪看日落 2022-04-02 15:18 143阅读 0赞

### 文章目录 ###

*   *  1 摘要
     *  2 核心代码
     *  3 注意事项
     *  4 测试效果
     *   *  4.1 get 请求
         *  4.2 POST请求,json格式
         *  4.3 post方式请求,key=value参数
         *  4.4 POST方式请求,\`@PathVariable\` 与 \`@RequestBody\` 混合
         *  4.5 POST 文件上传
         *  4.6 文件下载
     *  5 Github 源码

## 1 摘要 ##

关于使用Spring AOP 做日志记录是java 后台一种常用的日志记录方案，作者也参考了网上的很多方案,但是在实际的操作中还是遇到了一些问题:

*  POST 方式请求不能同时获取到 body 里边的 json 格式参数和常规的 parameter 中参数
 *  文件上传与下载不是抛错就是把整个文件都打印出来了

针对以上情况,作者对 AOP 的日志记录方式进行了整理

## 2 核心代码 ##

切点类代码:  
`com.ljq.demo.springboot.web.acpect.LogAspect` 类

package com.ljq.demo.springboot.web.acpect;
    
    import com.fasterxml.jackson.annotation.JsonAutoDetect;
    import com.fasterxml.jackson.annotation.PropertyAccessor;
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.SerializationFeature;
    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.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    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.Map;
    import java.util.UUID;
    
    /** * @Description: 日志记录切点 * @Author: junqiang.lu * @Date: 2018/11/1 */
    @Aspect
    @Component
    public class LogAspect { 
    
        private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);
    
        /** * controller 层切点 */
        @Pointcut("execution(* com.ljq.demo.springboot.web.controller..*.*(..))")
        public void controllerPointcut() { 
        }
    
        /** * controller 层出入参日志记录 * * @param joinPoint 切点 * @return */
        @Around(value = "controllerPointcut()")
        public Object controllerLogAround(ProceedingJoinPoint joinPoint) throws Throwable { 
            /** * 获取 request 中包含的请求参数 */
            String uuid = UUID.randomUUID().toString();
            HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
            /** * 获取切点请求参数(class,method) */
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            String params = getRequestParams(request, joinPoint);
    
            /** * 入参日志 */
            logger.info("[AOP-LOG-START]\n\trequestMark: {}\n\trequestIP: {}\n\tcontentType:{}\n\trequestUrl: {}\n\t" +
                    "requestMethod: {}\n\trequestParams: {}\n\ttargetClassAndMethod: {}#{}", uuid, request.getRemoteAddr(),
                    request.getHeader("Content-Type"),request.getRequestURL(), request.getMethod(), params,
                    method.getDeclaringClass().getName(), method.getName());
            /** * 出参日志 */
            Object result = joinPoint.proceed();
            logger.info("[AOP-LOG-END]\n\t{}", result);
            return result;
        }
    
        /** * 获取请求参数 * * @param request * @param joinPoint * @return */
        private String getRequestParams(HttpServletRequest request, ProceedingJoinPoint joinPoint) throws JsonProcessingException { 
            StringBuilder params = new StringBuilder();
            if ("GET".equalsIgnoreCase(request.getMethod())) { 
                params.append(request.getQueryString());
            }
            if ("POST".equalsIgnoreCase(request.getMethod())) { 
                /** * 获取 request parameter 中的参数 */
                Map<String,String[]> parameterMap = request.getParameterMap();
                if (parameterMap != null && !parameterMap.isEmpty()) { 
                    for (Map.Entry<String, String[]> entry : parameterMap.entrySet()) { 
                        params.append(entry.getKey() + " = " + entry.getValue()[0] + ";");
                    }
                }
                /** * 获取非 request parameter 中的参数 */
                Object[] objects = joinPoint.getArgs();
                for (Object arg : objects) { 
                    if (arg == null) { 
                        break;
                    }
                    String className = arg.getClass().getName().toLowerCase();
                    String contentType = request.getHeader("Content-Type");
                    /** * 文件参数,上传文件信息 */
                    if (className.contains("MultipartFile".toLowerCase())) { 
                        MultipartFile multipartFile = (MultipartFile) arg;
                        params.append("fileSize = " + multipartFile.getSize() + ";");
                        params.append("fileContentType = " + multipartFile.getContentType() + ";");
                        params.append("fieldName = " + multipartFile.getName() + ";");
                        params.append("fileOriginalName = " + multipartFile.getOriginalFilename() + ";");
                    }
                    if (contentType != null && contentType.contains("application/json")){ 
                        /** * json 参数 */
                        ObjectMapper mapper = new ObjectMapper();
                        mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
                        mapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
                        params.append(mapper.writeValueAsString(arg));
                    }
                }
            }
            return params.toString();
        }
    
    
    }

## 3 注意事项 ##

说明:

Object[] objects = joinPoint.getArgs();

这种方式获取的参数只能获取到 `POST` 请求的 `body`中的参数,不能获取到请求头中使用 key=value 方式拼接的参数

Map<String,String[]> parameterMap = request.getParameterMap();

这种方式能够获取到 `GET/POST` 请求中 `paramter` 中的参数,即在请求头中使用 key=value方式拼接的参数,不能获取到`body` 中的参数

**实际的项目中会有这样的场景: 使用 `POST` 请求方式,但是值却用 key=value 的方式传递,而非都在 `body` 中**

针对文件 上传/下载 的日志记录,如果不做单独处理,会将整个文件输出到日志,这样会导致日志文件异常巨大

## 4 测试效果 ##

代码行不行,直接看效果

### 4.1 get 请求 ###

请求参数:

![GET方式请求参数与返回结果][GET]

日志记录:

![GET方式请求日志][GET 1]

### 4.2 POST请求,json格式 ###

请求参数:  
![POST-json格式参数请求][POST-json]

日志记录:

![POST-json格式请求日志][POST-json 1]

### 4.3 post方式请求,key=value参数 ###

请求参数:

![POST-Key=Value方式请求参数与返回结果][POST-Key_Value]

日志记录:

![POST-key=value方式请求日志][POST-key_value]

### 4.4 POST方式请求,`@PathVariable` 与 `@RequestBody` 混合 ###

请求参数:

![POST混合方式请求参数与返回结果][POST]

日志记录:

![POST混合方式请求日志][POST 1]

### 4.5 POST 文件上传 ###

请求参数:

![POST文件上传请求参数与返回结果][POST 2]

日志记录:

![POST文件上传请求日志][POST 3]

### 4.6 文件下载 ###

请求参数:

![文件下载请求参数与返回文件][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01ycWlhbmc5MDAx_size_16_color_FFFFFF_t_70]

日志记录:

![文件现在请求日志][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01ycWlhbmc5MDAx_size_16_color_FFFFFF_t_70 1]

至此,项目中常用的请求方式都已经测试过了,文章最初提到的两个问题也得到了解决。

## 5 Github 源码 ##

**Github源码地址**: [https://github.com/Flying9001/springBootDemo/blob/master/demo-web/src/main/java/com/ljq/demo/springboot/web/acpect/LogAspect.java][https_github.com_Flying9001_springBootDemo_blob_master_demo-web_src_main_java_com_ljq_demo_springboot_web_acpect_LogAspect.java]

个人公众号:**404Code**,分享半个互联网人的技术与思考，感兴趣的可以关注.  
![404Code][]

[GET]: /images/20220402/797bee703de745128d859e941d348209.png
[GET 1]: /images/20220402/53d07386e756406a8289151e532d76bb.png
[POST-json]: /images/20220402/105f9115319d4f05bb133978b4b1b8da.png
[POST-json 1]: /images/20220402/fa873c5402e440bb955d78f526661ba4.png
[POST-Key_Value]: /images/20220402/1a0f3bc96b554a8aac277a1147df3630.png
[POST-key_value]: /images/20220402/37bc2b8bb1d54170b1bfbb90d572bdb5.png
[POST]: /images/20220402/36d21c5007be44588073d1479d0ab83c.png
[POST 1]: /images/20220402/da721c23ca294c8cb23bf2cc6098f9ad.png
[POST 2]: /images/20220402/72f5adbeffb4485bbcad89aae5bf7a11.png
[POST 3]: /images/20220402/d9dac99dde0b4166a8dd86339b118f40.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01ycWlhbmc5MDAx_size_16_color_FFFFFF_t_70]: /images/20220402/206a6add98a842ef84765107db1e753b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01ycWlhbmc5MDAx_size_16_color_FFFFFF_t_70 1]: /images/20220402/0c45132a8a514e1b9fdfc82e53f510f8.png
[https_github.com_Flying9001_springBootDemo_blob_master_demo-web_src_main_java_com_ljq_demo_springboot_web_acpect_LogAspect.java]: https://github.com/Flying9001/springBootDemo/blob/master/demo-web/src/main/java/com/ljq/demo/springboot/web/acpect/LogAspect.java
[404Code]: /images/20220402/6f14872f02c44da2b6b4dd2cdf2c70d1.png