如何为 System.out.println 输出着色？ [复制]

Posted 2023-02-23

技术标签:

【中文标题】如何为 System.out.println 输出着色？ [复制]【英文标题】：How to color System.out.println output? [duplicate] 【发布时间】：2010-11-29 17:59:44 【问题描述】：

如何为 Java 输出着色？

例如，在 C 和其他语言中，我可以使用像 \033[0m 这样的 ANSI 转义来执行此操作。但在 Java 中它不起作用。

public static void main(String[] x) 
    System.out.println("\033[0m BLABLA \033[0m\n");

【问题讨论】：

【参考方案1】：

没有，但是有第三方 API 可以处理它

http://www.javaworld.com/javaworld/javaqa/2002-12/02-qa-1220-console.html

编辑：当然有比我发布的文章更新的文章，但信息仍然可行。

以上链接已失效，请改为查看此问题：How to print color in console using System.out.println?

【讨论】：

这个帖子有很好的答案***.com/a/5762502/70535 链接已断开【参考方案2】：

转义序列必须由 SOMETHING 解释才能转换为颜色。 java 从命令行启动时使用的标准 CMD.EXE 不支持，因此 Java 不支持。

【讨论】：

如果您在非 Windows 操作系统上运行，终端应用程序很有可能会进行转义序列解释。【参考方案3】：

这是 Win32 控制台的解决方案。

1) 在此处获取 JavaNativeAccess 库：https://github.com/twall/jna/

2) 这两个 Java 类可以解决问题。

享受吧。

package com.***.util;

import com.sun.jna.Library;
import com.sun.jna.Native;
import com.sun.jna.Platform;
import com.sun.jna.Structure;

