Java Panama调用Windows MessageBoxW函数乱码问题及解决

我在使用Java Panama调用Windows系统的MessageBoxW函数时遇到了乱码问题，弹窗文本显示异常（包含正常显示及三种异常显示情况）。

原实现代码 #

import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
import java.lang.foreign.Linker;
import java.lang.foreign.MemoryLayout;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.SymbolLookup;
import java.lang.foreign.ValueLayout;
import java.nio.charset.StandardCharsets;

public class MessageBoxWMain {

    public static void main(String[] args) throws Throwable {
        var linker = Linker.nativeLinker();
        try (var arena = Arena.ofConfined()) {
            var user32 = SymbolLookup.libraryLookup("User32", arena);

            var messageBoxW_MH = linker.downcallHandle(user32.find("MessageBoxW").get(), FunctionDescriptor.of(
                    ValueLayout.JAVA_INT, // 返回值：int
                    ValueLayout.ADDRESS, // HWND hWnd
                    ValueLayout.ADDRESS.withTargetLayout(MemoryLayout.sequenceLayout(ValueLayout.JAVA_BYTE)), // LPCWSTR lpText
                    ValueLayout.ADDRESS.withTargetLayout(MemoryLayout.sequenceLayout(ValueLayout.JAVA_BYTE)), // LPCWSTR lpCaption
                    ValueLayout.JAVA_INT // UINT uType
            ));

            var NULL = MemorySegment.NULL; // HWND hWnd = NULL
            var cs = StandardCharsets.UTF_16LE;
            
            // LPCWSTR lpText = "Hello from Panama! 你好, the world"
            var lpText = arena.allocateArray(ValueLayout.JAVA_BYTE,
                    "Hello from Panama! 你好, the world".getBytes(cs));
            // LPCWSTR lpCaption = "Demo123 你好，世界"
            var lpCaption = arena.allocateArray(ValueLayout.JAVA_BYTE, "Demo123 你好，世界".getBytes(cs));

            var MB_OK = 0x0; // UINT uType = MB_OK

            var result = (int) messageBoxW_MH.invokeExact(NULL, lpText, lpCaption, MB_OK);
            System.out.println(STR."MessageBox result: \{result}");
        }
    }

    private static MemorySegment allocateArray(Arena arena, String str) {
        var bs = str.getBytes(StandardCharsets.UTF_16LE);
        var ms = arena.allocate(bs.length + 1);
        var i = 0;
        for (; i < bs.length; i++) {
            ms.set(ValueLayout.JAVA_BYTE, i, bs[i]);
        }
        ms.set(ValueLayout.JAVA_BYTE, i, (byte) '\0');

        return ms;
    }
}

问题排查与解决 #

我曾尝试添加C语言单字节终止符\0，但问题依旧。最终通过在UTF-16LE编码后的字节数组末尾添加**双字节终止符（两个\0）**解决了乱码问题，修正后的allocateArray方法如下：

private static MemorySegment allocateArray(Arena arena, String str) {
    var bs = str.getBytes(StandardCharsets.UTF_16LE);
    var ms = arena.allocate(bs.length + 2);
    var i = 0;
    for (; i < bs.length; i++) {
        ms.set(ValueLayout.JAVA_BYTE, i, bs[i]);
    }
    // 修复：UTF-16LE需要双字节终止符
    ms.set(ValueLayout.JAVA_BYTE, i++, (byte) '\0');
    ms.set(ValueLayout.JAVA_BYTE, i, (byte) '\0');

    return ms;
}

原代码问题分析 #

1. 宽字符终止符错误：MessageBoxW是Windows宽字符API，要求传入的LPCWSTR字符串必须以**双字节空值（0x0000）**作为结束标志。原代码中无论是直接调用allocateArray分配字节数组，还是自定义方法添加单个\0，都只提供了单字节终止符，系统无法识别为字符串结束，会继续读取后续内存垃圾数据，导致乱码。
2. 函数描述符布局不规范：LPCWSTR对应UTF-16LE的宽字符序列（每个字符占2字节），原代码中用MemoryLayout.sequenceLayout(ValueLayout.JAVA_BYTE)作为目标布局不符合宽字符的内存结构，虽然不影响功能，但规范写法应对应短整型序列。

确保弹窗始终正常显示的方法 #

• 严格使用双字节终止符：对UTF-16LE编码后的字节数组，必须添加两个连续的\0字节，组成完整的宽字符终止符。
• 使用Panama内置简化方法：直接调用Arena.allocateUtf16String()方法，该方法会自动完成UTF-16LE编码和双字节终止符的添加，无需手动处理字节数组：

  var lpText = arena.allocateUtf16String("Hello from Panama! 你好, the world");
  var lpCaption = arena.allocateUtf16String("Demo123 你好，世界");
  

• 修正函数描述符：将lpText和lpCaption的目标布局改为宽字符对应的短整型序列，更贴合API定义：

  FunctionDescriptor.of(
          ValueLayout.JAVA_INT,
          ValueLayout.ADDRESS,
          ValueLayout.ADDRESS.withTargetLayout(MemoryLayout.sequenceLayout(ValueLayout.JAVA_SHORT)),
          ValueLayout.ADDRESS.withTargetLayout(MemoryLayout.sequenceLayout(ValueLayout.JAVA_SHORT)),
          ValueLayout.JAVA_INT
  )
  

内容的提问来源于stack exchange，提问作者Xianzhan