用于详细（和多行）日志的Java日志API

Question

null

例如，对于单个多行日志，如下所示：

2017-11-10 14:26:59,156 [main] WARN o.s.t.c.s.ExampleClass:
    Caption: Unconformable data
    Description: The data provided from the X datasource in order to perform Y operation could not be translated
    Response Action: Application will discard unusable data into this component's DLQ
    Details: The data string "x" was not of expected Integer type
        <Some stacktrace>....

这是一个详细的语句，它将非常详细地说明发生了什么，发生在哪里，以及应用程序在响应异常事件时正在做什么。

我能找到的最接近的是JBoss日志API和在ActiveMQ Artemis源代码中找到的一些代码示例。可以在单个文件中定义消息格式声明，如下所示：

   @LogMessage(level = Logger.Level.WARN)
   @Message(id = 202008, value = "Failed to check Address list {0}.",
      format = Message.Format.MESSAGE_FORMAT)
   void failedToParseAddressList(@Cause Exception e, String addressList);

ActiveMQUtilLogger.LOGGER.failedToParseAddressList(e, addressList);

有人对这个问题有什么建议吗--不管是另一个API、代码模式还是一个漂亮的技巧？

Answer 1

您还没有说明不使用log4j2的具体原因，所以我建议您使用该方法。正如您所指出的，它提供了structuredDataMessage，您可以使用它来满足您的需要。虽然在本例中，我建议使用MapMessage，因为您的示例中没有包含id和type，这些都内置在structuredDataMessage类中。

下面是一些快速示例代码：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.message.MapMessage;

public class MapMessageExample {

    private static final Logger log = LogManager.getLogger();   

    public static void main(String[] args){
        log.info(buildMsg("My title", "This is the description", 
                "No response needed", "Some details here"));        
    }

    // This could be moved into a factory class
    public static MapMessage buildMsg(String title, String description, 
            String responseAction, String details)
    {
        MapMessage mapMsg = new MapMessage();
        mapMsg.put("title", title);
        mapMsg.put("desc", description);
        mapMsg.put("response", responseAction);
        mapMsg.put("details", details);
        return mapMsg;
    }
}

和一个log4j2.xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%M] %-5level %logger{36}%n\tCaption: ${map:title}%n\tDescription: ${map:desc}%n\tResponse Action: ${map:response}%n\tDetails: ${map:details}%n" />
        </Console>
    </Appenders>

    <Loggers>
        <Root level="debug">
            <AppenderRef ref="Console" />
        </Root>
    </Loggers>
</Configuration>

下面是一些示例输出：

00:40:45.810 [main] INFO  example.MapMessageExample
    Caption: My title
    Description: This is the description
    Response Action: No response needed
    Details: Some details here

我同意，工厂模式将是一个很好的选择。正如我在示例代码中所评论的，您可以将buildMsg方法移动到工厂类中。

但是，它比使用像这样的JBoss API要大一点。

我真的不知道它有什么更大的。如果您发现大多数时候MapMessage中只有一两个项在更改，那么您可以轻松地编写与您提到的API类似的非常特定的方法。要添加到上面的示例中：

public static MapMessage reallySpecificLogMessage(String details){
    return buildMsg("My specific message title", "My specific description",
            "My specific response action", details);
}