public class Win32 
    public static final int STD_INPUT_HANDLE = -10;
    public static final int STD_OUTPUT_HANDLE = -11;
    public static final int STD_ERROR_HANDLE = -12;

    public static final short CONSOLE_FOREGROUND_COLOR_BLACK        = 0x00;
    public static final short CONSOLE_FOREGROUND_COLOR_BLUE         = 0x01;
    public static final short CONSOLE_FOREGROUND_COLOR_GREEN        = 0x02;
    public static final short CONSOLE_FOREGROUND_COLOR_AQUA         = 0x03;
    public static final short CONSOLE_FOREGROUND_COLOR_RED          = 0x04;
    public static final short CONSOLE_FOREGROUND_COLOR_PURPLE       = 0x05;
    public static final short CONSOLE_FOREGROUND_COLOR_YELLOW       = 0x06;
    public static final short CONSOLE_FOREGROUND_COLOR_WHITE        = 0x07;
    public static final short CONSOLE_FOREGROUND_COLOR_GRAY         = 0x08;
    public static final short CONSOLE_FOREGROUND_COLOR_LIGHT_BLUE   = 0x09;
    public static final short CONSOLE_FOREGROUND_COLOR_LIGHT_GREEN  = 0x0A;
    public static final short CONSOLE_FOREGROUND_COLOR_LIGHT_AQUA   = 0x0B;
    public static final short CONSOLE_FOREGROUND_COLOR_LIGHT_RED    = 0x0C;
    public static final short CONSOLE_FOREGROUND_COLOR_LIGHT_PURPLE = 0x0D;
    public static final short CONSOLE_FOREGROUND_COLOR_LIGHT_YELLOW = 0x0E;
    public static final short CONSOLE_FOREGROUND_COLOR_BRIGHT_WHITE = 0x0F;

    public static final short CONSOLE_BACKGROUND_COLOR_BLACK        = 0x00;
    public static final short CONSOLE_BACKGROUND_COLOR_BLUE         = 0x10;
    public static final short CONSOLE_BACKGROUND_COLOR_GREEN        = 0x20;
    public static final short CONSOLE_BACKGROUND_COLOR_AQUA         = 0x30;
    public static final short CONSOLE_BACKGROUND_COLOR_RED          = 0x40;
    public static final short CONSOLE_BACKGROUND_COLOR_PURPLE       = 0x50;
    public static final short CONSOLE_BACKGROUND_COLOR_YELLOW       = 0x60;
    public static final short CONSOLE_BACKGROUND_COLOR_WHITE        = 0x70;
    public static final short CONSOLE_BACKGROUND_COLOR_GRAY         = 0x80;
    public static final short CONSOLE_BACKGROUND_COLOR_LIGHT_BLUE   = 0x90;
    public static final short CONSOLE_BACKGROUND_COLOR_LIGHT_GREEN  = 0xA0;
    public static final short CONSOLE_BACKGROUND_COLOR_LIGHT_AQUA   = 0xB0;
    public static final short CONSOLE_BACKGROUND_COLOR_LIGHT_RED    = 0xC0;
    public static final short CONSOLE_BACKGROUND_COLOR_LIGHT_PURPLE = 0xD0;
    public static final short CONSOLE_BACKGROUND_COLOR_LIGHT_YELLOW = 0xE0;
    public static final short CONSOLE_BACKGROUND_COLOR_BRIGHT_WHITE = 0xF0;

    // typedef struct _COORD 
    //    SHORT X;
    //    SHORT Y;
    //   COORD, *PCOORD;
    public static class COORD extends Structure 
        public short X;
        public short Y;
    

    // typedef struct _SMALL_RECT 
    //    SHORT Left;
    //    SHORT Top;
    //    SHORT Right;
    //    SHORT Bottom;
    //   SMALL_RECT;
    public static class SMALL_RECT extends Structure 
        public short Left;
        public short Top;
        public short Right;
        public short Bottom;
    

    // typedef struct _CONSOLE_SCREEN_BUFFER_INFO 
    //    COORD      dwSize;
    //    COORD      dwCursorPosition;
    //    WORD       wAttributes;
    //    SMALL_RECT srWindow;
    //    COORD      dwMaximumWindowSize;
    //   CONSOLE_SCREEN_BUFFER_INFO;
    public static class CONSOLE_SCREEN_BUFFER_INFO extends Structure 
        public COORD dwSize;
        public COORD dwCursorPosition;
        public short wAttributes;
        public SMALL_RECT srWindow;
        public COORD dwMaximumWindowSize;
    

    // Source: https://github.com/twall/jna/nonav/javadoc/index.html
    public interface Kernel32 extends Library 
        Kernel32 DLL = (Kernel32) Native.loadLibrary("kernel32", Kernel32.class);

        // HANDLE WINAPI GetStdHandle(
        //        __in  DWORD nStdHandle
        //      );
        public int GetStdHandle(
                int nStdHandle);

        // BOOL WINAPI SetConsoleTextAttribute(
        //        __in  HANDLE hConsoleOutput,
        //        __in  WORD wAttributes
        //      );
        public boolean SetConsoleTextAttribute(
                int in_hConsoleOutput, 
                short in_wAttributes);

        // BOOL WINAPI GetConsoleScreenBufferInfo(
        //        __in   HANDLE hConsoleOutput,
        //        __out  PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
        //      );
        public boolean GetConsoleScreenBufferInfo(
                int in_hConsoleOutput,
                CONSOLE_SCREEN_BUFFER_INFO out_lpConsoleScreenBufferInfo);

        // DWORD WINAPI GetLastError(void);
        public int GetLastError();

package com.***.util;

import java.io.PrintStream;

import com.***.util.Win32.Kernel32;

