您好,欢迎访问一九零五行业门户网

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@restcontrollerpublic 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.transactionutilsimport 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@servicepublic 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.loginlogservice6.1 @async实现异步@servicepublic 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@configurationpublic 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;@servicepublic 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;@servicepublic 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怎么实现模块日志入库的详细内容。
其它类似信息

推荐信息