【JAVA】日志打印java.util.logging.*函数自定义格式，并且显示调用时行号

因缘而起12023-10-17 11:57

1、JAVA自带的这样：

代码如下：

java 复制代码 
import java.util.logging.*;
Logger logger = Logger.getLogger(MyLogger.class.toString());
logger.info("123");

显示效果：

这样的格式，看起来不太好看，比如：会默认添加一个换行，另外，想查看行号，会比较麻烦；随着开发代码量不断增加，因为一个函数代码量也比较大，如果知道行号，定位问题具体问题代码比较快，有点类似C语言的__LINE__宏，使用起来比较方便。

2、基于这个问题，我们需要自已实现可以显示行号的日志打印格式，通过网上查资料，知道要用到自定义日志格式设置：

java 复制代码 
        logger = Logger.getLogger(MyLogger.class.getName());
        logger.setUseParentHandlers(false);
        //如果需要将日志文件写到文件系统中，需要创建一个FileHandler对象
        Handler consoleHandler = new ConsoleHandler();

        //创建日志格式文件：本次采用自定义的Formatter
        consoleHandler.setFormatter(new MyFormatter());

        //将FileHandler对象添加到Logger对象中
        logger.addHandler(consoleHandler);

在MyFormatter中实现对格式的自定义：

java 复制代码 
 @Override
    public String format(LogRecord arg0)
    {
        //创建StringBuilder对象来存放后续需要打印的日志内容
        StringBuilder builder = new StringBuilder();

        //获取时间
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss.SSS");
        Date now = new Date();
        String dateStr = simpleDateFormat.format(now);

        builder.append("[");
        builder.append(dateStr);
        builder.append(" ");

        //拼接日志级别
        builder.append(arg0.getLevel()).append(" ");

        builder.append(arg0.getSourceClassName()).append(" ");

        //拼接方法名
        builder.append(arg0.getSourceMethodName()).append(" ");

        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        String line = stackTrace[8].toString();
        String lineNumber = line.substring(line.indexOf(":") + 1, line.length() - 1);
        //System.out.println("stackTrace[0].toString(): " + stackTrace[0].toString());

        //拼接方法名
        builder.append(lineNumber).append("] ");

        //拼接日志内容
        builder.append(arg0.getMessage());

        //日志换行
        builder.append("\r\n");

        return builder.toString();
    }

这里边额外使用了获取当前线程的堆栈跟踪元素：Thread.currentThread().getStackTrace()，在程序执行过程中，可以把当前位置的调用栈打印出来;

如果在当前的文件，由于调用栈深度不深，代码如下：

java 复制代码 
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        System.out.println(stackTrace.length);
        for (StackTraceElement s: stackTrace) {
            System.out.println(s.toString());
        }

这样打印出来是这样的：

3、在实际运行的代码涉及跨类的调用，代码：

java 复制代码 
/**
 * 可以自已定义日志打印格式，这样看起来比较方便些
 *
 */
class MyFormatter extends Formatter
{
    @Override
    public String format(LogRecord arg0)
    {
        //创建StringBuilder对象来存放后续需要打印的日志内容
        StringBuilder builder = new StringBuilder();

        //获取时间
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss.SSS");
        Date now = new Date();
        String dateStr = simpleDateFormat.format(now);

        builder.append("[");
        builder.append(dateStr);
        builder.append(" ");

        //拼接日志级别
        builder.append(arg0.getLevel()).append(" ");

        builder.append(arg0.getSourceClassName()).append(" ");

        //拼接方法名
        builder.append(arg0.getSourceMethodName()).append(" ");

        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        String line = stackTrace[8].toString();
        String lineNumber = line.substring(line.indexOf(":") + 1, line.length() - 1);
        //System.out.println("stackTrace[0].toString(): " + stackTrace[0].toString());

        StackTraceElement[] stackTrace2 = Thread.currentThread().getStackTrace();
        System.out.println(stackTrace2.length);
        for (StackTraceElement s: stackTrace2) {
            System.out.println(s.toString());
        }
        //拼接方法名
        builder.append(lineNumber).append("] ");

        //拼接日志内容
        builder.append(arg0.getMessage());

        //日志换行
        builder.append("\r\n");

        return builder.toString();
    }
}

这样看到的调用栈较深些：

这样在取我们自已代码的入口的时候，就需要从这上边往下边数，因为这里边代码是一个数组，从上图中打印也可看出来，前几个是日志打印的栈

java 复制代码 
StackTraceElement[] stackTrace2 = Thread.currentThread().getStackTrace();
        System.out.println(stackTrace2.length);
        for (StackTraceElement s: stackTrace2) {
            System.out.println(s.toString());
        }

从上图可以看出，我们代码在调用日志打印的时候，实际上使用的是stackTrace2数组里边第9个成员，由于我们需要取出行号，那么使用的是JAVA对字符串操作的搜索和截取操作，这样就可以达到目的：

java 复制代码 
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        String line = stackTrace[8].toString();
        String lineNumber = line.substring(line.indexOf(":") + 1, line.length() - 1);