public class ConsoleUtil 
    public static void main(String[] args)
    throws Exception 
        System.out.print("abc");
        static_color_print(
                System.out, 
                "def", 
                Win32.CONSOLE_BACKGROUND_COLOR_RED, 
                Win32.CONSOLE_FOREGROUND_COLOR_BRIGHT_WHITE);
        System.out.print("def");
        System.out.println();
    

    private static Win32.CONSOLE_SCREEN_BUFFER_INFO _static_console_screen_buffer_info = null; 

    public static void static_save_settings() 
        if (null == _static_console_screen_buffer_info) 
            _static_console_screen_buffer_info = new Win32.CONSOLE_SCREEN_BUFFER_INFO();
        
        int stdout_handle = Kernel32.DLL.GetStdHandle(Win32.STD_OUTPUT_HANDLE);
        Kernel32.DLL.GetConsoleScreenBufferInfo(stdout_handle, _static_console_screen_buffer_info);
    

    public static void static_restore_color()
    throws Exception 
        if (null == _static_console_screen_buffer_info) 
            throw new Exception("Internal error: Must save settings before restore");
        
        int stdout_handle = Kernel32.DLL.GetStdHandle(Win32.STD_OUTPUT_HANDLE);
        Kernel32.DLL.SetConsoleTextAttribute(
                stdout_handle, 
                _static_console_screen_buffer_info.wAttributes);
    

    public static void static_set_color(Short background_color, Short foreground_color) 
        int stdout_handle = Kernel32.DLL.GetStdHandle(Win32.STD_OUTPUT_HANDLE);
        if (null == background_color || null == foreground_color) 
            Win32.CONSOLE_SCREEN_BUFFER_INFO console_screen_buffer_info = 
                new Win32.CONSOLE_SCREEN_BUFFER_INFO();
            Kernel32.DLL.GetConsoleScreenBufferInfo(stdout_handle, console_screen_buffer_info);
            short current_bg_and_fg_color = console_screen_buffer_info.wAttributes;
            if (null == background_color) 
                short current_bg_color = (short) (current_bg_and_fg_color / 0x10);
                background_color = new Short(current_bg_color);
            
            if (null == foreground_color) 
                short current_fg_color = (short) (current_bg_and_fg_color % 0x10);
                foreground_color = new Short(current_fg_color);
            
        
        short bg_and_fg_color = 
            (short) (background_color.shortValue() | foreground_color.shortValue());
        Kernel32.DLL.SetConsoleTextAttribute(stdout_handle, bg_and_fg_color);
    

    public static<T> void static_color_print(
            PrintStream ostream, 
            T value, 
            Short background_color, 
            Short foreground_color)
    throws Exception 
        static_save_settings();
        try 
            static_set_color(background_color, foreground_color);
            ostream.print(value);
        
        finally 
            static_restore_color();
        
    

    public static<T> void static_color_println(
            PrintStream ostream, 
            T value, 
            Short background_color, 
            Short foreground_color)
    throws Exception 
        static_save_settings();
        try 
            static_set_color(background_color, foreground_color);
            ostream.println(value);
        
        finally 
            static_restore_color();

【讨论】：

【参考方案4】：

您可以使用 JANSI 库在 Windows 中呈现 ANSI 转义序列。

【讨论】：

【参考方案5】：

我创建了一个名为 JCDP 的 jar 库（Java 彩色调试打印机）。

对于 Linux，它使用 WhiteFang 提到的 ANSI 转义码，但使用单词而不是更直观的代码来抽象它们。

对于 Windows，它实际上包含 JAnsi 库，但在其上创建了一个抽象层，保持为 Linux 创建的直观和简单的界面。

这个库是在MIT License 下获得许可的，所以请随意使用它。

看看JCDP's github repository。

【讨论】：

【参考方案6】：

最简单的方法是在 Cygwin 控制台中运行您的程序（未修改）。

第二种最简单的方法是在普通的 Windows 控制台中运行您的程序（也未修改），通过 tee.exe（来自 Cygwin 或 Git 发行版）流水线化其输出。 Tee.exe 将识别转义码并调用相应的 WinAPI 函数。

类似：

java MyClass | tee.exe log.txt
java MyClass | tee.exe /dev/null

【讨论】：

【参考方案7】：

是的，这是 100% 可能的

设置类路径= %classpath%;d:\jansi-1.4.jar;

试试下面的代码：

import org.fusesource.jansi.AnsiConsole;
import static org.fusesource.jansi.Ansi.*;
import static org.fusesource.jansi.Ansi.Color.*;

public class Sample



  public static void main(String[] args)
  
    AnsiConsole.systemInstall();

    System.out.println(ansi().fg(RED).a("Hello World").reset());
    System.out.println("My Name is Raman");

    AnsiConsole.systemUninstall();

【讨论】：

太棒了——这是最简单、最直接、视觉上可以理解的解决方案，并且普遍适用！【参考方案8】：

注意

您可能无法为 Window 的 cmd prompt 着色，但它应该可以在许多 unix（或类 unix）终端中使用。

另外，请注意，某些终端根本不支持某些（如果有）ANSI 转义序列，尤其是 24 位颜色。

用法

请参阅底部的诅咒部分以获得最佳解决方案。对于个人或简单的解决方案（尽管不是作为跨平台解决方案），请参阅 ANSI Escape Sequences 部分。

TL;DR

