java-日志管理-Log4j2

最新推荐文章于 2023-01-06 13:20:38 发布

给自己做减法

最新推荐文章于 2023-01-06 13:20:38 发布

阅读量93

点赞数

分类专栏：个人 java 文章标签： java

本文链接：https://blog.csdn.net/weixin_45149147/article/details/119785755

版权

个人同时被 2 个专栏收录

55 篇文章 0 订阅

订阅专栏

java

26 篇文章 0 订阅

订阅专栏

Log4j已经不更新了，Log4j 2 包含基于 LMAX Disruptor 库的下一代异步记录器。在多线程场景中，异步 Logger 的吞吐量比 Log4j 1.x 和 Logback 高 18 倍，延迟低几个数量级，其他优势具体看官网，所以Log4j 2是未来使用的趋势。

对于项目来说，log4j之前，通常用一个动态名来保存日志，但是log4j2是先将日志保存到特定名字的文件，然后按照规定的保存方式将旧数据保存，这里也可能是将日志修改名字，然后重新创建原来名字的文件。

官网：https://logging.apache.org/log4j/2.x/
api：https

log4j的使用

依赖

    <!-- 日志文件管理包 -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version> 
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.12</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.7.12</version>
    </dependency>

配置文件

log4j.properties

### 设置###
log4j.rootLogger = debug,stdout,D,E

### 输出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 输出DEBUG 级别以上的日志到=D://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#输出到的文件目录
log4j.appender.D.File = D://demo/logs/log.log
log4j.appender.D.Append = true
#Debug
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
#输出的格式
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 输出ERROR 级别以上的日志到=D://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =D://demo/logs/log.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

日志打印

private static Logger logger = Logger.getLogger(MyTest.class.getClass());

log4j2.xml使用

依赖

log4j2的依赖必须去掉web中的logback依赖，否则启动会报错
这里需要注意的是，不止web有Logback依赖，cloud也有

        <!--引入log4j2日志依赖，版本跟随springboot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <!--去除spring自带的logback-->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

配置文件

注意，一定要加classpath:（之前测试很多次，idea一直报错找不到文件）

logging.config=classpath:log4j2.xml

log4j2.xml配置文件

log4j2.xml配置文件详解

默认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>
   </Appenders>
   <Loggers>
     <Root level="error">
       <AppenderRef ref="Console"/>
     </Root>
   </Loggers>
 </Configuration>

先看详细的说明，懂了之后从下往上看
日志文件分为单独设置和root通用设置，配置的包会走单独设置，而不会走root，
日志的输出分为三种appender-ref日志的输出（控制台，通用file，多个带有回滚功能的file），

然后根据AppenderRef 找到对应的输出格式，保存文件格式。

详细看下面

1，
<configuration monitorInterval="5" status = "DEBUG">，监听时间是默认5秒，日志级别是debug，这里可以不设置，后面动态调整，不用全局设置
2，
configuration 下有两个子节点:Appenders和Loggers

Appenders节点，常见的有三种子节点:Console、RollingFile、File.
Loggers节点，常见的有两种:Root和Logger.
3，
Appenders
Console节点用来定义输出到控制台的Appender.
-name:指定Appender的名字.
-target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
-PatternLayout:输出格式，不设置默认为:%m%n.
File节点用来定义输出到指定位置的文件的Appender.
-name:指定Appender的名字.
-fileName:指定输出日志的目的文件带全路径的文件名.
-PatternLayout:输出格式，不设置默认为:%m%n.
-RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.
-name:指定Appender的名字.
-fileName:指定输出日志的目的文件带全路径的文件名.
-PatternLayout:输出格式，不设置默认为:%m%n.
-filePattern:指定新建日志文件的名称格式.
-Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
-TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am…而不是7am.
-SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
-DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。
4.
Loggers
Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
-level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
-AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.
Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
-level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
-name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
-AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

在log4j中可以读取yml中的配置，实际测试log4j2不能读取，网上有通过配置读取spring的配置后将数据导入到xml中。
log4j配置如下

    <!--读取配置中心的属性-->
    <springProperty scope="context" name="serverName" source="spring.application.name" defaultValue="serverName"/>
	<springProperty scope="context" name="ip" source="spring.cloud.client.ipAddress" />

具体配置

这个配置文件会出现导出三个文件
关于配置文件，需要注意配置文件的内容跟log4j.xml的区别比较大，目前还不清楚原因，通过<符号确实可以看到两个配置文件弹出的功能不同。

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--变量配置-->
    <Properties>
        <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
        <!-- %logger{36} 表示 Logger 名字最长36个字符 -->
        <property name="SERVER_NAME" value="custom-server-resource" />
        <property name="LOG_PATTERN" value="[custom-server-resource] %date{MM/dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定义日志存储的路径FILE_PATH，不要配置相对路径 -->
        <property name="FILE_PATH" value="logs/" />
        <property name="FILE_NAME" value="myLog" />
    </Properties>

    <appenders>
        <!-- 控制台日志 -->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用，生产上不能使用-->
        <File name="Filelog" fileName="${FILE_PATH}/allLog.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/%date{yyyy-MM,aux}/${SERVER_NAME}-INFO-%d{yyyy-MM-dd}-%i.log" filePattern="${FILE_PATH}/%date{yyyy-MM,aux}/${SERVER_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="100MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

