应用日志是日常运维、发现问题、解决问题的关键信息。彩色日志已经成为现代开发工具和运维工具的标准实践。它主要服务于命令行界面和开发者工具，通过视觉线索显著提升信息处理效率。代码作者对开发者体验的精心设计有助于在终端看到有条不紊的彩色输出。

dev环境示例的屏幕输出日志截图：

使用彩色日志输出的好处很多，比如提升视觉效率、有助于及时捕捉故障、缩短定位时间、降低视觉疲劳、缩短排查和定位时间。

本文以Windows 10操作系统下IDEA、logback为例说明，如何实现彩色日志。涉及pom文件增加依赖、应用程序入口增加一行代码、扩展日志级别颜色转换类、logback.xml配置。本文中的代码运行于JDK21、SpringBoot 3.5.6。

日志输出到文件时，其pattern不要加入颜色转换器。

本文不涉及在CI/CD（例如Jenkins）平台上运行测试程序所需要的调整。

日志中显示颜色本质上是向日志输出中插入 ANSI 转义序列。Linux、macOS操作系统已支持此标准。Windows操作系统中，Windows Terminal支持此标准，Windows Cmd、Windows PowerShell 5.1及以下不支持，需要借助jansi库。

<dependency>
            <groupId>org.fusesource.jansi</groupId>
            <artifactId>jansi</artifactId>
            <version>2.4.0</version>
        </dependency>

        
        <dependency>
            <groupId>org.codehaus.janino</groupId>
            <artifactId>janino</artifactId>
            <version>3.1.9</version>
        </dependency>

如果需要在Windows Cmd或者Windows PowerShell中运行应用程序，则需要在程序入口增加一行语句。例如：

package org.example.springboot;

import lombok.extern.slf4j.Slf4j;
import org.fusesource.jansi.AnsiConsole;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication

@Slf4j
public class Main {
    public static void main(String[] args) {
        AnsiConsole.systemInstall();
        SpringApplication.run(Main.class, args);
    }
}

通常，我们希望日志级别颜色如下：

这需要扩展ForegroundCompositeConverterBase类，并配合调整logback.xml。logback提供的%highlight颜色转换器，其颜色为：ERROR->红色加粗、WARN->红色、INFO->蓝色，其他基本使用默认，与我们的期望不符。参见：

https://logback.qos.ch/manual/layouts.html#coloring

package org.example.springboot.log;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.pattern.color.ForegroundCompositeConverterBase;

import static ch.qos.logback.core.pattern.color.ANSIConstants.BOLD;

import static ch.qos.logback.core.pattern.color.ANSIConstants.DEFAULT_FG;

import static ch.qos.logback.core.pattern.color.ANSIConstants.RED_FG;

/**
 * 突出显示不同的日志级别.<br>
 * ERROR使用红色加粗，WARN使用亮黄色，INFO使用亮绿色，DEBUG使用亮蓝色，TRACE使用浅白色，其他使用默认
 */

public class HighlightingCompositeConverter extends ForegroundCompositeConverterBase<ILoggingEvent> {
    private static final String BRIGHT_YELLOW_FG = "93";
    private static final String BRIGHT_GREEN_FG = "92";
    private static final String BRIGHT_BLUE_FG = "94";
    private static final String GRAY_FG = "90";

    @Override
    protected String getForegroundColorCode(ILoggingEvent event) {

        Level level = event.getLevel();
        return switch (level.toInt()) {
            case Level.ERROR_INT -> BOLD + RED_FG;
            case Level.WARN_INT -> BRIGHT_YELLOW_FG;
            case Level.INFO_INT -> BRIGHT_GREEN_FG;
            case Level.DEBUG_INT -> BRIGHT_BLUE_FG;
            case Level.TRACE_INT -> GRAY_FG;
            default -> DEFAULT_FG;
        };
    }
}


在Dark主题下，使用IDEA的默认设置时运行颜色如下：

调整后，能使Gray颜色在开发工具中看起来跟实际运行基本一致。安装插件可能会使开发环境的颜色输出与真实运行环境存在差异。

路径：Settings\Editor\Color Scheme\Console Colors，或者在Settings中搜索Console。

调整Console Colors中ANSI Colors中的Black，设置其Foreground为808080。

配置要运行的程序，设置VM Options为“-Djansi.mode=force”，不设置时，在IDEA中运行日志无彩色。运行JUnit测试程序，无需额外配置，测试程序输出的日志按logback.xml中的配置带彩色。

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


<configuration>
    <if condition='property("spring.profiles.active").equals("prd")'>
        <then>
            
            <property name="consoleExPattern" value="%ex{3}"/>
        </then>
        <else>
            
            <property name="consoleExPattern" value="%ex"/>
        </else>
    </if>

    <conversionRule conversionWord="customHighlight"
                   converterClass="org.example.springboot.log.HighlightingCompositeConverter"/>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            
            <pattern>%gray(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %customHighlight(%-5level) %gray(%logger{36}) - %msg%n${consoleExPattern}
            </pattern>
            
        </encoder>
    </appender>

    
    <springProfile name="dev">
        <property name="myLogLevel" value="DEBUG"/>
    </springProfile>

    <springProfile name="uat">
        <property name="myLogLevel" value="INFO"/>
    </springProfile>

    <springProfile name="prd">
        <property name="myLogLevel" value="WARN"/>
    </springProfile>

    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
    <logger name="org.example.springboot" level="${myLogLevel:-DEBUG}" additivity="false">
        <appender-ref ref="CONSOLE"/>
    </logger>

</configuration>

6.1 JUnit测试程序，无需修改设置和任何源代码

使用mvn package打包后，在Windows Cmd、PowerShell、Windows Terminal、Linux下运行，日志颜色显示正常。

SpringBoot应用Log带颜色

本文介绍了如何对SpringBoot应用日志的Console输出增加颜色，以及如何在IDEA中运行和测试时，在不使用插件的情况下使控制台输出日志的颜色与实际运行尽量保持一致的方法。

高级架构师

后端

开发工具

运维

彩色日志提升运维效率，本文详解Windows10下IDEA+logback实现彩色日志方案。包含pom依赖配置、日志级别颜色转换类扩展、logback.xml优化及IDEA设置技巧，助您快速定位问题，降低视觉疲劳。适用于JDK21+SpringBoot3.5.6环境。

Windows

Ubuntu

Linux

AI驱动 智领未来

coding

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

SpringBoot应用Log带颜色

SpringBoot应用Log带颜色

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