在Java中为XML编码文本数据的最佳方法？

除了Java之外，这个问题非常相似。

在Java中为XML输出编码字符串的推荐方法是什么。字符串可能包含“＆”，“ <”等字符。

很简单：使用XML库。这样，实际上将是正确的，而不需要XML规范的详细知识。

正如其他人提到的那样，使用XML库是最简单的方法。如果您想逃避现实，可以StringEscapeUtils从Apache Commons Lang库中进行研究。

随便使用。

<![CDATA[ your text here ]]>

这将允许除结尾以外的任何字符

]]>

因此，您可以包含非法字符，例如＆和>。例如。

<element><![CDATA[ characters such as & and > are allowed ]]></element>

但是，将需要转义属性，因为不能将CDATA块用于它们。

对我来说，提供文本字符串的转义版本非常有效：

public class XMLHelper {

/**
 * Returns the string where all non-ascii and <, &, > are encoded as numeric entities. I.e. "&lt;A &amp; B &gt;"
 * .... (insert result here). The result is safe to include anywhere in a text field in an XML-string. If there was
 * no characters to protect, the original string is returned.
 * 
 * @param originalUnprotectedString
 *            original string which may contain characters either reserved in XML or with different representation
 *            in different encodings (like 8859-1 and UFT-8)
 * @return
 */
public static String protectSpecialCharacters(String originalUnprotectedString) {
    if (originalUnprotectedString == null) {
        return null;
    }
    boolean anyCharactersProtected = false;

    StringBuffer stringBuffer = new StringBuffer();
    for (int i = 0; i < originalUnprotectedString.length(); i++) {
        char ch = originalUnprotectedString.charAt(i);

        boolean controlCharacter = ch < 32;
        boolean unicodeButNotAscii = ch > 126;
        boolean characterWithSpecialMeaningInXML = ch == '<' || ch == '&' || ch == '>';

        if (characterWithSpecialMeaningInXML || unicodeButNotAscii || controlCharacter) {
            stringBuffer.append("&#" + (int) ch + ";");
            anyCharactersProtected = true;
        } else {
            stringBuffer.append(ch);
        }
    }
    if (anyCharactersProtected == false) {
        return originalUnprotectedString;
    }

    return stringBuffer.toString();
}

}

试试这个：

String xmlEscapeText(String t) {
   StringBuilder sb = new StringBuilder();
   for(int i = 0; i < t.length(); i++){
      char c = t.charAt(i);
      switch(c){
      case '<': sb.append("&lt;"); break;
      case '>': sb.append("&gt;"); break;
      case '\"': sb.append("&quot;"); break;
      case '&': sb.append("&amp;"); break;
      case '\'': sb.append("&apos;"); break;
      default:
         if(c>0x7e) {
            sb.append("&#"+((int)c)+";");
         }else
            sb.append(c);
      }
   }
   return sb.toString();
}

这个问题已有八年历史了，仍然不是一个完全正确的答案！不，您不必导入整个第三方API即可完成此简单任务。不好的建议。

以下方法将：

• 正确处理基本多语言平面之外的字符
• XML所需的转义字符
• 转义任何非ASCII字符，这是可选的但很常见
• 用Unicode替换字符替换XML 1.0中的非法字符。这里没有最佳选择-删除它们同样有效。

我已尝试针对最常见的情况进行优化，同时仍然确保可以通过管道传递/ dev / random并获取XML中的有效字符串。

public static String encodeXML(CharSequence s) {
    StringBuilder sb = new StringBuilder();
    int len = s.length();
    for (int i=0;i<len;i++) {
        int c = s.charAt(i);
        if (c >= 0xd800 && c <= 0xdbff && i + 1 < len) {
            c = ((c-0xd7c0)<<10) | (s.charAt(++i)&0x3ff);    // UTF16 decode
        }
        if (c < 0x80) {      // ASCII range: test most common case first
            if (c < 0x20 && (c != '\t' && c != '\r' && c != '\n')) {
                // Illegal XML character, even encoded. Skip or substitute
                sb.append("&#xfffd;");   // Unicode replacement character
            } else {
                switch(c) {
                  case '&':  sb.append("&amp;"); break;
                  case '>':  sb.append("&gt;"); break;
                  case '<':  sb.append("&lt;"); break;
                  // Uncomment next two if encoding for an XML attribute
//                  case '\''  sb.append("&apos;"); break;
//                  case '\"'  sb.append("&quot;"); break;
                  // Uncomment next three if you prefer, but not required
//                  case '\n'  sb.append("&#10;"); break;
//                  case '\r'  sb.append("&#13;"); break;
//                  case '\t'  sb.append("&#9;"); break;

                  default:   sb.append((char)c);
                }
            }
        } else if ((c >= 0xd800 && c <= 0xdfff) || c == 0xfffe || c == 0xffff) {
            // Illegal XML character, even encoded. Skip or substitute
            sb.append("&#xfffd;");   // Unicode replacement character
        } else {
            sb.append("&#x");
            sb.append(Integer.toHexString(c));
            sb.append(';');
        }
    }
    return sb.toString();
}

