SpringBoot怎么實現模塊日志入庫

這篇文章主要介紹“SpringBoot怎么實現模塊日志入庫”，在日常操作中，相信很多人在SpringBoot怎么實現模塊日志入庫問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”SpringBoot怎么實現模塊日志入庫”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

1.簡述

模塊日志的實現方式大致有三種：

• AOP + 自定義注解實現

• 輸出指定格式日志 + 日志掃描實現

• 在接口中通過代碼侵入的方式，在業務邏輯處理之后，調用方法記錄日志。

這里我們主要討論下第3種實現方式。

假設我們需要實現一個用戶登錄之后記錄登錄日志的操作。

調用關系如下：

這里的核心代碼是在 LoginService.login() 方法中設置了在事務結束后執行：

// 指定事務提交后執行
TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
    // 不需要事務提交前的操作，可以不用重寫這個方法
    @Override
    public void beforeCommit(boolean readOnly) {
        System.out.println("事務提交前執行");
    }
    @Override
    public void afterCommit() {
        System.out.println("事務提交后執行");
    }
});

在這里，我們把這段代碼封裝成了工具類，參考：4.TransactionUtils。

如果在 LoginService.login() 方法中開啟了事務，不指定事務提交后指定的話，日志處理的方法做異步和做新事務都會有問題：

• 做異步：由于主事務可能沒有執行完畢，導致可能讀取不到主事務中新增或修改的數據信息；

• 做新事物：可以通過 Propagation.REQUIRES_NEW 事務傳播行為來創建新事務，在新事務中執行記錄日志的操作，可能會導致如下問題：

• 由于數據庫默認事務隔離級別是可重復讀，意味著事物之間讀取不到未提交的內容，所以也會導致讀取不到主事務中新增或修改的數據信息；

• 如果開啟的新事務和之前的事務操作了同一個表，就會導致鎖表。

• 什么都不做，直接同步調用：問題最多，可能導致如下幾個問題：

• 不捕獲異常，直接導致接口所有操作回滾；

• 捕獲異常，部分數據庫，如：PostgreSQL，同一事務中，只要有一次執行失敗，就算捕獲異常，剩余的數據庫操作也會全部失敗，拋出異常；

• 日志記錄耗時增加接口響應時間，影響用戶體驗。

2.LoginController

@RestController
public class LoginController {
    @Autowired
    private LoginService loginService;
    @RequestMapping("/login")
    public String login(String username, String pwd) {
        loginService.login(username, pwd);
        return "succeed";
    }
}

3.Action

/**
 * <p> @Title Action
 * <p> @Description 自定義動作函數式接口
 *
 * @author ACGkaka
 * @date 2023/4/26 13:55
 */
public interface Action {
        /**
        * 執行動作
        */
        void doSomething();
}

4.TransactionUtils

import org.springframework.transaction.support.TransactionSynchronization;
import org.springframework.transaction.support.TransactionSynchronizationManager;
/**
 * <p> @Title TransactionUtils
 * <p> @Description 事務同步工具類
 *
 * @author ACGkaka
 * @date 2023/4/26 13:45
 */
public class TransactionUtils {
    /**
     * 提交事務前執行
     */
    public static void beforeTransactionCommit(Action action) {
        TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
            @Override
            public void beforeCommit(boolean readOnly) {
                // 異步執行
                action.doSomething();
            }
        });
    }
    /**
     * 提交事務后異步執行
     */
    public static void afterTransactionCommit(Action action) {
        TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
            @Override
            public void afterCommit() {
                // 異步執行
                action.doSomething();
            }
        });
    }
}

5.LoginService

@Service
public class LoginService {
    @Autowired
    private LoginLogService loginLogService;
    /** 登錄 */
    @Transactional(rollbackFor = Exception.class)
    public void login(String username, String pwd) {
        // 用戶登錄
        // TODO: 實現登錄邏輯..
        // 事務提交后執行
        TransactionUtil.afterTransactionCommit(() -> {
            // 異步執行
            taskExecutor.execute(() -> {
                // 記錄日志
                loginLogService.recordLog(username);
            });
        });
    }
}

6.LoginLogService

6.1 @Async實現異步

@Service
public class LoginLogService {
    /** 記錄日志 */
    @Async
    @Transactional(rollbackFor = Exception.class)
    public void recordLog(String username) {
        // TODO: 實現記錄日志邏輯...
    }
}

注意：@Async 需要配合 @EnableAsync 使用，@EnableAsync 添加到啟動類、配置類、自定義線程池類上均可。

