java - 登录一个json文件

Question

我的应用程序使用 angular 7 和 spring boot 2 运行。每次用户与应用程序交互(单击某些按钮或链接)时，我都需要将一些数据存储在 json 文件中。 json 应该看起来像这样(只是一个例子):

[
 "event": {

   userid : 1
   ipAddress : x.x.x.x
   lastConnectionDateTime : ...,
   action : "click on link 1"
 },
 "event": {

   userid : 2
   ipAddress : y.y.y.y
   lastConnectionDateTime : ...,
   action : "click on button THE_BUTTON" 
 },
 ...
]

我看到 2 个选项:

• 使用异步调用网络服务的角度拦截器手动执行此操作。然后，Web 服务将调用异步 spring 服务，将数据附加到 json 文件中。使用此解决方案，我将不得不清除自己一周前的数据，这感觉就像重新造轮子一样。

• 使用 log4j2 或 logback 等日志库。在 log4j2 中有 JsonLayout 可以帮助我使用包含“KeyValuePairs”列表的“loggerFields”来将自定义字段放入我的 json，但我有 3 个问题:

  • 如何将我自己的值放入不是预定义的 %c、%t...等。也许是这样的:Logger.info("event", "userid", "1", "ipAddress", "x.x.x.x"...etc); ？

  • 使用该方法似乎会生成一个带有“消息”字段的 json，其中包含我的自定义值。如何将它们放在我的事件对象的根级别，就像我在上面给出的示例中那样？

  • 恐怕这会与我的默认 spring boot 记录器配置冲突，因为我还需要使用将日志写入普通日志文件的默认日志记录系统。我可以读一个 Logger.someOtherLevelThanInfoDebugErrorWarn("",""); ?

提前谢谢你

Answer 1

关于你的这部分问题:

• using logging libraries like log4j2 or logback. In log4j2 there is JsonLayout that could help me do this with "loggerFields" containing a List of "KeyValuePairs" to put custom fields in my json but i have 3 problems with this :
  • how to put my own values in that are not the pre-defined %c, %t...etc. Maybe something like this : Logger.info("event", "userid", "1", "ipAddress", "x.x.x.x"...etc); ?

我认为在这个要点中，您是在询问如何将动态变量的值注入(inject)到 JsonLayout 中。的 KeyValuePair元素。答案是你会使用 lookup就像 JsonLayout documentation 末尾的示例一样- 类似于 <KeyValuePair key="additionalField2" value="$${ctx:key}"/>

• using the method seems to produces a json with a "message" field that contains my custom values. how to put them in the root level of my event objects like in the example i gave above ?

我建议你回到上面 - 如果你使用 lookup数据将放置在生成的 JSON 中自己的 key 下。

• i'm afraid this will conflict with my default spring boot logger configuration cause i also need to use the default logging system that writes logs in a normal log file. Can i cread a Logger.someOtherLevelThanInfoDebugErrorWarn("",""); ?

您可以通过多种方式将其他日志事件与 JSON 事件分开。我建议你看看使用 markers连同 MarkerFilter 或创建具有特殊名称的记录器配置(我建议仔细阅读 log4j2 手册的 architecture page 以了解记录器名称的工作原理)。例如，如果您要创建一个具有特殊名称的记录器配置，您可能会这样做:

private static final Logger JSON_EVENT_LOGGER = LogManager.getLogger("JSON_EVENT_LOGGER");

这将在您的配置中像这样定义(假设 XML 配置):

<Logger name="JSON_EVENT_LOGGER" additivity="false">
    ...
</Logger>

我建议您阅读 additivity attribute这样你就很好理解为什么这里设置为false了。基本上您不希望这些 json 日志事件转到任何父记录器的附加程序。

---

这是一个非常简单的示例，它使用第二种方法创建具有特殊名称的记录器配置:

首先是一个java类来生成一些日志事件:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;


public class SomeClass {

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

    public static void main(String[] args){
        ThreadContext.put("userid", "1");
        ThreadContext.put("ipAddress", "127.0.0.1");
        ThreadContext.put("lastConnectionDateTime", "...timestamp...");
        ThreadContext.put("action", "click link 1");
        JSON_EVENT_LOGGER.info("A JSON message uses the special logger");

        log.info("A non-json message uses the normal logger");
    }
}

