如何将任意字符串转换为 Java 标识符？

Question

我需要转换任意字符串：

• 带空格的字符串
• 100stringsstartswithnumber
• 字符串€with%special†characters/\!
• [空字符串]

到一个有效的 Java 标识符：

• string_with_spaces
• _100stringsstartswithnumber
• string_with_special_characters___
• _

这个任务有现成的工具吗？

有这么多 Java 源代码重构/生成框架，人们会认为这应该是相当普遍的任务。

Answer 1

这个简单的方法会将任何输入字符串转换成一个有效的java标识符：

public static String getIdentifier(String str) {
    try {
        return Arrays.toString(str.getBytes("UTF-8")).replaceAll("\\D+", "_");
    } catch (UnsupportedEncodingException e) {
        // UTF-8 is always supported, but this catch is required by compiler
        return null;
    }
}

例子：

"%^&*\n()" --> "_37_94_38_42_10_56_94_40_41_"

任何输入字符都可以使用 - 外语字符、换行符等等！
另外，这个算法是：

• 可重现
• 独特 - 即如果str1.equals(str2)，将总是和仅产生相同的结果
• 可逆

感谢Joachim Sauer 的UTF-8 建议

---

如果冲突正常（两个输入字符串可能产生相同的结果），则此代码会产生可读的输出：

public static String getIdentifier(String str) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < str.length(); i++) {
        if ((i == 0 && Character.isJavaIdentifierStart(str.charAt(i))) || (i > 0 && Character.isJavaIdentifierPart(str.charAt(i))))
            sb.append(str.charAt(i));
        else
            sb.append((int)str.charAt(i));
    }
    return sb.toString();
}

它保留作为有效标识符的字符，仅将那些无效的字符转换为其十进制等效值。

Answer 2

我不知道用于此目的的工具，但可以使用 Character 类轻松创建它。

您知道 string€with_special_characters___ 是合法的 java 标识符吗？

public class Conv {
    public static void main(String[] args) {
        String[] idents = { "string with spaces", "100stringsstartswithnumber",
                "string€with%special†characters/\\!", "" };
        for (String ident : idents) {
            System.out.println(convert(ident));
        }
    }

    private static String convert(String ident) {
        if (ident.length() == 0) {
            return "_";
        }
        CharacterIterator ci = new StringCharacterIterator(ident);
        StringBuilder sb = new StringBuilder();
        for (char c = ci.first(); c != CharacterIterator.DONE; c = ci.next()) {
            if (c == ' ')
                c = '_';
            if (sb.length() == 0) {
                if (Character.isJavaIdentifierStart(c)) {
                    sb.append(c);
                    continue;
                } else
                    sb.append('_');
            }
            if (Character.isJavaIdentifierPart(c)) {
                sb.append(c);
            } else {
                sb.append('_');
            }
        };
        return sb.toString();
    }
}

打印

string_with_spaces
_100stringsstartswithnumber
string€with_special_characters___
_

Answer 3

如果您是为自动生成的代码执行此操作（即不太关心可读性），我最喜欢的一个就是 Base64 它。无需就哪些字符在哪些编码中有效而争论不休，这是“保护”任意字节数据的一种非常常见的方式。

Answer 4

有这么多 Java 源代码重构/生成框架，人们会认为这应该是相当普遍的任务。

其实不是。

• 代码重构框架将从现有的有效 java 标识符开始，将能够通过将它们与一些附加字符连接来生成新标识符以用于消除歧义。

• 一个典型的代码生成框架将从一个受限制的字符集中的“名称”开始。它不必处理任意字符。

---

我认为您的转换器的目的是在可能的情况下生成类似于输入字符串的标识符。如果是这种情况，我将通过按原样映射所有合法标识符字符来进行转换，并将非法标识符字符替换为“$xxxx”，其中“xxxx”是 Java 16 位字符的 4 位十六进制编码。

您的方案也可以，但是用“_”替换所有非法字符更有可能导致标识符冲突；即两个输入字符串映射到相同的标识符。

这是直截了当的代码，所以我将其留给您完成。