分析一个线程日志工具类

主要功能

性能计时
- start() / stop(): 使用 StopWatch 记录代码段的执行耗时
- stop(int maxSeconds): 支持慢查询检测,超过指定秒数会标记为"慢计数"
- getTotalTimeMillis(): 获取总耗时(毫秒)
日志内容收集
- info(String content): 添加普通日志信息
- info(String content, Object... args): 支持格式化字符串
- appendLog(): 追加日志内容,可选择是否添加时间戳
- appendLine(): 添加换行符
- date(): 添加当前时间
条件日志输出
- hasLog 标志: 用于标记是否需要输出日志(如检测到慢操作时)
- saveLog(boolean isFilter): 根据过滤条件决定是否输出日志
  - isFilter=true: 仅当 hasLog=true 时才输出
  - isFilter=false: 直接输出所有日志
链式调用
- 所有方法都返回 ThreadlogUtils 实例,支持流畅的链式调用
跨方法聚合日志
- 在跨方法中将多个日志聚合打印在一起,方便查询整体流程，解决日志分散的问题

典型使用场景

java 复制代码

ThreadlogUtils utils = ThreadlogUtils.getInstance().start();
utils.info("开始处理订单")
     .info("订单号: {}", orderId)
     .appendLog("用户ID", userId, false);
// ... 业务逻辑 ...
utils.stop(5); // 如果超过5秒,标记为慢操作
utils.saveLog(true); // 仅在慢操作时输出日志

设计特点

线程安全考虑 : 每个实例独立维护 StringBuffer,适合在单线程上下文中使用
灵活过滤 : 通过 hasLog 标志和 isFilter 参数,可以只记录异常情况或慢操作,避免日志泛滥
自动清理 : getLog(true) 和 saveLog() 都会清空缓冲区,防止内存泄漏

这个工具类非常适合用于性能监控 、问题排查 和关键业务流程追踪。

具体实现

LogUtils和StringUtils需要换成自己项目中使用的日志类和String工具类

java 复制代码

package com.atm.service.utils;

import com.atc.frame.base.utils.LogUtils;
import com.atc.frame.base.utils.StringUtils;
import org.springframework.util.StopWatch;

import java.util.Date;
import java.util.Optional;

public class ThreadlogUtils {

    public static ThreadlogUtils getInstance() {
        ThreadlogUtils threadlogUtils = new ThreadlogUtils();
        return threadlogUtils;
    }

    private StringBuffer stringBuffer = new StringBuffer();
    private StopWatch watch = null;

    public boolean hasLog = false;

    public ThreadlogUtils start() {
        watch = new StopWatch();
        watch.start();
        return this;
    }

    public ThreadlogUtils stop() {
        if (watch != null) {
            watch.stop();
            appendLog(String.format("耗时 %s ms", watch.getTotalTimeMillis()));
        }
        return this;
    }

    public ThreadlogUtils stop(int maxSeconds) {
        if (watch != null) {
            watch.stop();
            boolean flag = watch.getTotalTimeMillis() > maxSeconds * 1000L;
            if (flag) {
                this.setHasLog();
            }
            String s = flag ? " 慢计数" : "";
            appendLog(String.format("耗时 %s ms %s", watch.getTotalTimeMillis(), s));
        }
        return this;
    }

    public long getTotalTimeMillis() {
        if (watch != null) {
            return watch.getTotalTimeMillis();
        }
        return -1;
    }

    public ThreadlogUtils info(String content) {
        appendLog(content);
        return this;
    }

    public ThreadlogUtils infoWithoutLine(String content) {
        appendLog(content);
        return this;
    }

    public ThreadlogUtils info(String content, boolean date) {
        return infoAndDate(content, date);
    }

    public ThreadlogUtils infoAndDate(String content, boolean date) {
        appendLog(content, date);
        return this;
    }

    public ThreadlogUtils info(String content, Object... args) {
        appendLog(String.format(content, args));
        return this;
    }


    /**
     * 追加线程日志
     *
     * @param content
     */
    public ThreadlogUtils appendLog(String content) {
        appendLog(content, false);
        return this;
    }

    /**
     * 添加换行符
     */
    public ThreadlogUtils appendLine() {
        stringBuffer.append(AtmUtils.SystemLine);
        return this;
    }

    public ThreadlogUtils date() {
        stringBuffer.append(getNowTimeString()).append(" ");
        return this;
    }

    /**
     * 追加线程日志
     *
     * @param content
     * @param date
     */
    public ThreadlogUtils appendLog(String content, boolean date) {
        if (date) {
            stringBuffer.append(content).append(" ").append(getNowTimeString()).append(AtmUtils.SystemLine);
        } else {
            stringBuffer.append(content).append(AtmUtils.SystemLine);
        }
        return this;
    }

    /**
     * value 不为空才拼接
     */
    public ThreadlogUtils appendLog(String label, String value, boolean addComma) {
        String v = Optional.ofNullable(value).orElse("");
        stringBuffer.append(label).append(": ").append(v);

        if (addComma) {
            stringBuffer.append(", ");
        }
        return this;
    }

    public static String getNowTimeString() {
        return AtmDateUtils.getTimeString(new Date(), 100);
    }

    public ThreadlogUtils appendLog(String content, long startTime) {
        stringBuffer.append(content).append(String.format(" 耗时 %s ms ", System.currentTimeMillis() - startTime)).append(AtmUtils.SystemLine);
        return this;
    }

    /**
     * 获得线程日志
     *
     * @param isClear
     * @return
     */
    public String getLog(boolean isClear) {
        String str = stringBuffer.toString();
        if (isClear) {
            stringBuffer.setLength(0);
        }
        return str;
    }

    public ThreadlogUtils setHasLog() {
        hasLog = true;
        return this;
    }

    public void saveLog(boolean isFilter) {
        if (isFilter) {
            if (hasLog) {
                LogUtils.info(getLog(true));
            }
        } else {
            LogUtils.info(getLog(true));
        }
    }

    /**
     * 清理线程日志
     *
     * @return
     */
    public void clear() {
        stringBuffer.setLength(0);
    }
}

使用

在类中声明THREAD_LOG变量

java 复制代码

protected static final ThreadLocal<ThreadlogUtils> THREAD_LOG = ThreadLocal.withInitial(ThreadlogUtils::new);

测试类,打印完日志记得调用remove方法清理 ThreadLocal 变量，防止内存泄漏

java 复制代码

    public static void main(String[] args) {
        try {
            THREAD_LOG.get().info(String.format(">>>> %s分析开始 <<<<<< ", PRE), true);
            THREAD_LOG.get().info(String.format("%s,%s,通过线路(始发-目的/经卸)过滤运单,获取运单为空,自动化算法不计算", PRE, "xxx"));
            THREAD_LOG.get().info(String.format("%s,%s,计算完成", PRE, "xxx"), true);
        }catch (Exception e) {

        }finally {
            THREAD_LOG.get().info("处理完成", true);
            THREAD_LOG.get().saveLog(false);
            THREAD_LOG.remove();
        }

    }