java：System.out.println((char)27 + "[31m" + "ERROR MESSAGE IN RED");

python：print(chr(27) + "[31m" + "ERROR MESSAGE IN RED")

bash 或 zsh：printf '\x1b[31mERROR MESSAGE IN RED' 这也可能适用于 Os X：printf '\e[31mERROR MESSAGE IN RED' sh：printf 'CTRL+V,CTRL+[[31mERROR MESSAGE IN RED' 即，当转义解释不可用时，按 CTRL+V 然后按 CTRL+[ 以获得“原始”ESC 字符如果操作正确，您应该会看到^[。虽然看起来像两个字符，但实际上只有一个，ESC字符。你也可以在vim中按CTRL+V,CTRL+[ > 在任何编程或脚本语言中，因为它使用文字 ESC 字符另外，您可以将 Ctrl+[ 替换为 ESC ...例如，您可以使用 CTRL+V,ESC，但我发现前者更容易，因为我已经按下 CTRL 并且因为 [ 不那么有效顺便说一句。

ANSI 转义序列

转义序列的背景

虽然这不是最好的方法，但在编程或脚本语言中最简单的方法是使用 escape sequences。从那个链接：

转义序列是一系列字符，用于更改计算机及其连接的外围设备的状态。这些也称为控制序列，反映了它们在设备控制中的用途。

ANSI 转义序列的背景

但是，它比视频文本终端更容易，因为这些终端使用 ANSI escape sequences。从那个链接：

ANSI 转义序列是带内信号的标准，用于控制视频文本终端上的光标位置、颜色和其他选项。某些字节序列，大多数以 Esc 和 '[' 开头，嵌入到文本中，终端查找并解释为命令，而不是字符代码。

如何使用 ANSI 转义序列

一般

转义序列以转义字符开头；对于 ANSI 转义序列，该序列始终以 ESC 开头（ASCII：27 / 十六进制：0x1B）。有关您可以执行的操作的列表，请参阅ANSI Escape Sequence List on Wikipedia

在编程语言中

某些编程语言（如 Java）不会将 \e 或 \x1b 解释为 ESC 字符。但是，我们知道 ASCII 字符 27 是 ESC 字符，所以我们可以简单地将27 转换为char 并使用它来开始转义顺序。

以下是一些常用编程语言的方法：

Java

System.out.println((char)27 + "[33mYELLOW");

Python 3

print(chr(27) + "[34mBLUE"); print("\x1b[35mMAGENTA"); 请注意，\x1b 在 python 中被正确解释

节点 JS

以下内容将不在 Web 控制台中的 javascript 中为输出着色 console.log(String.fromCharCode(27) + "[36mCYAN"); console.log("\x1b[30;47mBLACK_ON_WHITE"); 请注意，\x1b 也适用于节点

在 Shell 提示符或脚本中

如果您使用的是 bash 或 zsh，则很容易为输出着色（在大多数终端中）。在 Linux、Os X 和某些 Window 的终端中，您可以通过执行以下两个操作来检查您的终端是否支持颜色：

printf '\e[31mRED' printf '\x1b[31mRED'

如果您看到两者的颜色，那就太好了！如果您只看到一个颜色，请使用该序列。如果您没有看到其中任何一个的颜色，请仔细检查以确保您输入的所有内容都正确并且您使用的是 bash 或 zsh；如果您仍然看不到任何颜色，那么您的终端可能不支持 ANSI 转义序列。

如果我没记错的话，linux 终端倾向于支持\e 和\x1b 转义序列，而 os x 终端只倾向于支持\e，但我可能错了。尽管如此，如果您看到类似下图的内容，那么您已经准备就绪！（请注意，我使用的是 shell，zsh，它为我的提示字符串着色；另外，我在 linux 中使用 urxvt 作为我的终端。）

“这是如何工作的？” 你可能会问。基本上，printf 正在解释后面的字符序列（单引号中的所有内容）。当printf 遇到\e 或\x1b 时，会将这些字符转换为ESC 字符（ASCII：27）。这正是我们想要的。现在，printf 发送 ESC31m，因为有一个 ESC 后跟一个有效的 ANSI 转义序列，我们应该得到彩色输出（只要它是终端支持）。

您还可以使用echo -e '\e[32mGREEN'（例如）进行颜色输出。请注意，echo 的 -e 标志 “[启用] 反斜杠转义解释” 如果您希望 echo 正确解释转义序列，则必须使用该标志。

诅咒

请参阅Curses (Programming Library) page 以获取有关诅咒的完整参考。需要注意的是，curses 仅适用于 unix 和类 unix 操作系统。

带着诅咒开始行动

我不会详细介绍，因为搜索引擎可以显示指向网站的链接，这些网站可以比我更好地解释这一点，但我将在这里简要讨论并举一个例子。

为什么在 ANSI 转义上使用诅咒？

如果您阅读了上面的文字，您可能会记得\e 或\x1b 有时会与printf 一起使用。好吧，有时\e 和\x1b 根本不起作用（这不是标准的，我从未使用过这样的终端，但这是可能的）。更重要的是，每个终端都难以支持更复杂的转义序列（想想 Home 和其他多字符键）（除非您愿意花费大量时间和精力来解析 terminfo 和 termcap 以及弄清楚如何处理每个终端）。

Curses 解决了这个问题。基本上，它能够使用这些方法（如上面链接的***文章所述）了解终端具有哪些功能：

curses 的大多数实现都使用可以描述数千个不同终端功能的数据库。有一些实现，例如 PDCurses，它们使用专门的设备驱动程序而不是终端数据库。大多数实现使用 terminfo；一些使用termcap。 Curses 具有向后可移植到字符单元终端和简单性的优点。对于不需要位图图形或多种字体的应用程序，使用 curses 的接口实现通常比使用 X 工具包的接口实现简单和快速。

大多数时候，curses 会轮询 terminfo，然后就能理解如何操作光标和文本属性。然后，您，程序员，使用 curses 提供的 API 来操作光标或更改文本颜色或其他属性，如果您需要的功能是需要的。

Python 示例

我发现 python 真的很容易使用，但是如果你想在不同的编程语言中使用 curses，那么只需在 dadduckgo 或任何其他搜索引擎上搜索它。 :) 这是 python 3 中的一个简单示例：

import curses

def main(stdscr):
    # allow curses to use default foreground/background (39/49)
    curses.use_default_colors()

    # Clear screen
    stdscr.clear()

    curses.init_pair(1, curses.COLOR_RED, -1)
    curses.init_pair(2, curses.COLOR_GREEN, -1)
    stdscr.addstr("ERROR: I like tacos, but I don't have any.\n", curses.color_pair(1))
    stdscr.addstr("SUCCESS: I found some tacos.\n", curses.color_pair(2))

    stdscr.refresh() # make sure screen is refreshed
    stdscr.getkey()  # wait for user to press key

if __name__ == '__main__':
    curses.wrapper(main)

结果：

你可能会想，这是一种更全面的做事方式，但它确实更跨平台（真正跨终端……至少在 unix 和类 unix 平台的世界中））。对于颜色，它不是相当那么重要，但是当涉及到支持其他多序列转义序列时（例如Home，End， Page Up、Page Down 等），那么诅咒就变得更加重要了。

Tput 示例

tput 是一个用于操作光标和文本的命令行实用程序 tput 附带 curses 包。如果你想在终端中使用跨终端（ish）应用程序，你应该使用 tput，因为它会解析 terminfo 或任何它需要的东西，并使用一组标准化的命令（如 curses）并返回正确的转义序列。李> 示例：

echo "$(tput setaf 1)$(tput bold)ERROR:$(tput sgr0)$(tput setaf 1) My tacos have gone missing"
echo "$(tput setaf 2)$(tput bold)SUCCESS:$(tput sgr0)$(tput setaf 2) Oh good\! I found my tacos\!"

结果：

如何为 System.out.println 输出着色？ [复制]

注意

用法

TL;DR

ANSI 转义序列

转义序列的背景

ANSI 转义序列的背景

如何使用 ANSI 转义序列

一般

在编程语言中

在 Shell 提示符或脚本中

更多关于 ANSI 转义序列

颜色

快速参考（颜色）

选择图形再现 (SGR)

快速参考（SGR 属性 0-9）

8 位颜色

24 位彩色

插入原始转义序列

诅咒

带着诅咒开始行动

为什么在 ANSI 转义上使用诅咒？

Python 示例

Tput 示例

更多关于 Tput 的信息