SpringMVC日志记录(注解版)

SpringMVC日志记录(注解版)
不会注解版配置的可以看
https://blog.csdn.net/qq_73296527/article/details/134621565

1、导入依赖

 <dependencies>

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.3.8</version>
    </dependency>

    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>

    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>2.4</version>
    </dependency>

  </dependencies>

一定要记得刷新依赖

2、在Java包下建立一个interceptor包里面在建立一个LogInterceptor类

package interceptor;

import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;

public class LogInterceptor implements HandlerInterceptor {
    private static final String LOG_FILE_PATH = "D://Maven-workspace-idea//demo//logs.txt";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 记录访问时间
        long startTime = System.currentTimeMillis();
        // 存入request对象
        request.setAttribute("startTime", startTime);
        // 记录Controller的路径和方法
        String controllerPath = request.getRequestURI().split("\\?")[0];
        // 获取handler对象的方法和名称
        String methodName = ((HandlerMethod) handler).getMethod().getName();
        writeLog("访问时间：" + new java.util.Date() + "，Controller的路径：" + controllerPath + ",对应的方法名称：" + methodName);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        //记录请求参数和请求相对路径
        String requestParams = request.getQueryString();// 获取查询字符串，请求的参数信息
        // 获取URI,并且去除上下文路径，保留相对路径
        String rPath = request.getRequestURI().substring(request.getContextPath().length());
        writeLog("请求参数为：" + requestParams + ",请求相对路径：" + rPath);
        // 请求处理时长
        long endTime = System.currentTimeMillis();
        long startTime = (Long) request.getAttribute("startTime");
        long cTime = endTime - startTime;
        writeLog("请求处理时长为：" + cTime + "ms");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 记录响应结果和失败原因
        int statusCode = response.getStatus();// 获取状态码
        String result = statusCode >= 200 && statusCode < 300 ? "成功" : "失败";
        writeLog("响应状态码：" + statusCode + ",响应结果：" + result);
        if (ex != null) {
            writeLog("失败原因：" + ex.getMessage());
        } else {
            writeLog("响应成功：OK！");
        }
    }

    private synchronized void writeLog(String log) {
        try (PrintWriter writer = new PrintWriter(new FileWriter(LOG_FILE_PATH, true))) {
            writer.println(log);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

说明：

• private static final String LOG_FILE_PATH = "D://Maven-workspace-idea//demo//logs.txt";
  声明了一个私有的静态常量LOG_FILE_PATH，用于存储日志文件的路径。（这个路径写你们自己想要放入的地方）
• private synchronized void writeLog(String log)
  声明了一个私有的同步方法writeLog，用于将日志信息写入日志文件。
• try (PrintWriter writer = new PrintWriter(new FileWriter(LOG_FILE_PATH, true))) { writer.println(log); }
  使用PrintWriter将日志信息写入到指定的日志文件中。
• catch (IOException e) { e.printStackTrace(); }
  捕获可能发生的IOException异常并打印堆栈信息。
  在

3、ServletContainersInitConfig里面写一个

package config;

import interceptor.LogInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
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 org.springframework.web.servlet.view.InternalResourceViewResolver;

@Configuration
@EnableWebMvc
@ComponentScan("controller")
public class SpringMvcConfig implements WebMvcConfigurer {
    @Bean
    public InternalResourceViewResolver internalResourceViewResolver(){
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }

   @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**");
    }

}

这段代码的作用是向拦截器注册表中添加一个名为LogInterceptor的拦截器，并指定该拦截器对所有的请求路径都生效（通过addPathPatterns(“/**”)方法）。这意味着LogInterceptor将会拦截所有进入应用程序的请求，并执行其中定义的逻辑。

4、在 controller里面写一个HelloController 的方法

package controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class HelloController {

    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }

}

5、运行tomcat

然后再你存放日志的目录下面就可以看见这个请求的日志信息了

（可以根据你们自己的需求在LogInterceptor类里面进行设计）