log4j使用实战

前言:

每次排查log相关的问题总会被逼疯,log4j、logback、log4j2这几个之间的关系,尤其再加上slf4j,那酸爽,经历过的人都懂。

所以才促成了笔者这一个系列的博客:log4j实战、logback实战、log4j2实战。

我们从三个方法来实战每一种log类型:log单独使用、log与slf4j的组合、springboot与log的组合。

当然,笔者这个系列的文章,并不是科普类文章,有关于log.xml如何配置这些知识点网络上已经有很多文章了,不再赘述。

希望整理完这个系列之后,我们都能了解在具体的场景下如何使用每种log。

1.log4j单独使用实战

1.1 引入maven依赖

<dependency>
	<groupId>log4j</groupId>
	<artifactId>log4j</artifactId>
	<version>1.2.17</version>
</dependency>

1.2 配置log4j.xml

在项目resources目录下直接创建log4j.xml,具体内容格式参考下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//log4j/log4j Configuration//EN" "log4j.dtd">
<log4j:configuration>
    <!-- 日志输出到控制台 -->
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <!-- 日志输出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
        <!--过滤器设置输出的级别-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 设置日志输出的最小级别 -->
            <param name="levelMin" value="INFO"/>
            <!-- 设置日志输出的最大级别 -->
            <param name="levelMax" value="ERROR"/>
        </filter>
    </appender>

    <!-- 输出日志到文件 -->
    <appender name="fileAppender" class="org.apache.log4j.FileAppender">
        <!-- 输出文件全路径名-->
        <param name="File" value="/data/applogs/own/fileAppender.log"/>
        <!--是否在已存在的文件追加写:默认时true,若为false则每次启动都会删除并重新新建文件-->
        <param name="Append" value="false"/>
        <param name="Threshold" value="INFO"/>
        <!--是否启用缓存,默认false-->
        <param name="BufferedIO" value="false"/>
        <!--缓存大小,依赖上一个参数(bufferedIO), 默认缓存大小8K  -->
        <param name="BufferSize" value="512"/>
        <!-- 日志输出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>

    <!-- 日志输出到文件,可以配置多久产生一个新的日志信息文件 -->
    <appender name="dailyRollingAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 文件文件全路径名 -->
        <param name="File" value="/data/applogs/own/dailyRollingAppender.log"/>
        <param name="Append" value="true"/>
        <!-- 设置日志备份频率,默认:为每天一个日志文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'"/>

        <!--每分钟一个备份-->
        <!--<param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>


    <!--
        1. 指定logger的设置,additivity是否遵循缺省的继承机制
        2. 当additivity="false"时,root中的配置就失灵了,不遵循缺省的继承机制
        3. 代码中使用Logger.getLogger("logTest")获得此输出器,且不会使用根输出器
    -->
    <logger name="com.log.test.LogTest" additivity="false">
        <level value="INFO"/>
        <appender-ref ref="console"/>
    </logger>


    <!-- 根logger的设置,若代码中未找到指定的logger,则会根据继承机制,使用根logger-->
    <root>
        <appender-ref ref="console"/>
        <appender-ref ref="fileAppender"/>
        <appender-ref ref="dailyRollingAppender"/>
    </root>

</log4j:configuration>

1.3 类中使用log4j

import org.apache.log4j.Logger;
public class LogTest {
    private static final Logger logger = Logger.getLogger(LogTest.class);
    public static void main(String[] args) {

        logger.debug("debug msg");
        logger.info("info msg");
        logger.warn("warn msg");
        logger.error("error msg");
    }
}

1.4 验证结果

由于在log4j.xml中配置了关于com.log.test.LogTest的logger,默认级别为INFO,输出appender-ref为console,所以我们能从控制台上看到以下结果:

[INFO][2022-04-09 10:24:40 053][com.log.test.LogTest]-[info msg]
[WARN][2022-04-09 10:24:40 073][com.log.test.LogTest]-[warn msg]
[ERROR][2022-04-09 10:24:40 073][com.log.test.LogTest]-[error msg]

2.log4j与slf4j组合使用

依旧按照上述格式,我们来组合使用两者

2.1 引入maven依赖

       <!-- log4j依赖包 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <!-- slf4j-log4j依赖包 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.21</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.21</version>
        </dependency>

注意:slf4j-api包为slf4j自身的包,slf4j-log4j12为slf4j与log4j的关联包

2.2 配置log4j.xml

同1.2

2.3 类中使用slf4j

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

public class Log_slf4j_Test {

    private static Logger logger = LoggerFactory.getLogger(Log_slf4j_Test.class);
    public static void main(String[] args) {

        logger.debug("debug msg");
        logger.info("info msg");
        logger.warn("warn msg");
        logger.error("error msg");
    }
}

注意:这里与1.3中有所不同,这里通过slf4j的LoggerFactory来获取具体Logger对象

2.4 验证结果

[INFO][2022-04-09 10:31:23 603][com.log.test.Log_slf4j_Test]-[info msg]
[WARN][2022-04-09 10:31:23 615][com.log.test.Log_slf4j_Test]-[warn msg]
[ERROR][2022-04-09 10:31:23 616][com.log.test.Log_slf4j_Test]-[error msg]

总结:1.4与2.4中结果输出都是一致(除了类全限定名)的,因为slf4j只是一个门面,本质上还是调用log4j来实现日志打印,既然是同一份log4j.xml,故结果是一致的。

3.springboot-log4j

目前流行的是SpringBoot-starter方式来加载所有

SpringBoot与log4j的结合也有现成的maven依赖

3.1 引入maven依赖

        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.6.6</version>
            <relativePath/> <!-- lookup parent from repository -->
        </parent>

		<!-- spring-boot-starter-web默认加载logback,这里需要排除 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- 主要加载spring-boot-starter-log4j依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j</artifactId>
            <version>1.3.8.RELEASE</version>
        </dependency>

3.2 配置log4j.xml

同1.2

3.3 类中使用

笔者这里使用了idea的SpringBoot骨架生成的项目,所以为了启动验证log的使用,直接使用如下来完成:

@Component
public class Log_slf4j_Test implements InitializingBean {
    private static Logger logger = LoggerFactory.getLogger(Log_slf4j_Test.class);

    @Override
    public void afterPropertiesSet() throws Exception {
        logger.debug("debug msg");
        logger.info("info msg");
        logger.warn("warn msg");
        logger.error("error msg");
    }
}

3.4 验证结果

启动ApplicationRunner来验证

[INFO][2022-04-09 10:41:17 144][com.example.demo.log.Log_slf4j_Test]-[info msg]
[WARN][2022-04-09 10:41:17 145][com.example.demo.log.Log_slf4j_Test]-[warn msg]
[ERROR][2022-04-09 10:41:17 145][com.example.demo.log.Log_slf4j_Test]-[error msg]

总结:

通过以上三种使用log4j的方式,得到的结果基本都是一致的。

在使用springboot-log4j的时候,需要注意,要先exclude掉其他springboot-starter的影响。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

恐龙弟旺仔

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值