EscapeUtil (hutool 5.8.42 API)

java.lang.Object
- cn.hutool.core.util.EscapeUtil

```
public class EscapeUtil
extends Object
```
转义和反转义工具类Escape / Unescape
escape采用ISO Latin字符集对指定的字符串进行编码。
所有的空格符、标点符号、特殊字符以及其他非ASCII字符都将被转化成%xx格式的字符编码(xx等于该字符在字符集表里面的编码的16进制数字)。 TODO 7.x迁移到core.text.escape包下

Author:

xiaoleilu

Constructor Summary

Constructors
Constructor and Description

EscapeUtil()

Constructors
Constructor and Description
`EscapeUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`escape(CharSequence content)` Escape编码（Unicode）（等同于JS的escape()方法）该方法不会对 ASCII 字母和数字进行编码，也不会对下面这些 ASCII 标点符号进行编码： * @ - _ + . / 其他所有的字符都会被转义序列替换。
`static String`	`escape(CharSequence content, Filter<Character> filter)` Escape编码（Unicode）该方法不会对 ASCII 字母和数字进行编码。
`static String`	`escapeAll(CharSequence content)` Escape编码（Unicode）该方法不会对 ASCII 字母和数字进行编码。
`static String`	`escapeHtml4(CharSequence html)` 转义HTML4中的特殊字符
`static String`	`escapeXml(CharSequence xml)` 转义XML中的特殊字符 & (ampersand) 替换为 & < (less than) 替换为 < > (greater than) 替换为 > " (double quote) 替换为 " ' (single quote / apostrophe) 替换为 '
`static String`	`safeUnescape(String content)` 安全的unescape文本，当文本不是被escape的时候，返回原文。
`static String`	`unescape(String content)` Escape解码支持两种转义格式的解码： %XX - 两位十六进制数字，用于表示ASCII字符（0-255） %uXXXX - 四位十六进制数字，用于表示Unicode字符对于不完整的转义序列，本方法会将其原样保留而不抛出异常：字符串末尾的单独"%"字符会被原样保留 "%u"后面不足4位十六进制数字时，整个不完整序列会被原样保留 "%"后面不足2位十六进制数字时（非%u格式），整个不完整序列会被原样保留例如： unescape("test%") = "test%" // 末尾的%被保留 unescape("test%u12") = "test%u12" // 不足4位，原样保留 unescape("test%2") = "test%2" // 不足2位，原样保留 unescape("test%20") = "test " // 正常解码空格 unescape("test%u4E2D") = "test中" // 正常解码中文字符
`static String`	`unescapeHtml4(CharSequence html)` 反转义HTML4中的特殊字符
`static String`	`unescapeXml(CharSequence xml)` 反转义XML中的特殊字符

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EscapeUtil
```
public EscapeUtil()
```
- Method Detail
  - escapeXml
```
public static String escapeXml(CharSequence xml)
```
    转义XML中的特殊字符
```
         & (ampersand) 替换为 &amp;
         < (less than) 替换为 &lt;
         > (greater than) 替换为 &gt;
         " (double quote) 替换为 &quot;
         ' (single quote / apostrophe) 替换为 &apos;
 
```
    Parameters:
    
    xml - XML文本
    
    Returns:
    
    转义后的文本
    
    Since:
    
    5.7.2
  - unescapeXml
```
public static String unescapeXml(CharSequence xml)
```
    反转义XML中的特殊字符
    
    Parameters:
    
    xml - XML文本
    
    Returns:
    
    转义后的文本
    
    Since:
    
    5.7.2
  - escapeHtml4
```
public static String escapeHtml4(CharSequence html)
```
    转义HTML4中的特殊字符
    
    Parameters:
    
    html - HTML文本
    
    Returns:
    
    转义后的文本
    
    Since:
    
    4.1.5
  - unescapeHtml4
```
public static String unescapeHtml4(CharSequence html)
```
    反转义HTML4中的特殊字符
    
    Parameters:
    
    html - HTML文本
    
    Returns:
    
    转义后的文本
    
    Since:
    
    4.1.5
  - escape
```
public static String escape(CharSequence content)
```
    Escape编码（Unicode）（等同于JS的escape()方法）
    该方法不会对 ASCII 字母和数字进行编码，也不会对下面这些 ASCII 标点符号进行编码： * @ - _ + . /
    其他所有的字符都会被转义序列替换。
    
    Parameters:
    
    content - 被转义的内容
    
    Returns:
    
    编码后的字符串
  - escapeAll
```
public static String escapeAll(CharSequence content)
```
    Escape编码（Unicode）
    该方法不会对 ASCII 字母和数字进行编码。其他所有的字符都会被转义序列替换。
    
    Parameters:
    
    content - 被转义的内容
    
    Returns:
    
    编码后的字符串
  - escape
```
public static String escape(CharSequence content,
                            Filter<Character> filter)
```
    Escape编码（Unicode）
    该方法不会对 ASCII 字母和数字进行编码。其他所有的字符都会被转义序列替换。
    
    Parameters:
    
    content - 被转义的内容
    
    filter - 编码过滤器，对于过滤器中accept为false的字符不做编码
    
    Returns:
    
    编码后的字符串
  - unescape
```
public static String unescape(String content)
```
    Escape解码支持两种转义格式的解码：
    - %XX - 两位十六进制数字，用于表示ASCII字符（0-255）
    - %uXXXX - 四位十六进制数字，用于表示Unicode字符
    对于不完整的转义序列，本方法会将其原样保留而不抛出异常：
    - 字符串末尾的单独"%"字符会被原样保留
    - "%u"后面不足4位十六进制数字时，整个不完整序列会被原样保留
    - "%"后面不足2位十六进制数字时（非%u格式），整个不完整序列会被原样保留
    例如：
```
 unescape("test%")      = "test%"     // 末尾的%被保留
 unescape("test%u12")   = "test%u12"  // 不足4位，原样保留
 unescape("test%2")     = "test%2"    // 不足2位，原样保留
 unescape("test%20")    = "test "     // 正常解码空格
 unescape("test%u4E2D") = "test中"    // 正常解码中文字符
 
```
    Parameters:
    
    content - 被转义的内容
    
    Returns:
    
    解码后的字符串
  - safeUnescape
```
public static String safeUnescape(String content)
```
    安全的unescape文本，当文本不是被escape的时候，返回原文。
    
    Parameters:
    
    content - 内容
    
    Returns:
    
    解码后的字符串，如果解码失败返回原字符串

Class EscapeUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EscapeUtil

Method Detail

escapeXml

unescapeXml

escapeHtml4

unescapeHtml4

escape

escapeAll

escape

unescape

safeUnescape