应用中日志的优雅使用(整合log4j2与SLF4J)

已于 2023-04-04 19:56:13 修改
阅读量1.3k 收藏 1
点赞数
分类专栏： JAVA 文章标签： log4j java
于 2023-04-04 18:05:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43820556/article/details/129958507
版权

应用中日志的优雅使用(整合log4j2与SLF4J)

一些基础原则(来自阿里java开发手册)

  1. 应用中不可直接使用日志系统（ Log4j、 Logback） 中的 API，而应依赖使用日志框架（ SLF4J、 JCL–Jakarta Commons Logging） 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

    日志框架（ SLF4J、 JCL–Jakarta Commons Logging）的使用方式（推荐使用 SLF4J）

    import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Test.class);

  2. 所有日志文件至少保存 15 天，因为有些异常具备以“周” 为频次发生的特点。 对于当天日志，以“应用名.log” 来保存，保存在/home/用户名/software/应用名/logs/目录下，过往日志格式为: {logname}.log.{保存日期}.gz，日期格式： yyyy-MM-dd 。

  3. 在日志输出时，字符串变量之间的拼接使用占位符的方式 。

    LOGGER.info("SparkApp state: {}.", handle.getState().toString());

  4. 对于trace/debug级别的日志输出，必须进行日志级别的开关判断。

    if (LOGGER.isDebugEnabled()) {
            LOGGER.debug("hadoopConfDir=[{}].", hadoopConfDir);
            LOGGER.debug("yarnConfDir=[{}].", hadoopConfDir);
            LOGGER.debug("javaHome=[{}].", javaHome);
            LOGGER.debug("sparkHome=[{}].", sparkHome);
            LOGGER.debug("appReSourcePath=[{}].", appReSourcePath);
            LOGGER.debug("appMainClass=[{}].", appMainClass);
            LOGGER.debug("hadoopUserName=[{}].", hadoopUserName);
            LOGGER.debug("retryMaxCount[{}].", retryMaxCount);
}

  5. 禁止直接使用System.out或System.err输出日志或使用e.printStackTrace()打印异常堆栈。

    标准日志输出与标准错误输出文件每次 Jboss 重启时才滚动，如果大量输出送往这两个文件，容易造成文件大小超过操作系统大小限制。

  6. 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。

    logger.error("inputParams:{} and errorMessage:{}", 各类参数或者对象 toString(), e.getMessage(), e);

  7. 除非是海外项目或者国外服务器，需要全部英文。国内使用中文进行输出和注释，避免词不达意或解释歧义的情况。

使用实例 整合log4j2与SLF4J

结合使用的原理：通过SLF4J的api调用log4j2的api，再由log4j2的api调用log4j2的core。

gradle引入依赖

	// >>>>>>日志依赖>>>>>>
	// log4j2的日志实现核心包，其依赖了log4j-api（log4j2的日志门面）
    implementation group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.20.0'
    // log4j2和slf4j的连接包，版本与log4j2核心包一致
    implementation group: 'org.apache.logging.log4j', name: 'log4j-slf4j-impl', version: '2.20.0'
	// slf4j的日志门面
    implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.25'

创建log4j2.xml配置文件。

log4j2加载配置文件机制：

  1. Log4j将检查"log4j2.configurationFile"系统属性，如果设置了，将尝试使用与文件扩展名匹配的ConfigurationFactory来加载配置。请注意，这并不局限于本地文件系统中的某个位置，可能包含一个URL。
  2. 如果没有设置系统属性，属性ConfigurationFactory将在classpath中寻找log4j2-test.properties。
  3. 如果没有找到这样的文件，YAML ConfigurationFactory将在classpath中寻找log4j2-test.yaml或log4j2-test.yml。
  4. 如果没有找到这样的文件，JSON ConfigurationFactory将在classpath中寻找log4j2-test.json或log4j2-test.jsn。
  5. 如果没有找到这样的文件，XML ConfigurationFactory将在classpath中寻找log4j2-test.xml。
  6. 如果不能找到测试文件，属性ConfigurationFactory将在classpath中寻找log4j2.properties。
  7. 如果不能找到属性文件，YAML ConfigurationFactory将在classpath上寻找log4j2.yaml或log4j2.yml。
  8. 如果YAML文件无法定位，JSON ConfigurationFactory将在classpath上寻找log4j2.json或log4j2.jsn。
  9. 如果不能找到JSON文件，XML ConfigurationFactory将尝试在classpath上找到log4j2.xml。
  10. 如果不能找到配置文件，将使用DefaultConfiguration。这将导致日志输出到控制台。