编辑：对于那些仍然坚持使用愚蠢的Java API来编写自己的代码来愚弄XML的人，您可能想知道Oracle Java 8附带的StAX API（我没有测试其他人）无法正确编码CDATA内容：无法在内容中转义]]>序列。第三方库，即使是Java核心的一部分，也不总是最好的选择。

StringEscapeUtils.escapeXml()不转义控制字符（<0x20）。XML 1.1允许控制字符；XML 1.0没有。例如，XStream.toXML()将愉快地将Java对象的控制字符序列化为XML，而XML 1.0解析器将拒绝该XML。

要使用Apache commons-lang转义控制字符，请使用

NumericEntityEscaper.below(0x20).translate(StringEscapeUtils.escapeXml(str))

public String escapeXml(String s) {
    return s.replaceAll("&", "&amp;").replaceAll(">", "&gt;").replaceAll("<", "&lt;").replaceAll("\"", "&quot;").replaceAll("'", "&apos;");
}

理想主义说使用XML库，而恕我直言，如果您对XML有基本了解，那么常识和性能将始终使用模板。可以说它也更具可读性。尽管使用库的转义例程可能是一个好主意。

考虑一下：XML 是人类编写的。

将XML作为“对象”时，可以使用库来生成XML，以更好地为您的问题建模。例如，如果可插拔模块参与构建此XML的过程。

编辑：至于如何在模板中实际转义XML，使用CDATA或escapeXml(string)来自JSTL是两个很好的解决方案，escapeXml(string)可以这样使用：

<%@taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions"%>

<item>${fn:escapeXml(value)}</item>

StringEscapeUtils.escapeXml（）的行为已从Commons Lang 2.5更改为3.0。现在，它不再转义大于0x7f的Unicode字符。

这是一件好事，旧的方法是有点急于逃脱可能只是插入到utf8文档中的实体。

包含在Google Guava 11.0中的新逃逸者似乎也很有希望：http : //code.google.com/p/guava-libraries/issues/detail? id=799

对于那些寻求最快编写速度的解决方案的人：使用apache commons-lang中的方法：

• StringEscapeUtils.escapeXml10() 对于xml 1.0
• StringEscapeUtils.escapeXml11() 对于xml 1.1
• StringEscapeUtils.escapeXml() 现在已弃用，但过去经常使用

记住要包括依赖性：

<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-lang3</artifactId>
  <version>3.5</version> <!--check current version! -->
</dependency>

注意：您的问题是关于转义，而不是编码。转义使用<等，以允许解析器区分“这是XML命令”和“这是某些文本”。编码是您在XML标头（UTF-8，ISO-8859-1等）中指定的内容。

首先，像其他人一样，使用XML库。XML看起来很简单，但是编码+转义的内容是深色的伏都教（您会在遇到变音符号和日语以及其他诸如“全角数字 ”（＆＃FF11;为1））。使XML保持人类可读性是Sisyphus的任务。

我建议不要尝试对XML的文本编码和转义保持聪明。但是不要让那阻止你尝试；只要记住它什么时候咬你（就会）。

就是说，如果仅使用UTF-8，则为了使内容更具可读性，可以考虑采用以下策略：

• 如果文本中确实包含“ <”，“>”或“＆”，请用 <![CDATA[ ... ]]>
• 如果文本不包含这三个字符，请不要扭曲它。

我在SQL编辑器中使用它，它使开发人员可以将SQL从第三方SQL工具剪切并粘贴到XML中，而不必担心转义。这行得通，因为在我们的例子中，SQL不能包含变音符号，所以我很安全。

尽管我在原则上同意Jon Skeet的观点，但有时我无法选择使用外部XML库。而且，我发现Java附带的标准XML库中没有提供两个功能来对一个简单值（属性或标记，不是完整的文档）进行转义/转义。

