首页 > 资讯 > 后端开发 > Python >在日志中记录Java异常信息的正确姿势分享

658

分享到

在日志中记录Java异常信息的正确姿势分享

2024-04-02 19:04:59 658人浏览独家记忆

Python 官方文档：入门教程 => 点击学习

摘要

目录日志中记录Java异常信息遇到的问题原因分析正确的做法java异常在控制台和日志里面的打印记录1、e.printStackTrace()打印在哪里2、e.printStackTr

日志中记录Java异常信息

遇到的问题

今天遇到一个线上的BUG，在执行表单提交时失败，但是从程序日志中看不到任何异常信息。
在Review源代码时发现，当catch到异常时只是输出了e.getMessage()，如下所示：


logger.error("error: {}, {}", params, e.getMessage());

在日志中看不到任何信息，说明e.getMessage()返回值为空字符串。

原因分析

先来看一下Java中的异常类图：

Throwable是Java中所有异常信息的顶级父类，其中的成员变量detailMessage就是在调用e.getMessage()返回的值。
那么这个属性会在什么时候赋值呢，追溯源码发现，该属性只会在Throwable构造函数中赋值。


public Throwable() {
    // 在默认构造函数中不会给detailMessage属性赋值
    fillInStackTrace();
}
public Throwable(String message) {
    fillInStackTrace();
    // 直接将参数赋值给detailMessage
    detailMessage = message;
}
public Throwable(String message, Throwable cause) {
    fillInStackTrace();
    // 直接将参数赋值给detailMessage
    detailMessage = message;
    this.cause = cause;
}
public Throwable(Throwable cause) {
    fillInStackTrace();
    // 当传入的Throwable对象不为空时，为detailMessage赋值
    detailMessage = (cause==null ? null : cause.toString());
    this.cause = cause;
}
protected Throwable(String message, Throwable cause,
                        boolean enableSuppression,
                        boolean writableStackTrace) {
    if (writableStackTrace) {
        fillInStackTrace();
    } else {
        stackTrace = null;
    }
    // 直接将参数赋值给detailMessage
    detailMessage = message;
    this.cause = cause;
    if (!enableSuppression)
        suppressedExceptions = null;
}

显然，从源码中可以看到在Throwable的默认构造函数中是不会给detailMessage属性赋值的。

也就是说，当异常对象是通过默认构造函数实例化的，或者实例化时传入的message为空字符串，那么调用getMessage()方法时返回值就为空，也就是我遇到的情形。

所以，在程序日志中不要单纯使用getMessage()方法获取异常信息（返回值为空时，不利于问题排查）。

正确的做法

在Java开发中，常用的日志框架及组件通常是：slf4j，log4j和logback，他们的关系可以描述为：slf4j提供了统一的日志api，将具体的日志实现交给log4j与logback。

也就是说，通常我们只需要在项目中使用slf4j作为日志API，再集成log4j或者logback即可。


<!-- 使用slf4j作为日志API -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>
<!-- 集成logback作为具体的日志实现 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.2.3</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

上述配置以集成slf4j和logback为例，添加对应的logback配置文件（logback.xml）：


<configuration scan="false" scanPeriod="30 seconds" debug="false" packagingData="true">
    <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener"/>
    <!-- 输出到控制台 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
        </encoder>
    </appender>
    　　
    <!-- 输出到文件 -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>test.log</file>
        <encoder>
            <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
        </encoder>
    </appender>
    <root level="info">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE" />
    </root>
</configuration>

在Java中通过slf4j提供的日志API记录日志：


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Test {
    private static final Logger logger = LoggerFactory.getLogger(Test.class);
}

当我们需要在程序日志中输出异常信息时，应该直接传入异常对象即可，而不要单纯通过异常对象的getMessage()方法获取输出异常信息。


public void test() {
    try {
        // 使用默认构造函数实实例化异常对象
        throw new NullPointerException();
    } catch (Exception e) {
        // 直接将异常对象传入日志接口，保存异常信息到日志文件中
        logger.error("error: {}", e.getMessage(), e);
        e.printStackTrace();
    }
}

如下是保存到日志文件中的异常信息片段：


2019-06-20 20:04:25,290 ERROR [Http-NIO-8090-exec-1] o.c.s.f.c.TestExceptionController [TestExceptionController.java:26] error: null # 使用默认构造参数实例化异常对象时，getMessage()方法返回值为空对象
# 如下是具体的异常堆栈信息
java.lang.NullPointerException: null
 at org.chench.SpringBoot.falsework.controller.TestExceptionController.test(TestExceptionController.java:24) ~[classes/:na]
 at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_181]
 at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_181]
 at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_181]
 at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_181]
 at org.springframework.WEB.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:209) [spring-web-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:136) [spring-web-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:102) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:877) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:783) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:991) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:925) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:974) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:866) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at javax.servlet.http.httpservlet.service(HttpServlet.java:635) [Tomcat-embed-core-8.5.31.jar:8.5.31]
 at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:851) [spring-webmvc-5.0.6.RELEASE.jar:5.0.6.RELEASE]
 at javax.servlet.http.HttpServlet.service(HttpServlet.java:742) [tomcat-embed-core-8.5.31.jar:8.5.31]
......

java异常在控制台和日志里面的打印记录

1、e.printStackTrace()打印在哪里

在catch中的e.printStackTrace()将打印到控制台

2、e.printStackTrace()打印的内容是什么


import org.apache.logging.log4j.Logger; 
public class ExceptionTest {
    private static final Logger logger=LogManager.getLogger(); 
    public void  test() {
        try {
            int i=1/0;            
        }catch(Exception e){    
            e.printStackTrace();
        }
    }
    public static void main(String[] args) {
        ExceptionTest test= new ExceptionTest();
        test.test();        
    }    
}

