记录简单 java 项目
Logging for simple java project
希望这个问题比我之前的问题更清楚。
我有一个项目 A (PA),它有一个简单的 Java API。我有一个项目 B (PB),它只是一个围绕 PA 的 main() 包装器。然后我有一个项目 C (PC),其中包含一个将 PB 作为实用程序调用的自定义类加载器。 PC 使用 PB 中的 STD_OUT 和 STD_ERR。
目前,PA 只是返回值,PB 正在使用 System.out 和 System.err 进行值报告和错误报告。我想更改 PA 和 PB 以使用 log4j2。
PC 很大,有自己的 log4j2 配置和许多日志文件。如何配置 PA 和 PB 的日志记录,以便 PC 的行为可以照原样继续?
我的猜测:
- PA 应该只调用 .getLogger(className());并以这种方式记录事情。
- PB 应以编程方式添加到 PC 的 log4j 配置中,添加以下内容。
- 由于 PB 不知道 PC 的 log4j 配置是什么,添加 2 个新的 appender 到 LoggerContext.getContext().getconfiguration()。一个用于 sysout,一个用于 syserr。
- 使用这 2 个专门用于 PB 的新附加程序创建一个记录器。
小型开源项目通常采用这种方式吗?
下面的代码直接来自 log4j 站点,似乎就是这样做的(尽管它目前无法编译):
final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
final Configuration config = ctx.getConfiguration();
Layout layout = PatternLayout.createLayout(PatternLayout.SIMPLE_CONVERSION_PATTERN, config, null,
null,null, null);
Appender appender = FileAppender.createAppender("target/test.log", "false", "false", "File", "true",
"false", "false", "4000", layout, null, "false", null, config);
appender.start();
config.addAppender(appender);
AppenderRef ref = AppenderRef.createAppenderRef("File", null, null);
AppenderRef[] refs = new AppenderRef[] {ref};
LoggerConfig loggerConfig = LoggerConfig.createLogger("false", "info", "org.apache.logging.log4j",
"true", refs, null, config, null );
loggerConfig.addAppender(appender, null, null);
config.addLogger("org.apache.logging.log4j", loggerConfig);
ctx.updateLoggers();
较小的开源类型库通常使用日志外观(SLF4J 就是这样的外观之一)并且根本不用担心配置日志......它们让应用程序决定使用哪个日志实现,要记录哪些类别、严重性阈值、将日志消息写入何处等
由于您的项目 C 读取项目 B 的标准输出和标准错误,我想知道您是否需要项目 B 中的日志记录框架的灵活性,因为听起来项目 B 的输出是固定的并且不需要可配置。
您是否尝试过将 A 和 B 项目指向单独的 Log4j2 配置文件和系统 属性 -Dlog4j.configurationFile=path/to/log4j2.xml
?
更新:
如果您必须共享 Log4j2 配置文件,您可以考虑使用 XInclude 来包含 A/B 项目所需的一些特殊配置。
见https://logging.apache.org/log4j/2.x/manual/configuration.html#XInclude
另外,可以指定多个配置文件,让Log4j2合并。这记录在这里:https://logging.apache.org/log4j/2.x/manual/configuration.html#CompositeConfiguration
希望这个问题比我之前的问题更清楚。
我有一个项目 A (PA),它有一个简单的 Java API。我有一个项目 B (PB),它只是一个围绕 PA 的 main() 包装器。然后我有一个项目 C (PC),其中包含一个将 PB 作为实用程序调用的自定义类加载器。 PC 使用 PB 中的 STD_OUT 和 STD_ERR。
目前,PA 只是返回值,PB 正在使用 System.out 和 System.err 进行值报告和错误报告。我想更改 PA 和 PB 以使用 log4j2。
PC 很大,有自己的 log4j2 配置和许多日志文件。如何配置 PA 和 PB 的日志记录,以便 PC 的行为可以照原样继续?
我的猜测:
- PA 应该只调用 .getLogger(className());并以这种方式记录事情。
- PB 应以编程方式添加到 PC 的 log4j 配置中,添加以下内容。
- 由于 PB 不知道 PC 的 log4j 配置是什么,添加 2 个新的 appender 到 LoggerContext.getContext().getconfiguration()。一个用于 sysout,一个用于 syserr。
- 使用这 2 个专门用于 PB 的新附加程序创建一个记录器。
小型开源项目通常采用这种方式吗?
下面的代码直接来自 log4j 站点,似乎就是这样做的(尽管它目前无法编译):
final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
final Configuration config = ctx.getConfiguration();
Layout layout = PatternLayout.createLayout(PatternLayout.SIMPLE_CONVERSION_PATTERN, config, null,
null,null, null);
Appender appender = FileAppender.createAppender("target/test.log", "false", "false", "File", "true",
"false", "false", "4000", layout, null, "false", null, config);
appender.start();
config.addAppender(appender);
AppenderRef ref = AppenderRef.createAppenderRef("File", null, null);
AppenderRef[] refs = new AppenderRef[] {ref};
LoggerConfig loggerConfig = LoggerConfig.createLogger("false", "info", "org.apache.logging.log4j",
"true", refs, null, config, null );
loggerConfig.addAppender(appender, null, null);
config.addLogger("org.apache.logging.log4j", loggerConfig);
ctx.updateLoggers();
较小的开源类型库通常使用日志外观(SLF4J 就是这样的外观之一)并且根本不用担心配置日志......它们让应用程序决定使用哪个日志实现,要记录哪些类别、严重性阈值、将日志消息写入何处等
由于您的项目 C 读取项目 B 的标准输出和标准错误,我想知道您是否需要项目 B 中的日志记录框架的灵活性,因为听起来项目 B 的输出是固定的并且不需要可配置。
您是否尝试过将 A 和 B 项目指向单独的 Log4j2 配置文件和系统 属性 -Dlog4j.configurationFile=path/to/log4j2.xml
?
更新:
如果您必须共享 Log4j2 配置文件,您可以考虑使用 XInclude 来包含 A/B 项目所需的一些特殊配置。
见https://logging.apache.org/log4j/2.x/manual/configuration.html#XInclude
另外,可以指定多个配置文件,让Log4j2合并。这记录在这里:https://logging.apache.org/log4j/2.x/manual/configuration.html#CompositeConfiguration