Question

我想找一个API，它允许我在我的应用程序的所有关键日志点中提供特定的规范集信息。更具体地说，它将是一个包含以下信息的多行消息（除基础知识外）：

记录类别
简短说明标题
描述
我的申请将采取的响应行动（损害控制）
详细信息（例外信息等）

使用单个多行日志查看，例如：

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 source中找到的一些代码示例。消息格式声明可以在单个文件中定义，如下所示：

   @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);

可以通过编写以下内容在代码中记录line with this message：

ActiveMQUtilLogger.LOGGER.failedToParseAddressList(e, addressList);

这是我能找到的最接近我正在寻找的东西。很酷。但是，我没有使用JBoss（也不想锁定该API）。

我可以使用LOG4J，其中StructuredDataMessage and Structured Data Lookup可以在布局中使用，我默认最终使用它;我的代码可以委托给一些StructuredDataMessage工厂来解决这个问题。但是，它比使用像JBoss API这样的东西有点笨重。

是否有人对此问题有任何建议 - 无论是其他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

最后的一些想法：

我的代码可以委托给一些StructuredDataMessage工厂来解决这个问题

我同意，工厂模式在这里是个不错的选择。正如我在示例代码中所评论的那样，您可以将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);
}

您可能希望将常量分配给此方法中使用的字符串，但正如我所说，这只是一个简单的示例。

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

1 个答案: