SpringBoot がモジュール ログ ストレージを実装する方法

#1. 簡単な説明

#モジュール ログを実装するには、大きく 3 つの方法があります:

• #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 などの一部のデータベースでは、同じトランザクション内で 1 つの実行が失敗した場合でも、例外をキャッチします。例外がキャッチされると、残りのデータベースはすべての操作が失敗し、例外がスローされます。

• ロギングには時間がかかり、インターフェイスの応答時間が長くなり、ユーザー エクスペリエンスに影響します。

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 以下のメソッドを使用できます: カスタム スレッドpool @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 の代わりにプログラムによるトランザクションを使用する

@Transactional の代わりに TransactionTemplate を使用することもできます。 注:

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);
        });
    }
}

テスト後:

この実装が例外をスローした後、トランザクションは通常どおりロールバックすることもできます

Normal 実行後、トランザクションの実行内容を読み取ることも可能です。

ロギングの実装がどれほど簡単であっても、実際には落とし穴がたくさんあります。ここに記録されているのは、これまでに遭遇した問題のみです。

以上がSpringBoot がモジュール ログ ストレージを実装する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。