xxl-job异步不打印日志解决方案

以你之姓@ 2022-12-21 15:47 549阅读 0赞

### 文章目录 ###

*  xxl-job存在的问题
 *  源码
 *   *  InheritableThreadLocal为何物？
 *  解决方案

# xxl-job存在的问题 #

*  在定时器使用异步或者使用线程池来实现异步处理（比如有时远程调用会超时，像网关会设置超时的时间等等）在代码中打印日志不输出的问题。

接下来我们看下导致的原因

# 源码 #

**XxlJobLogger.log**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70_pic_center 1]  
**XxlJobFileAppender.contextHolder**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70_pic_center 2]

## InheritableThreadLocal为何物？ ##

我在之前的博客已经有相应的讲解

*  [初识TransmittableThreadLocal][TransmittableThreadLocal]

InheritableThreadLocal为父子线程传递，就是如果你在当前线程下创建新的线程，它在创建线程的过程会把当前线程的变量copy到子线程里面。这种情况是可以打印出日志的。

另一种情况是你使用了自己定义的线程池，进行异步处理事务。

# 解决方案 #

1.在创建线程的时候，XxlJobFileAppender.contextHolder.set()一下日志文件名称。

2.重写一下打印日志的代码，避免同事失误打印不出来日志，下面大概写下思路，具体还没去验证，凑合着看下，嘻嘻~

public class XxlJobLoggerChild extends XxlJobLogger { 
    
        public static final TransmittableThreadLocal<String> contextHolder = new TransmittableThreadLocal<>();
    
        private static Logger logger = LoggerFactory.getLogger("xxl-job logger");
    
        public static void log(String appendLogPattern, Object... appendLogArguments) { 
            FormattingTuple ft = MessageFormatter.arrayFormat(appendLogPattern, appendLogArguments);
            String appendLog = ft.getMessage();
            StackTraceElement callInfo = (new Throwable()).getStackTrace()[1];
            logDetail(callInfo, appendLog);
        }
    
        @PostConstruct
        public void someMethod() { 
            contextHolder.set(XxlJobFileAppender.contextHolder.get());
        }
    
        private static void logDetail(StackTraceElement callInfo, String appendLog) { 
            StringBuffer stringBuffer = new StringBuffer();
            stringBuffer.append(DateUtil.formatDateTime(new Date())).append(" ").append("[" + callInfo.getClassName() + "#" + callInfo.getMethodName() + "]").append("-").append("[" + callInfo.getLineNumber() + "]").append("-").append("[" + Thread.currentThread().getName() + "]").append(" ").append(appendLog != null ? appendLog : "");
            String formatAppendLog = stringBuffer.toString();
            String logFileName = contextHolder.get();
            if (logFileName != null && logFileName.trim().length() > 0) { 
                XxlJobFileAppender.appendLog(logFileName, formatAppendLog);
            } else { 
                logger.info(">>>>>>>>>>> {}", formatAppendLog);
            }
    
        }
    
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/aae34a82f4aa46f1bbf4b28951371e4b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20201116212639486.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20201116212752183.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA==,size_16,color_FFFFFF,t_70#pic_center
[TransmittableThreadLocal]: https://blog.csdn.net/weixin_38336658/article/details/105914390?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522160553331819724839229526%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=160553331819724839229526&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_v2~rank_blog_default-4-105914390.pc_v2_rank_blog_default&utm_term=TTL&spm=1018.2118.3001.4450