本文探讨Java应用程序在windows命令提示符（CMD）中无法正确显示ANSI颜色代码的问题，尽管在VS Code等集成终端中工作正常。文章将详细介绍此问题的根源，并提供两种主要解决方案：一是通过外部命令（如echo）进行输出委托，二是利用Java 22及更高版本提供的Foreign function & Memory API直接调用windows原生函数启用虚拟终端处理，从而实现CMD终端的彩色输出。
问题根源：Windows CMD对ANSI支持的限制
在linux或macos等操作系统中，终端通常默认支持ansi转义序列，因此java程序可以直接使用u001b[33m这样的代码来输出彩色文本。然而，windows的cmd终端在较旧的版本中并不原生支持ansi。即使是windows 10版本1511及更高版本，虽然引入了对ansi转义序列的支持，但出于兼容性考虑，默认情况下并未完全启用。
对于Java应用程序而言，java.exe本身并未被标记为使用ANSI，也未显式调用Windows API来启用ANSI支持。这导致在标准的Windows CMD中直接运行包含ANSI颜色代码的Java程序时，这些转义序列会被原样输出，而不是被解释为颜色指令。而像VS Code这样的集成开发环境，其内置终端通常会模拟一个支持ANSI的终端环境（例如通过PowerShell或git bash），因此在其中运行Java代码时，颜色能够正常显示。
解决方案一：通过外部命令委托输出 (适用于Java 22以下版本及通用场景)
一种通用的解决方案是利用windows系统自带的命令（如echo）来处理ANSI颜色代码的输出。echo命令在某些情况下能够正确解析并显示ANSI序列，因为它本身是操作系统的一部分，可以访问底层的终端功能。
我们可以通过Java的ProcessBuilder来执行外部命令，并将带有ANSI代码的字符串作为参数传递给echo。
示例代码：
立即学习“Java免费学习笔记（深入）”；
import java.io.IOException; public class ConsoleOutput { // 定义ANSI颜色代码 public static final String ANSI_RESET_ALL = "u001B[0m"; // 重置所有属性 public static final String ANSI_YELLOW_FG = "u001B[33m"; // 黄色前景 public static final String ANSI_RESET_FG = "u001B[39m"; // 重置前景色 public static void main(String[] args) { // 打印彩色文本 println(ANSI_YELLOW_FG + "This text is yellow" + ANSI_RESET_FG); // 打印普通文本 println("This is normal color"); } /** * 通过外部cmd命令打印字符串 * @param s 要打印的字符串，可包含ANSI颜色代码 */ static void println(String s) { try { // 构建并执行cmd命令：cmd /c echo [字符串] // /c 参数表示执行完命令后关闭cmd // inheritIO() 使子进程的输入、输出和错误流与当前Java进程共享 new ProcessBuilder("cmd", "/c", "echo " + s) .inheritIO() .start() .waitFor(); // 等待子进程完成 } catch (InterruptedException | IOException e) { // 捕获中断或IO异常 throw new RuntimeException("Failed to execute external command for printing.", e); } } }
注意事项：
- 性能开销： 每次打印都需要启动一个新的外部进程，这会带来一定的性能开销。对于需要大量、频繁输出的场景，这种方法可能效率不高。
- 大文本处理： 如果要打印的文本非常大，直接作为echo的参数可能会遇到命令行长度限制。对于这种情况，可以考虑将文本先写入一个临时文件，然后使用type命令（cmd /c type tempfile.txt）将文件内容输出到终端。
- 兼容性： 这种方法在大多数Windows版本中都相对有效，因为它依赖于系统自带的cmd和echo命令。
解决方案二：利用Java 22+ FFM API启用原生ANSI支持
从Java 22开始，引入了Foreign Function & Memory API (FFM API) (JEP 454)，允许Java程序更方便、安全地与原生代码进行交互，而无需JNI等复杂的原生辅助代码。通过FFM API，我们可以直接调用Windows的kernel32.dll中的函数来启用控制台的虚拟终端处理模式，从而使CMD终端原生支持ANSI颜色代码。
示例代码：
立即学习“Java免费学习笔记（深入）”；
import java.lang.foreign.*; // 导入FFM API相关类 import java.lang.invoke.MethodHandle; public class ConsoleOutput { // 定义ANSI颜色代码 public static final String ANSI_RESET_ALL = "u001B[0m"; public static final String ANSI_YELLOW_FG = "u001B[33m"; public static final String ANSI_RESET_FG = "u001B[39m"; // Windows API常量 static final int STD_OUTPUT_HANDLE = -11; // 标准输出句柄 static final int ENABLE_PROCESSED_OUTPUT = 0x0001; // 启用处理输出 static final int ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004; // 启用虚拟终端处理 public static void main(String[] args) { // 尝试初始化ANSI支持 if (initANSI()) { System.out.println("ANSI support should now be enabled."); } else { System.out.println("Failed to enable ANSI support or already enabled."); } // 打印彩色文本，此时CMD应能正确显示颜色 System.out.println(ANSI_YELLOW_FG + "This text is yellow" + ANSI_RESET_FG); System.out.println("This is normal color"); } /** * 调用Windows API启用控制台的虚拟终端处理模式 * @return 如果成功启用，则返回true */ static boolean initANSI() { try (Arena arena = Arena.ofConfined()) { // 创建一个受限的内存区域 // 查找kernel32.dll库 SymbolLookup sl = SymbolLookup.libraryLookup("kernel32.dll", arena); Linker linker = Linker.nativeLinker(); // 获取原生链接器 // 查找并获取GetStdHandle函数的MethodHandle MethodHandle GetStdHandle = linker.downcallHandle( sl.find("GetStdHandle").orElseThrow(() -> new RuntimeException("GetStdHandle not found")), FunctionDescriptor.of(ValueLayout.ADDRESS, ValueLayout.JAVA_INT) // 函数签名：返回地址，参数为int ); // 查找并获取SetConsoleMode函数的MethodHandle MethodHandle SetConsoleMode = linker.downcallHandle( sl.find("SetConsoleMode").orElseThrow(() -> new RuntimeException("SetConsoleMode not found")), FunctionDescriptor.of(ValueLayout.JAVA_BOOLEAN, ValueLayout.ADDRESS, ValueLayout.JAVA_INT) // 函数签名：返回boolean，参数为地址和int ); // 调用GetStdHandle获取标准输出句柄 MemorySegment hConsole = (MemorySegment) GetStdHandle.invokeExact(STD_OUTPUT_HANDLE); // 调用SetConsoleMode启用虚拟终端处理模式 // 参数为句柄和模式标志（ENABLE_PROCESSED_OUTPUT | ENABLE_VIRTUAL_TERMINAL_PROCESSING） return (boolean) SetConsoleMode.invokeExact(hConsole, ENABLE_PROCESSED_OUTPUT | ENABLE_VIRTUAL_TERMINAL_PROCESSING); } catch (RuntimeException | Error unchecked) { throw unchecked; } catch (Throwable e) { throw new AssertionError("Error during ANSI initialization: " + e.getMessage(), e); } } }
注意事项：
- Java版本要求： 此方法需要Java 22或更高版本。
- 原生调用： 这种方法直接通过FFM api调用Windows原生函数，效率更高，且无需外部进程。
- 错误处理： 原生调用可能因权限、系统环境等问题失败，需要适当的错误处理。
- 跨平台兼容性： FFM API本身是跨平台的，但调用特定的kernel32.dll函数是Windows特有的。在非Windows系统上运行此initANSI方法会失败，因此在实际应用中需要进行操作系统判断。
注意事项与最佳实践
- 操作系统判断： 在生产环境中，建议根据System.getProperty(“os.name”)来判断当前操作系统，并选择合适的ANSI启用策略。例如，在Windows上尝试启用，在linux/macOS上则直接输出。
- Windows版本： 确保目标Windows系统是Windows 10版本1511或更高。对于更旧的Windows版本，即使尝试启用虚拟终端处理也可能无效。
- 第三方库： 对于不支持Java 22或希望更简便地处理跨平台ANSI输出的场景，可以考虑使用像Jansi这样的第三方库。Jansi可以在运行时检测当前终端的能力，并在必要时提供ANSI转义序列的模拟或转换，从而在多种终端环境下实现彩色输出。
- ANSI转义序列标准： 熟悉常用的ANSI转义序列，例如：
- u001B[0m：重置所有属性
- u001B[1m：加粗
- u001B[3m：斜体
- u001B[4m：下划线
- u001B[30m – u001B[37m：前景色（黑、红、绿、黄、蓝、洋红、青、白）
- u001B[90m – u001B[97m：高强度前景色
- u001B[40m – u001B[47m：背景色
- u001B[100m – u001B[107m：高强度背景色
总结
在Java应用程序中实现Windows CMD终端的彩色输出，需要克服CMD对ANSI转义序列的默认限制。对于Java 22之前的版本或追求通用兼容性的场景，通过ProcessBuilder委托给外部echo命令是一种可行的方案，但需注意其性能开销。而对于Java 22及更高版本，利用FFM API直接调用Windows原生函数来启用虚拟终端处理，则提供了一种更高效、更原生的解决方案。在实际开发中，应根据项目需求、Java版本和目标操作系统环境选择最合适的实现方式，或考虑使用成熟的第三方库来简化跨平台终端输出的管理。
评论（已关闭）
评论已关闭