由于我们可以自定义打印日志的格式，那么我们整体按照自已的要求自定义后，代码是这样子的：

java 复制代码 
class MyFormatter extends Formatter
{
    @Override
    public String format(LogRecord arg0)
    {
        //创建StringBuilder对象来存放后续需要打印的日志内容
        StringBuilder builder = new StringBuilder();

        //获取时间
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss.SSS");
        Date now = new Date();
        String dateStr = simpleDateFormat.format(now);

        builder.append("[");
        builder.append(dateStr);
        builder.append(" ");

        //拼接日志级别
        builder.append(arg0.getLevel()).append(" ");

        builder.append(arg0.getSourceClassName()).append(" ");

        //拼接方法名
        builder.append(arg0.getSourceMethodName()).append(" ");

        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        String line = stackTrace[8].toString();
        String lineNumber = line.substring(line.indexOf(":") + 1, line.length() - 1);

        //拼接方法名
        builder.append(lineNumber).append("] ");

        //拼接日志内容
        builder.append(arg0.getMessage());

        //日志换行
        builder.append("\r\n");

        return builder.toString();
    }
}

最终的打印效果如下图所示：

自定义日志打印完成类代码如下：

java 复制代码 
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.logging.*;

/**
 * 可以自已定义日志打印格式，这样看起来比较方便些
 *
 */
class MyFormatter extends Formatter
{
    @Override
    public String format(LogRecord arg0)
    {
        //创建StringBuilder对象来存放后续需要打印的日志内容
        StringBuilder builder = new StringBuilder();

        //获取时间
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss.SSS");
        Date now = new Date();
        String dateStr = simpleDateFormat.format(now);

        builder.append("[");
        builder.append(dateStr);
        builder.append(" ");

        //拼接日志级别
        builder.append(arg0.getLevel()).append(" ");

        builder.append(arg0.getSourceClassName()).append(" ");

        //拼接方法名
        builder.append(arg0.getSourceMethodName()).append(" ");

        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        String line = stackTrace[8].toString();
        String lineNumber = line.substring(line.indexOf(":") + 1, line.length() - 1);

        //拼接方法名
        builder.append(lineNumber).append("] ");

        //拼接日志内容
        builder.append(arg0.getMessage());

        //日志换行
        builder.append("\r\n");

        return builder.toString();
    }
}

public class MyLogger {
    static Logger logger;

    static  {
        logger = Logger.getLogger(MyLogger.class.getName());
        logger.setUseParentHandlers(false);
        //如果需要将日志文件写到文件系统中，需要创建一个FileHandler对象
        Handler consoleHandler = new ConsoleHandler();

        //创建日志格式文件：本次采用自定义的Formatter
        consoleHandler.setFormatter(new MyFormatter());

        //将FileHandler对象添加到Logger对象中
        logger.addHandler(consoleHandler);
    }

    public static Logger getLogger() {
        return logger;
    }
}
相关推荐
@大迁世界3 分钟前
告别 Go，拥抱 Rust
开发语言·golang·rust
SEO_juper5 分钟前
Node.js 重定向链检测工具：301 跳了几跳、有没有成环，一次看清
xml·开发语言·python·node.js·json·bash
kyriewen6 分钟前
别再用防抖做懒加载了：120 张图只加载出 4 张
前端·javascript·程序员
南归北隐6 分钟前
Spring AI Alibaba Graph框架实现MCP数据库查询实战
java·后端·spring ai·mcp·spring ai mcp
学逆向的6 分钟前
C 指针常量与常量指针
c语言·开发语言·网络安全
古法老登瞎折腾19 分钟前
大数据智能运维实战（九）：让 AI 查日志——找到异常，也保留上下文
java·大数据·运维·人工智能·spring ai·mcp
ai大模型-探索者30 分钟前
Function Call与MCP（区别、联系与实战）
java·服务器·网络
略略略咯咯35 分钟前
啊啊啊啊啊
java·服务器·数据库
SL_staff1 小时前
运维救火实战：钉钉API变更致薪资计算中断，如何用可视化逻辑引擎5分钟热修复
java·开源·全栈
低调滴开发1 小时前
3 行代码写崩一个函数？切片才是 Rust 字符串处理的正确姿势
开发语言·后端·rust
热门推荐
01如何新建文件夹？ 电脑新建文件夹的4种方法02国内可直接用、免费额度/永久免费的大模型API清单（含 SiliconFlow、火山、阿里、智谱、百度、Kimi、DeepSeek、DMXAPI 等）03历年考研数学一、数学二、数学三真题试卷及答案PDF04GitHub 镜像站点05几个好用的ip纯净度检测网站06昇腾910B系列芯片完全指南：四款型号对比、服务器选型与大模型部署实战07苹果iPA游戏软件资源下载网站08CVE-2026-91403 高危漏洞预警：Java JSSE 信任链被攻破 全场景修复方案与Linux系统级彻底清理实操09蜘蛛磁力 搜索引擎大全，如何使用蜘蛛磁力查找磁力链接10Windows 10/11 如何退出微软账户并改用本地账户登录（含找不到选项的解决方法）