補充：由于 @Async 注解會動態創建一個繼承類來擴展方法的實現，所以可能會導致當前類注入Bean容器失敗 BeanCurrentlyInCreationException，可以使用如下方式：自定義線程池 + @Autowired

6.2 自定義線程池實現異步

1）自定義線程池

AsyncTaskExecutorConfig.java

import com.demo.async.ContextCopyingDecorator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.task.TaskExecutor;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import java.util.concurrent.ThreadPoolExecutor;
/**
 * <p> @Title AsyncTaskExecutorConfig
 * <p> @Description 異步線程池配置
 *
 * @author ACGkaka
 * @date 2023/4/24 19:48
 */
@EnableAsync
@Configuration
public class AsyncTaskExecutorConfig {
    /**
     * 核心線程數（線程池維護線程的最小數量）
     */
    private int corePoolSize = 10;
    /**
     * 最大線程數（線程池維護線程的最大數量）
     */
    private int maxPoolSize = 200;
    /**
     * 隊列最大長度
     */
    private int queueCapacity = 10;
    @Bean
    public TaskExecutor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(corePoolSize);
        executor.setMaxPoolSize(maxPoolSize);
        executor.setQueueCapacity(queueCapacity);
        executor.setThreadNamePrefix("MyExecutor-");
        // for passing in request scope context 轉換請求范圍的上下文
        executor.setTaskDecorator(new ContextCopyingDecorator());
        // rejection-policy：當pool已經達到max size的時候，如何處理新任務
        // CALLER_RUNS：不在新線程中執行任務，而是有調用者所在的線程來執行
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.setWaitForTasksToCompleteOnShutdown(true);
        executor.initialize();
        return executor;
    }
}

2）復制上下文請求

ContextCopyingDecorator.java

import org.slf4j.MDC;
import org.springframework.core.task.TaskDecorator;
import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import java.util.Map;
/**
 * <p> @Title ContextCopyingDecorator
 * <p> @Description 上下文拷貝裝飾者模式
 *
 * @author ACGkaka
 * @date 2023/4/24 20:20
 */
public class ContextCopyingDecorator implements TaskDecorator {
    @Override
    public Runnable decorate(Runnable runnable) {
        try {
            // 從父線程中獲取上下文，然后應用到子線程中
            RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
            Map<String, String> previous = MDC.getCopyOfContextMap();
            SecurityContext securityContext = SecurityContextHolder.getContext();
            return () -> {
                try {
                    if (previous == null) {
                        MDC.clear();
                    } else {
                        MDC.setContextMap(previous);
                    }
                    RequestContextHolder.setRequestAttributes(requestAttributes);
                    SecurityContextHolder.setContext(securityContext);
                    runnable.run();
                } finally {
                    // 清除請求數據
                    MDC.clear();
                    RequestContextHolder.resetRequestAttributes();
                    SecurityContextHolder.clearContext();
                }
            };
        } catch (IllegalStateException e) {
            return runnable;
        }
    }
}

3）自定義線程池實現異步 LoginService

import org.springframework.transaction.support.TransactionSynchronization;
import org.springframework.transaction.support.TransactionSynchronizationManager;
@Service
public class LoginService {
    @Autowired
    private LoginLogService loginLogService;
    @Qualifier("taskExecutor")
    @Autowired
    private TaskExecutor taskExecutor;
    /** 登錄 */
    @Transactional(rollbackFor = Exception.class)
    public void login(String username, String pwd) {
        // 用戶登錄
        // TODO: 實現登錄邏輯..
        // 事務提交后執行
        TransactionUtil.afterTransactionCommit(() -> {
            // 異步執行
            taskExecutor.execute(() -> {
                // 記錄日志
                loginLogService.recordLog(username);
            });
        });
    }
}

7.其他解決方案

7.1 使用編程式事務來代替@Transactional

我們還可以使用TransactionTemplate來代替 @Transactional 注解：

import org.springframework.transaction.support.TransactionTemplate;
@Service
public class LoginService {
    @Autowired
    private LoginLogService loginLogService;
    @Autowired
    private TransactionTemplate transactionTemplate;
    /** 登錄 */
    public void login(String username, String pwd) {
        // 用戶登錄
        transactionTemplate.execute(status->{
            // TODO: 實現登錄邏輯..
        });
        // 事務提交后異步執行
        taskExecutor.execute(() -> {
            // 記錄日志
            loginLogService.recordLog(username);
        });
    }
}

經測試：

這種實現方式拋出異常后，事務也可以正常回滾

正常執行之后也可以讀取到事務執行后的內容，可行。

別看日志記錄好實現，坑是真的多，這里記錄的只是目前遇到的問題。

到此，關于“SpringBoot怎么實現模塊日志入庫”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！