现在是一个定义记录器和附加器的 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} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <Console name="ConsoleJSON" target="SYSTEM_OUT">
            <JsonLayout compact="false" eventEol="true" stacktraceAsString="true">
                <KeyValuePair key="userid" value="$${ctx:userid}"/>
                <KeyValuePair key="ipAddress" value="$${ctx:ipAddress}"/>
                <KeyValuePair key="lastConnectionDateTime" value="$${ctx:lastConnectionDateTime}"/>
                <KeyValuePair key="action" value="$${ctx:action}"/>
            </JsonLayout>
        </Console>

    </Appenders>

    <Loggers>
        <Root level="INFO">
            <AppenderRef ref="Console"/>
        </Root>
        <Logger name="JSON_EVENT_LOGGER" level="ALL" additivity="false">
            <Appenderref ref="ConsoleJSON"/>
        </Logger>
    </Loggers>
</Configuration>

当执行 java 类时，控制台中会生成以下日志:

{
  "thread" : "main",
  "level" : "INFO",
  "loggerName" : "JSON_EVENT_LOGGER",
  "message" : "A JSON message uses the special logger",
  "endOfBatch" : false,
  "loggerFqcn" : "org.apache.logging.log4j.spi.AbstractLogger",
  "instant" : {
    "epochSecond" : 1576215690,
    "nanoOfSecond" : 541000000
  },
  "threadId" : 1,
  "threadPriority" : 5,
  "userid" : "1",
  "ipAddress" : "127.0.0.1",
  "lastConnectionDateTime" : "...timestamp...",
  "action" : "click link 1"
}
23:41:30.653 [main] INFO  example.SomeClass - A non-json message uses the normal logger

---

这是一个如何使用 Marker 的非常简单的示例和 MarkerFilter达到类似的结果。

首先是java类:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.MarkerManager;
import org.apache.logging.log4j.ThreadContext;

public class SomeClass2 {

    private static final Logger log = LogManager.getLogger();
    private static final Marker JSON_EVENT = MarkerManager.getMarker("JSON_EVENT");

    public static void main(String[] args){
        ThreadContext.put("userid", "1");
        ThreadContext.put("ipAddress", "127.0.0.1");
        ThreadContext.put("lastConnectionDateTime", "...timestamp...");
        ThreadContext.put("action", "click link 1");
        log.info(JSON_EVENT, "A JSON message uses the special logger");

        log.info("A non-json message uses the normal logger");
    }
}

请注意此处的差异 - 只有 1 个记录器对象用于两种类型的消息，并且对记录器的一次调用包括 Marker以表明这是一个 JSON 事件。

接下来是log4j2.xml配置:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <MarkerFilter marker="JSON_EVENT" onMatch="DENY" onMismatch="NEUTRAL"/>
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <Console name="ConsoleJSON" target="SYSTEM_OUT">
            <MarkerFilter marker="JSON_EVENT" onMatch="ACCEPT" onMismatch="DENY"/>
            <JsonLayout compact="false" eventEol="true" stacktraceAsString="true">
                <KeyValuePair key="userid" value="$${ctx:userid}"/>
                <KeyValuePair key="ipAddress" value="$${ctx:ipAddress}"/>
                <KeyValuePair key="lastConnectionDateTime" value="$${ctx:lastConnectionDateTime}"/>
                <KeyValuePair key="action" value="$${ctx:action}"/>
            </JsonLayout>
        </Console>

    </Appenders>

    <Loggers>
        <Root level="INFO">
            <AppenderRef ref="Console"/>
            <Appenderref ref="ConsoleJSON"/>
        </Root>
    </Loggers>
</Configuration>

再次注意这里的区别 - 有 2 个 appender 但只有一个记录器配置 ( Root )。 Root 记录器指定两个附加程序，然后附加程序负责使用 MarkerFilter 过滤事件。 .

最后，运行 java 代码的结果输出:

{
  "thread" : "main",
  "level" : "INFO",
  "loggerName" : "example.SomeClass2",
  "marker" : {
    "name" : "JSON_EVENT"
  },
  "message" : "A JSON message uses the special logger",
  "endOfBatch" : false,
  "loggerFqcn" : "org.apache.logging.log4j.spi.AbstractLogger",
  "instant" : {
    "epochSecond" : 1576275417,
    "nanoOfSecond" : 684000000
  },
  "threadId" : 1,
  "threadPriority" : 5,
  "userid" : "1",
  "ipAddress" : "127.0.0.1",
  "lastConnectionDateTime" : "...timestamp...",
  "action" : "click link 1"
}
16:16:57.756 [main] INFO  example.SomeClass2 - A non-json message uses the normal logger

---

注意:我使用的是 log4j2 版本 2.11.1，如果您使用较新的版本，您可能会看到不同的结果。当我在 2.12.1 中尝试这些相同的示例时，JSON 输出非常不同。