结果，基于我在这里和其他地方看到的不同答案，这是我最终创建的解决方案（没有任何方法可以用作简单的复制/粘贴）：

  public final static String ESCAPE_CHARS = "<>&\"\'";
  public final static List<String> ESCAPE_STRINGS = Collections.unmodifiableList(Arrays.asList(new String[] {
      "&lt;"
    , "&gt;"
    , "&amp;"
    , "&quot;"
    , "&apos;"
  }));

  private static String UNICODE_LOW =  "" + ((char)0x20); //space
  private static String UNICODE_HIGH = "" + ((char)0x7f);

  //should only use for the content of an attribute or tag      
  public static String toEscaped(String content) {
    String result = content;

    if ((content != null) && (content.length() > 0)) {
      boolean modified = false;
      StringBuilder stringBuilder = new StringBuilder(content.length());
      for (int i = 0, count = content.length(); i < count; ++i) {
        String character = content.substring(i, i + 1);
        int pos = ESCAPE_CHARS.indexOf(character);
        if (pos > -1) {
          stringBuilder.append(ESCAPE_STRINGS.get(pos));
          modified = true;
        }
        else {
          if (    (character.compareTo(UNICODE_LOW) > -1)
               && (character.compareTo(UNICODE_HIGH) < 1)
             ) {
            stringBuilder.append(character);
          }
          else {
            stringBuilder.append("&#" + ((int)character.charAt(0)) + ";");
            modified = true;
          }
        }
      }
      if (modified) {
        result = stringBuilder.toString();
      }
    }

    return result;
  }

上面包含了几种不同的内容：

1. 除非绝对必要，否则避免使用基于char的逻辑-改善unicode兼容性
2. 假设概率是第二个“如果”条件可能是最常用的途径，则尝试尽可能地提高效率
3. 是一个纯函数；即是线程安全的
4. 如果实际更改了某些内容，则仅通过返回StringBuilder的内容来对垃圾回收器进行优化，否则将返回原始字符串

在某个时候，我将编写该函数的反函数toUnescaped（）。我只是今天没有时间这样做。完成后，我将使用代码更新此答案。:)

要转义XML字符，最简单的方法是使用Apache Commons Lang项目（可从以下网站下载JAR）：http : //commons.apache.org/lang/

该类是这样的：org.apache.commons.lang3.StringEscapeUtils;

它具有一个名为“ escapeXml”的方法，该方法将返回适当转义的String。

如果您正在寻找一个图书馆来完成工作，请尝试：

1. 番石榴26.0记录在这里

   return XmlEscapers.xmlContentEscaper().escape(text);

   注意：还有一个 xmlAttributeEscaper()

2. 此处记录了Apache Commons Text 1.4

   StringEscapeUtils.escapeXml11(text)

   注意：还有一种escapeXml10()方法

这是一个简单的解决方案，也非常适合对重音字符进行编码！

String in = "Hi Lârry & Môe!";

StringBuilder out = new StringBuilder();
for(int i = 0; i < in.length(); i++) {
    char c = in.charAt(i);
    if(c < 31 || c > 126 || "<>\"'\\&".indexOf(c) >= 0) {
        out.append("&#" + (int) c + ";");
    } else {
        out.append(c);
    }
}

System.out.printf("%s%n", out);

产出

Hi Lârry & Môe!

您可以使用企业安全API（ESAPI）库，该库提供诸如encodeForXML和的方法encodeForXMLAttribute。查看编码器接口的文档；它还包含有关如何创建DefaultEncoder实例的示例。

只需更换

 & with &

对于其他字符：

> with >
< with &lt;
\" with &quot;
' with &apos;

使用JAXP，而无需担心文本处理，它将自动为您完成。

尝试使用Apache XML序列化器对XML进行编码

//Serialize DOM
OutputFormat format    = new OutputFormat (doc); 
// as a String
StringWriter stringOut = new StringWriter ();    
XMLSerializer serial   = new XMLSerializer (stringOut, 
                                          format);
serial.serialize(doc);
// Display the XML
System.out.println(stringOut.toString());

这是我到处搜索解决方案后发现的：

获取Jsoup库：

<!-- https://mvnrepository.com/artifact/org.jsoup/jsoup -->
<dependency>
    <groupId>org.jsoup</groupId>
    <artifactId>jsoup</artifactId>
    <version>1.12.1</version>
</dependency>

然后：

import org.jsoup.Jsoup
import org.jsoup.nodes.Document
import org.jsoup.nodes.Entities
import org.jsoup.parser.Parser

String xml = '''<?xml version = "1.0"?>
<SOAP-ENV:Envelope
   xmlns:SOAP-ENV = "http://www.w3.org/2001/12/soap-envelope"
   SOAP-ENV:encodingStyle = "http://www.w3.org/2001/12/soap-encoding">

   <SOAP-ENV:Body xmlns:m = "http://www.example.org/quotations">
      <m:GetQuotation>
         <m:QuotationsName> MiscroSoft@G>>gle.com </m:QuotationsName>
      </m:GetQuotation>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>'''



Document doc = Jsoup.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")), "UTF-8", "", Parser.xmlParser())
doc.outputSettings().charset("UTF-8")
doc.outputSettings().escapeMode(Entities.EscapeMode.base)

println doc.toString()

希望这可以帮助某人