【第17章】spring-mvc之日志和拦截器

文章目录

前言
一、整合log4j
- 1. 引入库
- 2. log4j2.xml
二、拦截器
- 1.拦截器类
- 2.注册拦截器
三、过滤器和拦截器顺序
总结

前言

【第2章】整合log4j2框架

在前面的spring中已经完成了对日志框架log4j的整合，这里我们直接拿过来用就行。

场景描述：每个接口请求过来的时候，我们需要记录下请求报文和响应报文作为日志留痕或者提供给日志系统来做下一步处理的依据。

一、整合log4j

1. 引入库

<!-- log4j2 -->
<dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-core</artifactId>
   <version>2.19.0</version>
</dependency>
<dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-slf4j2-impl</artifactId>
   <version>2.19.0</version>
</dependency>

2. log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="WARN" monitorInterval="30">
    <Properties>
        <Property name="LOG_HOME">../logs/</Property>
        <!--_TRACE_ID，业务自定义变量-->
        <property name="ALL_PATTERN">[%d{yyyy-MM-dd HH:mm:ss.SSS}][%t][%p]- %l - %m%n</property>
        <property name="CHARSET">UTF-8</property>
        <property name="FILE_SIZE">1GB</property>
        <property name="FILE_INDEX_MAX">30</property>
    </Properties>
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${ALL_PATTERN}"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="${LOG_HOME}/spring-first.log" append="false">
            <PatternLayout pattern="${ALL_PATTERN}"/>
        </File>
        <!-- 这个会打印出所有的debug及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileDebug" fileName="${LOG_HOME}/debug.log"
                     filePattern="${LOG_HOME}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${ALL_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/info.log"
                     filePattern="${LOG_HOME}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${ALL_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
        <RollingFile name="RollingFileError" fileName="${LOG_HOME}/error.log"
                     filePattern="${LOG_HOME}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${ALL_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <logger name="org.springframework" level="DEBUG"></logger>
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileDebug"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>
</configuration>

二、拦截器

1.拦截器类

package org.example.springmvc.params.controller.interceptor;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.log4j.Log4j2;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import java.util.Arrays;

/**
 * Create by zjg on 2024/5/3
 */
@Log4j2
public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(handler instanceof HandlerMethod handlerMethod){
            log.debug("preHandle:method[{}],parameters[{}]",handlerMethod.getMethod(),Arrays.toString(handlerMethod.getMethodParameters()));
        }
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if(handler instanceof HandlerMethod handlerMethod){
            log.debug("postHandle:method[{}],response[status:{}]",handlerMethod.getMethod(),response.getStatus());
        }
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.debug("afterCompletion:"+ex);
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
    @ControllerAdvice
    public static class SystemResponseBodyAdvice implements ResponseBodyAdvice<Object> {

        @Override
        public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
            return true;
        }

        @Override
        public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
            log.debug("beforeBodyWrite:method[{}],response[body:{}]",returnType.getMethod(),body);
            return body;
        }
    }
}

2.注册拦截器

package org.example.springmvc.config;

import com.alibaba.fastjson2.JSONReader;
import com.alibaba.fastjson2.JSONWriter;
import com.alibaba.fastjson2.support.config.FastJsonConfig;
import com.alibaba.fastjson2.support.spring6.http.converter.FastJsonHttpMessageConverter;
import org.example.springmvc.converters.custom.RequestConverter;
import org.example.springmvc.params.controller.interceptor.LogInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Create by zjg on 2024/4/27
 */
@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        List<String> patterns=new ArrayList<>();
        patterns.add("/**");//匹配所有请求
        //白名单:为防止请求接口涉及到用户私密信息,禁止打印日志或者脱敏后打印处理
        List<String> whitelist=new ArrayList<>();
        whitelist.add("/hello-*");
        whitelist.add("/rest/*");
        whitelist.add("/ajax04");
        registry.addInterceptor(new LogInterceptor()).addPathPatterns(patterns).excludePathPatterns(whitelist);
        WebMvcConfigurer.super.addInterceptors(registry);
    }
}

