快捷導(dǎo)航

在SpringBoot中記錄用戶操作日志功能

更新時(shí)間：2024年12月23日 09:55:50 作者：Front_Yue

在Web應(yīng)用程序開發(fā)中,記錄用戶操作日志是一項(xiàng)非常重要的任務(wù),它可以幫助我們追蹤用戶行為,分析系統(tǒng)狀況,以及審計(jì)系統(tǒng)的安全性,本文將介紹如何在SpringBoot框架中實(shí)現(xiàn)用戶操作日志的記錄功能,感興趣的朋友一起看看吧

在Web應(yīng)用程序開發(fā)中，記錄用戶操作日志是一項(xiàng)非常重要的任務(wù)。它可以幫助我們追蹤用戶行為，分析系統(tǒng)狀況，以及審計(jì)系統(tǒng)的安全性。本文將介紹如何在SpringBoot框架中實(shí)現(xiàn)用戶操作日志的記錄功能。

1. 使用AOP（面向切面編程）

AOP是一種編程范式，它允許我們?cè)诓恍薷默F(xiàn)有代碼的情況下，增加新的功能或修改現(xiàn)有功能。在SpringBoot中，我們可以使用AOP來攔截用戶的操作，并在攔截的方法中添加日志記錄邏輯。

首先，需要在項(xiàng)目中添加Spring AOP的依賴：

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

然后，創(chuàng)建一個(gè)切面類，用于攔截用戶操作并記錄日志：

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class UserOperationLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(UserOperationLogAspect.class);
    @Before("execution(* com.example.demo.controller.*.*(..))")
    public void logUserOperation(JoinPoint joinPoint) {
        // 獲取請(qǐng)求方法名
        String methodName = joinPoint.getSignature().getName();
        // 獲取請(qǐng)求參數(shù)
        Object[] args = joinPoint.getArgs();
        // 構(gòu)建請(qǐng)求參數(shù)字符串
        StringBuilder params = new StringBuilder();
        for (Object arg : args) {
            params.append(arg).append(",");
        }
        // 記錄日志
        logger.info("User operation: method={}, params={}", methodName, params.toString());
    }
}

上述代碼中，我們使用@Before注解定義了一個(gè)前置通知，它會(huì)在匹配的方法執(zhí)行前被調(diào)用。在這個(gè)方法中，我們獲取了請(qǐng)求方法名和請(qǐng)求參數(shù)，并使用Logger記錄日志。

注意，execution(* com.example.demo.controller.*.*(..))表示攔截com.example.demo.controller包下所有類的所有方法。你可以根據(jù)需要調(diào)整切點(diǎn)表達(dá)式。

2. 使用Filter（過濾器）

另一種實(shí)現(xiàn)日志記錄的方法是使用過濾器。過濾器可以在請(qǐng)求到達(dá)控制器之前執(zhí)行，因此可以用于記錄請(qǐng)求信息和日志。

首先，創(chuàng)建一個(gè)過濾器類，實(shí)現(xiàn)Filter接口：

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Enumeration;
public class UserOperationLogFilter implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(UserOperationLogFilter.class);
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        // 獲取請(qǐng)求方法
        String method = httpRequest.getMethod();
        // 獲取請(qǐng)求URL
        String url = httpRequest.getRequestURL().toString();
        // 獲取請(qǐng)求參數(shù)
        Enumeration<String> parameterNames = httpRequest.getParameterNames();
        StringBuilder params = new StringBuilder();
        while (parameterNames.hasMoreElements()) {
            String paramName = parameterNames.nextElement();
            params.append(paramName).append("=").append(httpRequest.getParameter(paramName)).append(",");
        }
        // 記錄日志
        logger.info("User operation: method={}, url={}, params={}", method, url, params.toString());
        // 繼續(xù)執(zhí)行后續(xù)過濾器或控制器
        chain.doFilter(request, response);
    }
    @Override
    public void destroy() {
    }
}

接下來，需要在SpringBoot配置類中注冊(cè)過濾器：

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean<UserOperationLogFilter> userOperationLogFilter() {
        FilterRegistrationBean<UserOperationLogFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new UserOperationLogFilter());
        registrationBean.addUrlPatterns("/*"); // 設(shè)置過濾器的URL模式
        return registrationBean;
    }
}

上述代碼中，我們創(chuàng)建了一個(gè)UserOperationLogFilter過濾器類，并在doFilter方法中記錄了請(qǐng)求方法和URL。然后，在FilterConfig配置類中使用@Bean注解注冊(cè)過濾器，并設(shè)置URL模式為/*，表示攔截所有請(qǐng)求。