log4j2日志配置颜色

最新推荐文章于 2024-08-10 11:09:18 发布

罗小树

最新推荐文章于 2024-08-10 11:09:18 发布

阅读量1.4w

点赞数 14

分类专栏： java 日志文章标签： java 日志 log4j2

本文链接：https://blog.csdn.net/u010999809/article/details/108772149

版权

java 同时被 2 个专栏收录

51 篇文章 0 订阅

订阅专栏

日志

1 篇文章 0 订阅

订阅专栏

本文档详细介绍了如何在Java环境中配置Log4j2，以实现控制台输出带有颜色的日志。首先介绍了基本的日志格式配置，然后讲解了如何添加颜色高亮，最后展示了配置文件和测试代码，以ERROR、WARN、INFO、DEBUG和TRACE五个级别的日志为例，实现了不同级别日志颜色区分的效果。

摘要由CSDN通过智能技术生成

一、需求说明

相关环境说明：maven 3.5.0，jdk1.8

maven依赖：

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.9.1</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.9.1</version>
</dependency>

我现在需要配置控制台打印日志，最终效果如下所示：

这里不需要使用idea的grep console插件，我们来看看怎么配置出上面的效果

比较着急看结果的可以直接看“三、相关代码”部分

二、实现过程

其实最主要的工作就是编写log4j2.xml文件

1. 暂且不管上面的颜色，先看看如何才能打印出以上格式的日志

通过查看官方文档https://logging.apache.org/log4j/2.x/manual/layouts.html，可以知道写成

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %-5level [%t] %c{1.}.%M(%L): %msg%n"/>
        </Console>
    </appenders>
    <loggers>
        <root level="trace">
            <appender-ref ref="Console"/>
        </root>
    </loggers>
</configuration>

%d表示日期，

%-5level 表示日志级别，另外在显示时占5个字符，不足的地方用空格补齐，

%t 表示线程名

%c{1.} 表示显示调用者的时候，只显示包名最后一截及方法名，前面的几段只取首字母

比如：调用logger.info的方法是com.kittycoder.Log4j2Test.test，只显示成c.k.Log4j2Test.test

%L 表示调用者所在代码的行号

%msg 表示需要打印的日志信息

%n 表示系统换行符

2. 现在来看看怎么把颜色给加上去

看下开头那张图，日志级别那一列颜色各不相同，线程名那一列、调用者那一列颜色都是固定的

先来解决日志级别那一列

看下官方给的例子，

稍微再改改，就成了

%highlight{%-5level}{ERROR=Bright RED, WARN=Bright Yellow, INFO=Bright Green, DEBUG=Bright Cyan, TRACE=Bright White}

然后再来解决线程名那一列、调用者那一列

稍微再改改，就成了

%style{[%t]}{bright,magenta}

%style{%c{1.}.%M(%L)}{cyan}

最终版本的pattern就是：

%d %highlight{%-5level}{ERROR=Bright RED, WARN=Bright Yellow, INFO=Bright Green, DEBUG=Bright Cyan, TRACE=Bright White} %style{[%t]}{bright,magenta} %style{%c{1.}.%M(%L)}{cyan}: %msg%n

我在控制台执行了一下，效果看着也还可以

三、相关代码

log4j2.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <!--<PatternLayout pattern="%d %-5level [%t] %c{1.}.%M(%L): %msg%n"/>-->
            <PatternLayout pattern="%d %highlight{%-5level}{ERROR=Bright RED, WARN=Bright Yellow, INFO=Bright Green, DEBUG=Bright Cyan, TRACE=Bright White} %style{[%t]}{bright,magenta} %style{%c{1.}.%M(%L)}{cyan}: %msg%n"/>
        </Console>
    </appenders>
    <loggers>
        <root level="trace">
            <appender-ref ref="Console"/>
        </root>
    </loggers>
</configuration>

测试代码 Log4j2Test.java

package com.kittycoder;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Created by shucheng on 2020/9/24 12:33
 */
public class Log4j2Test {

    public Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    public void test() {
        logger.error("COLOR ERROR");
        logger.warn("COLOR WARN");
        logger.info("COLOR INFO");
        logger.debug("COLOR DEBUG");
        logger.trace("COLOR TRACE");
    }
}

参考链接：https://logging.apache.org/log4j/2.x/manual/layouts.html