实际使用
对于混滚文件，因为支持压缩，
注意配置fileName的时候，不能用动态时间，log4j2要定时从文件中的数据保存到新文件中
另外新建文件的动态时间不能设置太短，否则假如设置每分钟执行一次，就会导致后台频繁刷新日志

<?xml version="1.0" encoding="UTF-8"?>

<configuration monitorInterval="5" >
    <Properties>
        <property name="SERVER_NAME" value="custom-server-resource"/>
        <property name="LOG_PATTERN"
                  value="[custom-server-resource] %date{MM/dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/>
        <property name="FILE_PATH" value="logs/"/>
        <property name="FILE_NAME" value="myLog"/>
    </Properties>

    <appenders>
        <!-- 控制台日志 -->
        <console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- info日志 -->
        <RollingFile name="RollingFileInfo"
                     fileName="${FILE_PATH}/%date{yyyy-MM}/${SERVER_NAME}-INFO-%d{yyyy-MM-dd}-%i.log"
                     filePattern="${FILE_PATH}/%date{yyyy-MM}/${SERVER_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="100MB"/>
            </Policies>
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>

        <!-- error日志 -->
        <RollingFile name="RollingFileError"
                     fileName="${FILE_PATH}/%date{yyyy-MM}/${SERVER_NAME}-ERROR-%d{yyyy-MM-dd}-%i.log"
                     filePattern="${FILE_PATH}/%date{yyyy-MM}/${SERVER_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="100MB"/>
            </Policies>
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>
    </appenders>

    <loggers>
<!--        <logger name="org.mybatis" level="info" additivity="false">-->
<!--        </logger>-->
<!--        <Logger name="org.springframework" level="info" additivity="false"/>-->
<!--        <Logger name="com.mysql.jdbc.JDBC4Connection" level="info" additivity="false"/>-->
<!--        <logger name="org.apache.ibatis.logging.stdout.StdOutImpl" level="debug"/>-->
<!--        <logger name="com.zaxxer.hikari.HikariDataSource" level="debug"/>-->
<!--        <logger name="com.alibaba.nacos" level="error" />-->
<!--        <logger name="com.jinyafu.custom.mapper.core.admin" level="INFO" />-->
<!--        <logger name="com.jinyafu.resource" level="info" />-->
        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

使用

@SpringBootTest
class FirstApplicationTests {
    private static Logger log = LogManager.getLogger(FirstApplicationTests.class);
    @Test
    void contextLoads() {
        log.debug("测试debug");
        log.info("测试日志info");
        log.error("测试error");
    }
}

log4j2.properties的使用

依赖

log4j2的依赖必须去掉web中的logback依赖，否则启动会报错

        <!--引入log4j2日志依赖，版本跟随springboot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <!--去除spring自带的logback-->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

配置文件

注意，一定要加classpath:（之前测试很多次，idea一直报错找不到文件）

logging.config=classpath:log4j2.properties

log4j2.properties文件

### 设置###
log4j.rootLogger = debug,stdout,D,E

### 输出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 输出DEBUG 级别以上的日志到=D://logs/debug.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#输出到的文件目录
log4j.appender.D.File = D://demo/logs/debug.log
log4j.appender.D.Append = true
#Debug
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
#输出的格式
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 输出ERROR 级别以上的日志到=D://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =D://demo/logs/error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

使用

@SpringBootTest
class FirstApplicationTests {
    private static Logger log = LogManager.getLogger(FirstApplicationTests.class);
    @Test
    void contextLoads() {
        log.debug("测试debug");
        log.info("测试日志info");
        log.error("测试error");
    }
}

Slf4j推荐使用

下面测试了Slf4j，发现日志文件能够记录

@Slf4j
@SpringBootTest
class FirstApplicationTests {
    private static Logger logger = LogManager.getLogger(FirstApplicationTests.class);
    @Test
    void contextLoads() {
        log.debug("测试debug");
        log.info("测试日志info");
        log.error("测试error");
        System.out.println("系统输出日志");
    }

    @Test
    void contextLoads2() {
        logger.debug("测试debug");
        logger.info("测试日志info");
        logger.error("测试error");
        System.out.println("系统输出日志");
    }
}

总结

log4j在没有指定配置文件路径的情况下，spring可以找到对应的配置文件，但是log4j2因为要去掉spring web中的logback依赖，在没有配置文件的情况下实际上不会自动配置。
实际测试xml和properties文件的日志打印，结果发现properties文件的作用很不稳定，也可能是因为没有配置好。
实际上在官网中也是可以看到没有关于对properties的支持，所以建议也是不要使用这个文件格式。

参考

log4j2配置详解
 log4j2配置文件
 log4j2使用

给自己做减法

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
java-日志管理-Log4j2

Log4j已经不更新了，Log4j 2 包含基于 LMAX Disruptor 库的下一代异步记录器。在多线程场景中，异步 Logger的吞吐量比 Log4j 1.x 和 Logback 高 18 倍，延迟低几个数量级，Log4j 2是未来使用的趋势。官网：https://logging.apache.org/log4j/2.x/...
复制链接

扫一扫

专栏目录