java - 登录一个 json 文件
问题描述
我的应用程序使用 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 服务的角度拦截器手动执行此操作。然后,Web 服务将调用将数据附加到 json 文件中的异步 spring 服务。使用此解决方案,我将不得不擦除一周前的数据,这感觉就像重新创建轮子一样。
使用 log4j2 或 logback 等日志库。在 log4j2 中有 JsonLayout 可以帮助我使用包含“KeyValuePairs”列表的“loggerFields”来执行此操作,以便将自定义字段放入我的 json 中,但我有 3 个问题:
- 如何将我自己的值放入不是预定义的 %c、%t...等。也许是这样的: Logger.info("event", "userid", "1", "ipAddress", "xxxx"...etc); ?
使用该方法似乎会生成一个带有“消息”字段的 json,其中包含我的自定义值。如何将它们放在我上面给出的示例中的事件对象的根级别?
恐怕这会与我的默认 Spring Boot 记录器配置冲突,因为我还需要使用将日志写入普通日志文件的默认日志系统。我可以创建一个 Logger.someOtherLevelThanInfoDebugErrorWarn("",""); ?
先感谢您
解决方案
关于你问题的这一部分:
- 使用 log4j2 或 logback 等日志库。在 log4j2 中有 JsonLayout 可以帮助我使用包含“KeyValuePairs”列表的“loggerFields”来执行此操作,以便将自定义字段放入我的 json 中,但我有 3 个问题:
- 如何将我自己的值放入不是预定义的 %c、%t...等。也许是这样的: Logger.info("event", "userid", "1", "ipAddress", "xxxx"...etc); ?
我认为在这个要点中,您要问的是如何将动态变量的值注入到JsonLayout
'KeyValuePair
元素中。答案是您将使用查找,就像在JsonLayout 文档末尾的示例中一样 - 类似于<KeyValuePair key="additionalField2" value="$${ctx:key}"/>
- 使用该方法似乎会生成一个带有“消息”字段的 json,其中包含我的自定义值。如何将它们放在我上面给出的示例中的事件对象的根级别?
我建议您回到上述内容 - 如果您使用查找,数据将被放置在生成的 JSON 中其自己的键下。
- 恐怕这会与我的默认 Spring Boot 记录器配置冲突,因为我还需要使用将日志写入普通日志文件的默认日志系统。我可以创建一个 Logger.someOtherLevelThanInfoDebugErrorWarn("",""); ?
您可以通过多种方式将其他日志事件与 JSON 事件分开。我建议您将标记与MarkerFilter一起使用, 或者创建一个具有特殊名称的记录器配置(我建议仔细阅读 log4j2 手册的架构页面以了解记录器名称的工作原理)。例如,如果您要创建一个具有特殊名称的记录器配置,您可能会执行以下操作:
private static final Logger JSON_EVENT_LOGGER = LogManager.getLogger("JSON_EVENT_LOGGER");
这将像这样在您的配置中定义(假设 XML 配置):
<Logger name="JSON_EVENT_LOGGER" additivity="false">
...
</Logger>
我建议您阅读有关additivity 属性的内容,以便您很好地理解为什么在这里将其设置为 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
这是一个非常简单的示例,说明如何使用 aMarker
和 theMarkerFilter
来实现类似的结果。
首先是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 个附加程序,但只有一个记录器配置 ( 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 输出非常不同。
推荐阅读
- javascript - 需要在函数中使用用户的输入
- javascript - 在 Angular 的 tinymce 编辑器中删除图片时无法从服务器中删除图片
- r - H2o.mojo_predict_df 给出退出状态 1
- jupyter-notebook - Jupyter Notebook 上的白线阻止内核运行单元格
- java - Java 11 获取当前的微秒?
- r - 使用 Leafpop 将图像添加到地图
- python - 如何摆脱异常处理
- javascript - React Native - 使图像大小适应布局
- android - 在 React Native Expo 中运行后台工作程序以执行密集任务
- r - 使用 browser() 语句调试 R Shiny 不会那么痛苦