示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
    <!-- 变量配置  -->
    <Properties>
        <!-- 日志目录，prd环境取值改为/opt/logs/monitor -->
        <Property name="log_path">/home/china-unicorn/logs/monitor</Property>
        <Property name="logfile">china-unicorn</Property>
        <Property name="layout_pattern">[%d][%p][%t][%c:%L] %m%n</Property>
        <Property name="file_pattern">${log_path}/${logfile}.log-%d{yyyy-MM-dd}-%i.gz</Property>
    </Properties>

    <!-- appender配置 -->
    <Appenders>
        <!-- 控制台 -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${layout_pattern}"/>
        </Console>
        <!-- 每天滚动文件 -->
        <RollingFile name="DailyRollingFile" fileName="${log_path}/${logfile}.log"
                     filePattern="${file_pattern}">
            <PatternLayout pattern="${layout_pattern}"/>
            <policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="20 MB"/>
            </policies>
            <!--i的滚动大小限制是100-->
            <DefaultRolloverStrategy max="100">
                <Delete basePath="${log_path}">
                    <IfFileName glob="${logfile}-*.log.gz">
                        <!--目标路径下满足文件名命名要求的文件，保留天数或者路径下文件总大小-->
                        <IfAny>
                            <IfLastModified age="7d"/>
                            <IfAccumulatedFileSize exceeds="500 MB"/>
                        </IfAny>
                    </IfFileName>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="DEBUG">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="DailyRollingFile"/>
        </Root>
    </Loggers>
</Configuration>

创建TestLog.java

package com.donny.bigdata.test;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;

/**
 * @author 1792998761@qq.com
 * @date 2023/4/3 19:47
 */
public class TestLog {
    private static final Logger LOGGER = LoggerFactory.getLogger(TestLog.class);

    static {
        // 初始化log4j2日志-- 采用将自定义配置文件路径的方式
        LoggerContext context = (org.apache.logging.log4j.core.LoggerContext) LogManager.getContext(false);
        File file = new File("conf/log4j2.xml");
        context.setConfigLocation(file.toURI());
        if (LOGGER.isDebugEnabled()) {
            LOGGER.debug("log4j2初始化完毕");
        }
    }

    public static void main(String[] args) {
        LOGGER.info("中文");
    }
}

结果

[2023-04-04 14:58:06,719][DEBUG][main][com.donny.bigdata.test.TestLog:23] log4j2初始化完毕
[2023-04-04 14:58:06,719][INFO][main][com.donny.bigdata.test.TestLog:28] 中文

Gradle下日志包的冲突

利用dependencies，打印出依赖树。

命令式gradle :${modulename}:dependencies,${modulename}是个占位符，里面用模块名（project）替换。或者使用IDEA开发也可以通过执行项目Gradle面板中Tasks->help->dependencies任务，也打印出该模块对应的依赖树。

依赖树中包含以下部分

  • annotationProcessor
  • compileClasspath
  • compileOnly
  • default
  • implementation
  • mainSourceElements
  • runtimeClasspath
  • runtimeElements
  • runtimeOnly
  • testAnnotationProcessor
  • testCompileClasspath
  • testCompileOnly
  • testImplementation
  • testResultsElementsForTest
  • testRuntimeClasspath
  • testRuntimeOnly

部分举例展示：

compileClasspath - Compile classpath for source set 'main'.
+--- org.apache.logging.log4j:log4j-core:2.20.0
|    \--- org.apache.logging.log4j:log4j-api:2.20.0
+--- org.slf4j:slf4j-api:1.7.25
+--- org.apache.logging.log4j:log4j-slf4j-impl:2.20.0
|    +--- org.apache.logging.log4j:log4j-api:2.20.0
|    \--- org.slf4j:slf4j-api:1.7.25
+--- com.sun.mail:jakarta.mail:2.0.1
|    \--- com.sun.activation:jakarta.activation:2.0.1
...
...
...

