com.github.zhangxd1989.basetool.http.HtmlUtil Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of basetool Show documentation
Java Common Utils
There is a newer version: 1.0.16
package com.github.zhangxd1989.basetool.http;


import com.github.zhangxd1989.basetool.util.ReUtil;
import com.github.zhangxd1989.basetool.util.StrUtil;

/**
 * HTML工具类
 *
 * @author sheldon
 */
public class HtmlUtil {

    public static final String NBSP = StrUtil.HTML_NBSP;
    public static final String AMP = StrUtil.HTML_AMP;
    public static final String QUOTE = StrUtil.HTML_QUOTE;
    public static final String APOS = StrUtil.HTML_APOS;
    public static final String LT = StrUtil.HTML_LT;
    public static final String GT = StrUtil.HTML_GT;

    public static final String RE_HTML_MARK = "(<[^<]*?>)|(<[\\s]*?/[^<]*?>)|(<[^<]*?/[\\s]*?>)";
    public static final String RE_SCRIPT = "<[\\s]*?script[^>]*?>.*?<[\\s]*?\\/[\\s]*?script[\\s]*?>";

    private static final char[][] TEXT = new char[64][];

    static {
        for (int i = 0; i < 64; i++) {
            TEXT[i] = new char[]{(char) i};
        }

        // special HTML characters
        TEXT['\''] = "'".toCharArray(); // 单引号 (''' doesn't work - it is not by the w3 specs)
        TEXT['"'] = QUOTE.toCharArray(); // 单引号
        TEXT['&'] = AMP.toCharArray(); // &符
        TEXT['<'] = LT.toCharArray(); // 小于号
        TEXT['>'] = GT.toCharArray(); // 大于号
    }

    /**
     * 转义文本中的HTML字符为安全的字符，以下字符被转义：
     * 
     * '  替换为 &#039; (&apos; doesn't work in HTML4)
     * "  替换为 &quot;
     * & 替换为 &amp;
     * < 替换为 &lt;
     * > 替换为 &gt;
     * 
     *
     * @param text 被转义的文本
     * @return 转义后的文本
     */
    public static String escape(String text) {
        return encode(text, TEXT);
    }

    /**
     * 还原被转义的HTML特殊字符
     *
     * @param htmlStr 包含转义符的HTML内容
     * @return 转换后的字符串
     */
    public static String unescape(String htmlStr) {
        if (StrUtil.isBlank(htmlStr)) {
            return htmlStr;
        }
        return htmlStr.replace(StrUtil.HTML_APOS, "'")
                .replace("'", "'")
                .replace("'", "'")
                .replace(StrUtil.HTML_LT, "<")
                .replace(StrUtil.HTML_GT, ">")
                .replace(StrUtil.HTML_QUOTE, "\"")
                .replace(StrUtil.HTML_AMP, "&")
                .replace(StrUtil.HTML_NBSP, " "
                );
    }

    /**
     * 清除所有HTML标签
     *
     * @param content 文本
     * @return 清除标签后的文本
     */
    public static String cleanHtmlTag(String content) {
        return content.replaceAll(RE_HTML_MARK, "");
    }

    /**
     * 清除指定HTML标签和被标签包围的内容

     * 不区分大小写
     *
     * @param content  文本
     * @param tagNames 要清除的标签
     * @return 去除标签后的文本
     */
    public static String removeHtmlTag(String content, String... tagNames) {
        return removeHtmlTag(content, true, tagNames);
    }

    /**
     * 清除指定HTML标签，不包括内容

     * 不区分大小写
     *
     * @param content  文本
     * @param tagNames 要清除的标签
     * @return 去除标签后的文本
     */
    public static String unwrapHtmlTag(String content, String... tagNames) {
        return removeHtmlTag(content, false, tagNames);
    }

    /**
     * 清除指定HTML标签

     * 不区分大小写
     *
     * @param content        文本
     * @param withTagContent 是否去掉被包含在标签中的内容
     * @param tagNames       要清除的标签
     * @return 去除标签后的文本
     */
    public static String removeHtmlTag(String content, boolean withTagContent, String... tagNames) {
        String regex;
        for (String tagName : tagNames) {
            if (StrUtil.isBlank(tagName)) {
                continue;
            }
            tagName = tagName.trim();
            // (?i)表示其后面的表达式忽略大小写
            if (withTagContent) {
                // 标签及其包含内容
                regex = StrUtil.format("(?i)<{}\\s*?[^>]*?/?>(.*?)?", tagName, tagName);
            } else {
                // 标签不包含内容
                regex = StrUtil.format("(?i)<{}\\s*?[^>]*?>|", tagName, tagName);
            }

            content = ReUtil.delAll(regex, content); // 非自闭标签小写
        }
        return content;
    }

    /**
     * 去除HTML标签中的属性
     *
     * @param content 文本
     * @param attrs   属性名（不区分大小写）
     * @return 处理后的文本
     */
    public static String removeHtmlAttr(String content, String... attrs) {
        String regex;
        for (String attr : attrs) {
            regex = StrUtil.format("(?i)\\s*{}=([\"']).*?\\1", attr);
            content = content.replaceAll(regex, StrUtil.EMPTY);
        }
        return content;
    }

    /**
     * 去除指定标签的所有属性
     *
     * @param content  内容
     * @param tagNames 指定标签
     * @return 处理后的文本
     */
    public static String removeAllHtmlAttr(String content, String... tagNames) {
        String regex;
        for (String tagName : tagNames) {
            regex = StrUtil.format("(?i)<{}[^>]*?>", tagName);
            content = content.replaceAll(regex, StrUtil.format("<{}>", tagName));
        }
        return content;
    }

    /**
     * Encoder
     *
     * @param text  被编码的文本
     * @param array 特殊字符集合
     * @return 编码后的字符
     */
    private static String encode(String text, char[][] array) {
        int len;
        if ((text == null) || ((len = text.length()) == 0)) {
            return StrUtil.EMPTY;
        }
        StringBuilder buffer = new StringBuilder(len + (len >> 2));
        char c;
        for (int i = 0; i < len; i++) {
            c = text.charAt(i);
            if (c < 64) {
                buffer.append(array[c]);
            } else {
                buffer.append(c);
            }
        }
        return buffer.toString();
    }

    /**
     * 过滤HTML文本，防止XSS攻击
     *
     * @param htmlContent HTML内容
     * @return 过滤后的内容
     */
    public static String filter(String htmlContent) {
        return new HTMLFilter().filter(htmlContent);
    }
}