在Java中转义HTML的推荐方法

有没有逃脱推荐的方式<，>，"和&字符时输出HTML中普通的Java代码？（也就是说，除了手动执行以下操作之外）。

String source = "The less than sign (<) and ampersand (&) must be escaped before using them in HTML";
String escaped = source.replace("<", "&lt;").replace("&", "&amp;"); // ...

来自Apache Commons Lang的StringEscapeUtils：

import static org.apache.commons.lang.StringEscapeUtils.escapeHtml;
// ...
String source = "The less than sign (<) and ampersand (&) must be escaped before using them in HTML";
String escaped = escapeHtml(source);

对于版本3：

import static org.apache.commons.lang3.StringEscapeUtils.escapeHtml4;
// ...
String escaped = escapeHtml4(source);

Apache Commons的替代方法：使用Spring的HtmlUtils.htmlEscape(String input)方法。

不错的简短方法：

public static String escapeHTML(String s) {
    StringBuilder out = new StringBuilder(Math.max(16, s.length()));
    for (int i = 0; i < s.length(); i++) {
        char c = s.charAt(i);
        if (c > 127 || c == '"' || c == '\'' || c == '<' || c == '>' || c == '&') {
            out.append("&#");
            out.append((int) c);
            out.append(';');
        } else {
            out.append(c);
        }
    }
    return out.toString();
}

基于https://stackoverflow.com/a/8838023/1199155（此处缺少放大器）。根据http://www.w3.org/TR/html4/sgml/entities.html，在if子句中检查的四个字符是唯一在128以下的字符

有一个Apache Commons Lang库的较新版本，它使用了不同的包名称（org.apache.commons.lang3）。在StringEscapeUtils现在有逃避不同类型的文档不同的静态方法（http://commons.apache.org/proper/commons-lang/javadocs/api-3.0/index.html）。因此，要转义HTML 4.0版字符串：

import static org.apache.commons.lang3.StringEscapeUtils.escapeHtml4;

String output = escapeHtml4("The less than sign (<) and ampersand (&) must be escaped before using them in HTML");

对于使用Google Guava的用户：

import com.google.common.html.HtmlEscapers;
[...]
String source = "The less than sign (<) and ampersand (&) must be escaped before using them in HTML";
String escaped = HtmlEscapers.htmlEscaper().escape(source);

在android（API 16或更高版本）上，您可以：

Html.escapeHtml(textToScape);

或针对较低的API：

TextUtils.htmlEncode(textToScape);

请注意这一点。HTML文档中有许多不同的“上下文”：在元素内，带引号的属性值，未带引号的属性值，URL属性，javascript，CSS等...对于每种情况，您都需要使用不同的编码方法这些可以防止跨站点脚本（XSS）。查看OWASP XSS预防备忘单，以获取有关每种情况的详细信息。您可以在OWASP ESAPI库（https://github.com/ESAPI/esapi-java-legacy）中找到每种上下文的转义方法。

出于某些目的，HtmlUtils：

import org.springframework.web.util.HtmlUtils;
[...]
HtmlUtils.htmlEscapeDecimal("&"); //gives &
HtmlUtils.htmlEscape("&"); //gives &

@dfa的答案org.apache.commons.lang.StringEscapeUtils.escapeHtml很好，我过去也曾使用过它，不应将其用于转义HTML（或XML）属性否则空格将被规范化（意味着所有相邻的空格字符都变成一个空格）。

我知道这一点是因为我在我的库（JATL）上有一些针对未保留空格的属性的错误。因此，我有一类（复制n'paste）类（我从JDOM中偷了一些）来区别转义属性和元素内容。

尽管过去可能没有多大作用（适当的属性转义），但是鉴于使用HTML5 data-属性使用，它变得越来越引起人们的关注。

org.apache.commons.lang3.StringEscapeUtils现在已弃用。您现在必须通过以下方式使用org.apache.commons.text.StringEscapeUtils

    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-text</artifactId>
        <version>${commons.text.version}</version>
    </dependency>

大多数库都提供了尽可能的转义，包括数百个符号和数千个非ASCII字符，这在UTF-8世界中不是您想要的。

而且，正如Jeff Williams指出的那样，没有一个单独的“转义HTML”选项，有多个上下文。

假设您从不使用未引用的属性，并记住存在不同的上下文，那么它已经编写了自己的版本：

private static final long BODY_ESCAPE =
        1L << '&' | 1L << '<' | 1L << '>';
private static final long DOUBLE_QUOTED_ATTR_ESCAPE =
        1L << '"' | 1L << '&' | 1L << '<' | 1L << '>';
private static final long SINGLE_QUOTED_ATTR_ESCAPE =
        1L << '"' | 1L << '&' | 1L << '\'' | 1L << '<' | 1L << '>';

// 'quot' and 'apos' are 1 char longer than '#34' and '#39' which I've decided to use
private static final String REPLACEMENTS = "&#34;&amp;&#39;&lt;&gt;";
private static final int REPL_SLICES = /*  |0,   5,   10,  15, 19, 23*/
        5<<5 | 10<<10 | 15<<15 | 19<<20 | 23<<25;
// These 5-bit numbers packed into a single int
// are indices within REPLACEMENTS which is a 'flat' String[]

private static void appendEscaped(
        StringBuilder builder,
        CharSequence content,
        long escapes // pass BODY_ESCAPE or *_QUOTED_ATTR_ESCAPE here
) {
    int startIdx = 0, len = content.length();
    for (int i = 0; i < len; i++) {
        char c = content.charAt(i);
        long one;
        if (((c & 63) == c) && ((one = 1L << c) & escapes) != 0) {
        // -^^^^^^^^^^^^^^^   -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        // |                  | take only dangerous characters
        // | java shifts longs by 6 least significant bits,
        // | e. g. << 0b110111111 is same as >> 0b111111.
        // | Filter out bigger characters

            int index = Long.bitCount(SINGLE_QUOTED_ATTR_ESCAPE & (one - 1));
            builder.append(content, startIdx, i /* exclusive */)
                    .append(REPLACEMENTS,
                            REPL_SLICES >>> 5*index & 31,
                            REPL_SLICES >>> 5*(index+1) & 31);
            startIdx = i + 1;
        }
    }
    builder.append(content, startIdx, len);
}

考虑从Gist复制粘贴而没有行长限制。