三、过滤器和拦截器顺序

在这里插入图片描述

RequestFilter-before
[2024-05-04 11:06:20.104][http-nio-8080-exec-7][DEBUG]- org.springframework.core.log.LogFormatUtils.traceDebug(LogFormatUtils.java:120) - GET “/ajax01?name=%E5%BC%A0%E4%B8%89”, parameters={masked}
[2024-05-04 11:06:20.107][http-nio-8080-exec-7][DEBUG]- org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandler(AbstractHandlerMapping.java:531) - Mapped to org.example.springmvc.params.controller.AjaxController#ajax01(String)
[2024-05-04 11:06:20.110][http-nio-8080-exec-7][DEBUG]- org.example.springmvc.params.controller.interceptor.LogInterceptor.preHandle(LogInterceptor.java:26) - preHandle:method[public java.lang.String org.example.springmvc.params.controller.AjaxController.ajax01(java.lang.String)],parameters[[method ‘ajax01’ parameter 0]]
张三
[2024-05-04 11:06:20.164][http-nio-8080-exec-7][DEBUG]- org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:275) - Using ‘application/json’, given [/] and supported [application/json]
[2024-05-04 11:06:20.164][http-nio-8080-exec-7][DEBUG]- org.example.springmvc.params.controller.interceptor.LogInterceptor$SystemResponseBodyAdvice.beforeBodyWrite(LogInterceptor.java:54) - beforeBodyWrite:method[public java.lang.String org.example.springmvc.params.controller.AjaxController.ajax01(java.lang.String)],response[body:张三]
[2024-05-04 11:06:20.166][http-nio-8080-exec-7][DEBUG]- org.springframework.core.log.LogFormatUtils.traceDebug(LogFormatUtils.java:120) - Writing [“张三”]
[2024-05-04 11:06:20.511][http-nio-8080-exec-7][DEBUG]- org.example.springmvc.params.controller.interceptor.LogInterceptor.postHandle(LogInterceptor.java:34) - postHandle:method[public java.lang.String org.example.springmvc.params.controller.AjaxController.ajax01(java.lang.String)],response[status:200]
[2024-05-04 11:06:20.511][http-nio-8080-exec-7][DEBUG]- org.example.springmvc.params.controller.interceptor.LogInterceptor.afterCompletion(LogInterceptor.java:41) - afterCompletion:null
[2024-05-04 11:06:20.512][http-nio-8080-exec-7][DEBUG]- org.springframework.web.servlet.FrameworkServlet.logResult(FrameworkServlet.java:1138) - Completed 200 OK
RequestFilter-after

总结

回到顶部

以下是过滤器和拦截器的主要区别，以表格形式列出：

特性	过滤器（Filter）	拦截器（Interceptor）
触发时机	1. 请求进入容器后，但在请求进入Servlet之前进行预处理。	1. 在请求到达Controller之前或响应返回视图之前进行拦截。
依赖	1. 依赖于Servlet容器，是Servlet规范的一部分。	1. 依赖于Spring框架，是Spring MVC的一部分。
范围	1. 可以拦截请求和响应的所有内容，包括静态资源和动态资源。	1. 仅能拦截请求到达Controller之前或响应返回视图之前的处理。
实现方式	1. 使用Servlet规范中的Filter接口进行实现。	1. 使用Spring框架提供的HandlerInterceptor接口实现。
功能	1. 主要用于过滤请求和响应，如字符编码处理、安全控制、日志记录等。	1. 可以进行更复杂的业务逻辑处理，如权限控制、日志记录、性能监控、事务控制等。
IOC容器访问	1. 无法直接访问Spring的IOC容器中的bean。	1. 可以访问Spring的IOC容器中的各个bean，并调用业务逻辑。
实现原理	1. 基于回调函数。	1. 基于Java的动态代理（反射）技术。
用途	1. 通用性更强，可以处理所有类型的请求和响应。	1. 更多地用于Spring MVC应用中的请求处理和控制。
配置	1. 在web.xml文件中进行配置。	1. 在Spring MVC的配置文件中进行配置，或通过注解方式。