输出结果如下：

java.lang.ArithmeticException: / by zero
at myProject.ExceptionTest.test(ExceptionTest.java:10)
at myProject.ExceptionTest.main(ExceptionTest.java:18)

可见，e.printStackTrace()打印了错误的具体信息，即这个错误出现的位置，便于查找错误源

3、如果将e.printStackTrace()的信息打印在日志里应该怎么做呢？

见如下代码：


package myProject; 
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger; 
public class ExceptionTest {
    private static final Logger logger=LogManager.getLogger(); 
    public void  test() {
        try {
            int i=1/0;            
        }catch(Exception e){    
            logger.error(e);
        }
    }
    public static void main(String[] args) {
        ExceptionTest test= new ExceptionTest();
        test.test();        
    }    
}

用logger.error(e);打印日志，输出结果如下：

19:17:39.753 [main] ERROR myProject.ExceptionTest - java.lang.ArithmeticException: / by zero

可见，用这种方法打印的日志，只有大概的错误信息，并没有指出报错的代码位置，不便于查找错误。用logger.error(e.getMessage());也是输出这种大概的错误信息。

再见如下代码：


package myProject; 
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger; 
public class ExceptionTest {
    private static final Logger logger=LogManager.getLogger(); 
    public void  test() {
        try {
            int i=1/0;            
        }catch(Exception e){    
            logger.error("ExceptionTest Exception:",e);
        }
    }
    public static void main(String[] args) {
        ExceptionTest test= new ExceptionTest();
        test.test();        
    }    
}

用logger.error("ExceptionTest Exception:",e);，则输出结果如下：

9:20:32.948 [main] ERROR myProject.ExceptionTest - ExceptionTest Exception:
java.lang.ArithmeticException: / by zero
at myProject.ExceptionTest.test(ExceptionTest.java:10) [classes/:?]
at myProject.ExceptionTest.main(ExceptionTest.java:18) [classes/:?]

这和e.printStackTrace()打印的内容大致是相同的。不过最好，还是使用logger.error(e.getMessage(),e)方法来在日志上查看异常的详细结果

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程网。

您可能感兴趣的文档:

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: 在日志中记录Java异常信息的正确姿势分享

本文链接: https://www.lsjlt.com/news/136555.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档

去做题

猜你喜欢

在日志中记录Java异常信息的正确姿势分享

目录日志中记录Java异常信息遇到的问题原因分析正确的做法java异常在控制台和日志里面的打印记录1、e.printStackTrace()打印在哪里2、e.printStackTr...

99+

2024-04-02
Python 日志记录完整的异常信息

基本范式是： try: do-something-block except: logger.exception("Exception Logged") def setLogger(): # 创...

99+

2023-01-31

异常完整日志
日志记录在 Bash 和 Java 中的异同点是什么？

日志记录是软件开发中非常重要的一个环节，可以帮助开发者在软件运行时快速定位和解决问题。在 Bash 和 Java 中，日志记录也是非常常见的操作。本文将从以下几个方面探讨 Bash 和 Java 中日志记录的异同点。日志记录的目的 B...

99+

2023-10-12

bash 并发日志
日志记录在 Python 编程中的作用：您是否知道如何正确地记录和分析它们？

在 Python 编程中，日志记录是一项非常重要的任务。它可以帮助程序员快速诊断和解决问题，同时也可以提供有用的性能指标和统计信息。本文将介绍 Python 中的日志记录功能，包括如何正确地记录和分析日志。日志记录的基础知识在 P...

99+

2023-07-23

编程算法日志 unix
Git最佳实践：Java开发中的日志记录技巧分享

在Java开发中，日志记录是非常重要的一环，它可以帮助我们追踪代码运行时的问题，分析应用程序的性能，以及记录用户行为等等。而Git则是目前最流行的版本控制工具之一，它可以让我们更好地管理代码，协作开发，以及追踪代码变化。本文将会介绍一些在...

99+

2023-08-07

面试日志 git
如何在 ASP 系统中正确使用日志记录，以便在 Windows 和 Unix 上进行分析？

ASP（Active Server Pages）是一种用于创建动态 Web 应用程序的技术。在开发 ASP 应用程序时，日志记录（Logging）是一项非常重要的任务，因为它可以帮助开发人员在应用程序出现问题时进行故障排除。在本文中，我们将...

99+

2023-08-16

unix 日志 windows
日志记录在GO语言接口中的应用：学习实例分享

日志记录在软件开发中是一个非常重要的环节，它可以帮助我们追踪和调试程序的运行情况，以及及时发现和解决潜在的问题。在Go语言开发中，我们可以通过一些第三方库来实现日志记录功能，比如logrus、zap等。但是，这些库都是基于结构体的，需要在...

99+

2023-06-25

教程接口日志
如何利用Java编写高效的日志记录器，以在Linux系统上记录详细的对象信息？

Java是一种广泛应用于各种类型的应用程序的编程语言，它是一种面向对象的语言，因此在Java中使用日志记录器来跟踪应用程序状态和行为是非常重要的。在Linux系统上使用Java编写高效的日志记录器，可以记录详细的对象信息，以便在应用程序出现...

99+

2023-08-25

linux 对象日志
C#开发中如何处理异常日志和错误信息的收集与分析

C#开发中如何处理异常日志和错误信息的收集与分析引言：在软件开发过程中，我们经常会遇到各种异常和错误。为了及时发现并解决这些问题，我们需要在代码中实现异常日志和错误信息的收集与分析。本文将介绍如何在C#开发中处理异常日志和错误信息，并提供一...

99+

2023-10-22

日志收集异常处理错误信息分析