implementation - Implementation only dependencies for source set 'main'. (n)
+--- org.apache.logging.log4j:log4j-core:2.20.0 (n)
+--- org.slf4j:slf4j-api:1.7.25 (n)
+--- org.apache.logging.log4j:log4j-slf4j-impl:2.20.0 (n)
+--- com.sun.mail:jakarta.mail:2.0.1 (n)
+--- jakarta.mail:jakarta.mail-api:2.0.1 (n)
+--- io.netty:netty-all:4.1.90.Final (n)
+--- org.elasticsearch.client:elasticsearch-rest-high-level-client:6.7.2 (n)
+--- org.elasticsearch.client:transport:6.7.2 (n)
+--- org.elasticsearch.client:elasticsearch-rest-client:6.7.2 (n)
+--- org.elasticsearch.client:elasticsearch-rest-client-sniffer:6.7.2 (n)
+--- org.apache.hadoop:hadoop-client:2.7.3 (n)
+--- org.apache.spark:spark-core_2.11:2.3.3 (n)
+--- org.apache.kafka:kafka-clients:1.0.0 (n)
+--- org.apache.hbase:hbase-client:1.1.2 (n)
+--- org.apache.hive:hive-jdbc:1.2.1 (n)
+--- com.clickhouse:clickhouse-jdbc:0.4.0 (n)
\--- org.apache.zookeeper:zookeeper:3.4.6 (n)
...
...
...

runtimeClasspath - Runtime classpath of source set 'main'.
+--- org.apache.logging.log4j:log4j-core:2.20.0
|    \--- org.apache.logging.log4j:log4j-api:2.20.0
+--- org.slf4j:slf4j-api:1.7.25
+--- org.apache.logging.log4j:log4j-slf4j-impl:2.20.0
|    +--- org.apache.logging.log4j:log4j-api:2.20.0
|    +--- org.slf4j:slf4j-api:1.7.25
|    \--- org.apache.logging.log4j:log4j-core:2.20.0 (*)
+--- com.sun.mail:jakarta.mail:2.0.1
|    \--- com.sun.activation:jakarta.activation:2.0.1
+--- jakarta.mail:jakarta.mail-api:2.0.1
...
...
...

在其中寻找冲突的包。

