在我的应用程序代码中,通常在应用程序使用期间出现问题时,我希望尽可能多地记录要记录的环境,包括是否适用于已抛出的Exception
的堆栈跟踪。
但是在测试期间,我不希望记录这些堆栈跟踪,使日志文件变得杂乱无章。
如果这是测试本身创建Exception
对象的情况,您可以给它一个消息,可以将其识别为虚拟Exception
,如下所示:
given:
indexMgr.queryParser = Mock( QueryParser ){
parse(_) >> { throw new Exception( 'dummy parse problem' )}
}
然后在应用程序代码中执行以下操作:
try {
query = queryParser.parse(queryString)
}catch( e ) {
log.debug( "QP exception msg: $e.message" )
// we don't want a stack trace to be logged if this is a dummy Exception deliberately thrown during testing
if( ! e.message.contains( 'dummy' )) {
// this will log the stack trace of e
log.error( 'query threw Exception in QP.parse()', e )
}
return false
}
...但是有两个问题:首先,测试代码而不是应用程序代码创建预期的Exception
并不总是如此,其次,检查标识条件的条件是错误的。在实际的应用代码中进行测试。
是否有“最佳实践”方法来解决这个问题?
如果只是从一行中删除堆栈跟踪就可以了,可以在记录器的模式布局中配置异常转换逻辑。下面是使用log4j2的示例:
public class ExceptionOutput {
private static final Logger LOG = LoggerFactory.getLogger(ExceptionOutput.class);
public static void main(String[] args) {
LOG.info("Foo", new NullPointerException("MESSAGE"));
}
}
log4j2配置:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
alwaysWriteExceptions="false"/>
</Console>
</Appenders>
<Loggers>
<Root level="info">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>
注意alwaysWriteExceptions=false
。它完全禁用异常输出。现在,如果我们运行代码,我们将得到:
01:04:50.151 [main] INFO ExceptionOutput - Foo
但是如果你恢复到alwaysWriteExceptions=true
,这也是省略参数的默认行为,那么你得到:
01:07:03.018 [main] INFO ExceptionOutput - Foo
java.lang.NullPointerException: MESSAGE
at ExceptionOutput.main(ExceptionOutput.java:8)
但还有更多。为了获得更大的灵活性,您可以在模式中使用%throwable{...}
转换字,如各个转换模式的Patterns表中的here所述。为了将逻辑仅应用于测试,您可以在类路径上使用log4j2-test.xml,如here所述。其他日志记录库也存在类似的异常转换功能,例如: logback