处理方式

  1. 优先排除冲突依赖

        implementation("org.apache.hadoop:hadoop-client:2.9.1") {
        exclude group: 'org.slf4j', module: 'slf4j-log4j12'
    }

  2. 强制使用某个依赖

    configurations.all {
    resolutionStrategy {
        force 'org.slf4j:slf4j-api:1.7.25'
    }
}
顧棟
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
log4j-core-2.10.0.jar
12-30
用于Structs2框架 从Apach包中找到，在官方网站下载log4j包从中找到
使用Slf4j集成Log4j2构建项目日志系统的解决方案(不使用Common-logging、Log4j)
u011930054的博客
03-11 1110
使用Slf4j集成Log4j2构建项目日志系统的解决方案1、Log4j、SLF4J、Common-logging的区别1.1、slf4j1.2、Log4j与Log4j2的区别2、使用Slf4j集成Log4j2构建项目日志系统2.1搭建步骤 1、Log4j、SLF4J、Common-logging的区别 slf4j和commons-logging都是日志框架的规范，本身实现很弱，Log4j主要是针对...
springboot整合log4j2
小白向上爬的博客
12-22 661
springboot+log4j2 1：maven下载jar包 <!-- log4j2--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>
Java的常用日志技术（三）Log4j2及Log4j2与slfj整合详解
qq_41946216的博客
06-04 3490
log4j2
log4j2与slf4j配合使用
cxy1991xm的博客
03-25 1149
一、在pom.xml文件中添加依赖 <!--log4j2依赖包--> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.6.2&lt...
log4j2与slf4j整合
w727655308的博客
10-20 1529
log4j2 log4j2与slf4j整合
Java框架——日志整合slf4j+log4j2
qq_51936245的博客
05-28 2790
ApacheLog4j 2是对Log4j的升级，它比其前身Log4j 1.x提供了重大改进，并提供了Logback中可用的许多改进，同时修复了Logback架构中的一些问题。被誉为是目前最优秀的Java日志框架log4j是apache实现的一个开源日志组件logback同样是由log4j的作者设计完成的，拥有更好的特性，用来取代log4j的一个日志框架，是slf4j的原生实现Log4j2。
用Slf4j集成Log4j2构建项目日志系统的完美解决方案
myli92的博客
08-12 700
一、背景 　　最近因为公司项目性能需要，我们考虑把以前基于的log4j的日志系统重构成基于Slf4j和log4j2的日志系统，因为，使用slf4j可以很好的保证我们的日志系统具有良好的兼容性，兼容当前常见几种日志系统，而使用log4j2而不是log4j是因为Log4j 1.x 在高并发情况下出现死锁导致cpu使用率异常飙升，而Log4j2.0基于LMAX Disruptor的异步日志在多线程环境下性能会远远优于Log4j 1.x和logback（官方数据是10倍以上）。 　　关于slf4j的原理以及优点
Log4j 2 + Slf4j 的配置和使用
t1993ing的博客
05-18 1107
Log4j 2 + Slf4j 的配置和使用 Log4j 2是log4j 1.x和logback的改进版，据说采用了一些新技术（无锁异步、等等），使得日志的吞吐量、性能比log4j 1.x提高10倍，并解决了一些死锁的bug，而且配置更加简单灵活。下面是结合slf4j的配置和使用过程： 1、引用依赖包及相关注释： >org.apache.logging.log4j>2.2>
ConcurrentHashMap
zhaoyang10的专栏
01-04 198
来源： http://www.cnblogs.com/dolphin0520/p/3932905.html
使用Slf4j集成Log4j2构建项目日志系统的完美解决方案.docx
10-26
使用Slf4j集成Log4j2构建项目日志系统的完美解决方案.docx
hibernate的log4j日志文件需要用到的jar
05-08
Hibernate中使用slf4j技术，即简单日志门面（Simple Logging Facade for Java），它服务于各种各样的日志系统，用于整合其他日志系统。此资源就是整合log4j的日志。
iBase4J分布式系统-其他
06-12
Spring-Session日志管理：SLF4J、Log4j2前端框架：Angular JS + Bootstrap + Jquery启动说明：* 项目依赖activemq、Redis和ZooKeeper服务。* 使用nginx代理UI：修改配置里的UI目录后重启nginx。* 启动方法：...
springboot2-log4j2-demo:springboot2+log4j2简单demo
05-17
##v1.0 因为springboot2的log4j2自动集成了Slf4j，所以配置起来十分方便，只需要配置log4j2就可以了。 第一版为简单配置 第二版配置更加全面 #第二版第一次提交，梳理了日志输入是逻辑，可以只输入info日志，或者...
SpringBoot Logback日志记录到数据库的实现方法
08-25
主要介绍了SpringBoot Logback日志记录到数据库的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
VC2022 + protobuf
weixin_44193239的博客
04-27 300
笔者用比较直接的方法，初步搞定VC2022上集成protobuf 新版本， 最艰难的是搞定Abseil部分，希望能够帮助到大家。
实现SpringMVC底层机制（三）
最新发布
Sun的个人博客
04-27 994
*** @author 孙显圣*/ @Target(ElementType . PARAMETER) //作用于方法中的参数 @Retention(RetentionPolicy . RUNTIME) //作用范围 @Documented public @interface RequestsParam {/*** @author 孙显圣。
【注解和反射】获取类运行时结构
qq_45956730的博客
04-24 636
获取类运行时结构
mybatisPlus使用MetaObjectHandler对字段进行更新
m0_56356631的博客
04-23 372
都是符合我们的预期的。
springboot整合slf4j日志
06-28
### 回答1： Spring Boot可以很方便地整合SLF4J日志框架，只需要在pom.xml文件中添加相应的依赖即可。具体步骤如下： 1. 在pom.xml文件中添加以下依赖： ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency> ``` 2. 在application.properties文件中配置日志级别和输出格式，例如： ``` logging.level.root=INFO logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n ``` 3. 在代码中使用SLF4J进行日志输出，例如： ``` import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class MyController { private static final Logger logger = LoggerFactory.getLogger(MyController.class); public void myMethod() { logger.info("This is a log message."); } } ``` 以上就是Spring Boot整合SLF4J日志的基本步骤。 ### 回答2： SLF4J是一个在Java应用程序中使用日志的简单抽象工具，它可以帮助开发者集成不同的日志框架，如logback, log4j或java.util.logging。Spring Boot作为一种流行的Java框架，提供了丰富的工具来简化应用程序的开发，其中就包括日志记录。 在Spring Boot中，将SLF4J与其他日志框架整合非常简单。首先，我们需要在pom.xml文件中添加所需的依赖项，例如： ```xml <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.7.30</version> </dependency> </dependencies> ``` 在这个例子中，我们添加了一个简单的依赖项，该依赖项将SLF4J与默认的Simple工厂一起使用，以便在控制台上记录日志消息。 接下来，我们需要在应用程序中使用SLF4J记录日志消息。这可以通过在我们的类中添加以下代码行来完成： ```java import org.slf4j.Logger; import org.slf4j.LoggerFactory; @RestController public class MyController { private Logger logger = LoggerFactory.getLogger(MyController.class); @GetMapping("/hello") public String sayHello() { logger.info("Hello from SLF4J"); return "Hello"; } } ``` 在这个例子中，我们首先导入了Logger和LoggerFactory类。然后，我们在我们的控制器类中添加了一个Logger实例，该实例将我们的日志记录到控制台上。最后，我们在GetMapping方法中使用该实例记录一条信息。 当我们运行我们的应用程序并访问/hello端点时，我们将在控制台上看到以下输出： ``` 2021-10-01 12:00:00.000 INFO 12345 --- [nio-8080-exec-1] com.example.demo.MyController : Hello from SLF4J ``` 这就是整合过程的简单演示。通过这个简单的例子，我们可以轻松地在Spring Boot应用程序中使用SLF4J进行日志记录。最后，使用SLF4J可以帮助我们将应用程序与日志框架进行解耦，使我们的应用程序更加灵活和可维护。 ### 回答3： Spring Boot 是一种用于创建微服务的框架，它将应用程序所需的所有配置和依赖项打包在一起，以便快速轻松地开发和部署应用程序。在 Spring Boot 中整合 SLF4J 日志系统非常简单，只需要进行以下几个步骤： 1.在 pom.xml 文件中添加所需的依赖项： ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> ``` spring-boot-starter-logging 包的作用是引入 Spring Boot 应用程序的默认日志记录器 Logback，而 slf4j-api 是 SLF4J 日志系统的 API 接口，logback-classic 则是具体的日志实现。 2.在 application.properties 文件中配置日志记录器的属性： ``` # 根日志级别 logging.level.root=INFO # 控制台的日志级别 logging.level.org.springframework.web=DEBUG # 日志文件的输出路径 logging.file=/var/log/myapplication.log ``` 在上面的例子中，我们设置根日志级别为 INFO，控制台日志级别为 DEBUG，并在 /var/log/myapplication.log 文件中输出日志。 3.在代码中使用 SLF4J 记录日志： ``` import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class MyService { private static final Logger logger = LoggerFactory.getLogger(MyService.class); public void doSomething() { logger.debug("Doing something"); logger.info("Did something"); logger.error("Failed to do something"); } } ``` 在上面的代码中，我们使用了 SLF4J 的 getLogger() 方法来获取 MyService 类的日志记录器，然后使用 debug()、info() 和 error() 方法记录不同级别的日志。 通过上述步骤，我们就可以在 Spring Boot 应用程序中使用 SLF4J 记录日志了。值得注意的是，在开发调试时，可以将日志级别设置为 DEBUG，以便查看更详细的日志信息。而在生产环境中，应该将日志级别设置为 WARN 或 ERROR，以避免过多的日志输出。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值