cn.hutool.core.codec

Class PercentCodec

java.lang.Object

cn.hutool.core.codec.PercentCodec

All Implemented Interfaces:

Serializable

public class PercentCodec
extends Object
implements Serializable

百分号编码(Percent-encoding), 也称作URL编码(URL encoding)。
百分号编码可用于URI的编码，也可以用于"application/x-www-form-urlencoded"的MIME准备数据。

百分号编码会对 URI 中不允许出现的字符或者其他特殊情况的允许的字符进行编码，对于被编码的字符，最终会转为以百分号"%“开头，后面跟着两位16进制数值的形式。 举个例子，空格符（SP）是不允许的字符，在 ASCII 码对应的二进制值是"00100000”，最终转为"%20"。

对于不同场景应遵循不同规范：

• URI：遵循RFC 3986保留字规范
• application/x-www-form-urlencoded，遵循W3C HTML Form content types规范，如空格须转+

Since:

5.7.16

Author:

looly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PercentCodec() 构造 [a-zA-Z0-9]默认不被编码
PercentCodec(BitSet safeCharacters) 构造

Method Summary

Modifier and Type	Method and Description
PercentCodec	addSafe(char c) 增加安全字符 安全字符不被编码
String	encode(CharSequence path, Charset charset, char... customSafeChar) 将URL中的字符串编码为%形式
static PercentCodec	of(CharSequence chars) 创建PercentCodec，使用指定字符串中的字符作为安全字符
static PercentCodec	of(PercentCodec codec) 从已知PercentCodec创建PercentCodec，会复制给定PercentCodec的安全字符
PercentCodec	or(PercentCodec codec) 增加安全字符到挡墙的PercentCodec
PercentCodec	orNew(PercentCodec codec) 组合当前PercentCodec和指定PercentCodec为一个新的PercentCodec，安全字符为并集
PercentCodec	removeSafe(char c) 移除安全字符 安全字符不被编码
PercentCodec	setEncodeSpaceAsPlus(boolean encodeSpaceAsPlus) 是否将空格编码为+ 如果为true，则将空格编码为"+"，此项只在"application/x-www-form-urlencoded"中使用 如果为false，则空格编码为"%20",此项一般用于URL的Query部分（RFC3986规范）

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PercentCodec

public PercentCodec()

构造
[a-zA-Z0-9]默认不被编码

PercentCodec

public PercentCodec(BitSet safeCharacters)

构造

Parameters:

safeCharacters - 安全字符，安全字符不被编码

Method Detail

of

public static PercentCodec of(PercentCodec codec)

从已知PercentCodec创建PercentCodec，会复制给定PercentCodec的安全字符

Parameters:

codec - PercentCodec

Returns:

PercentCodec

of

public static PercentCodec of(CharSequence chars)

创建PercentCodec，使用指定字符串中的字符作为安全字符

Parameters:

chars - 安全字符合集

Returns:

PercentCodec

addSafe

public PercentCodec addSafe(char c)

增加安全字符
安全字符不被编码

Parameters:

c - 字符

Returns:

this

removeSafe

public PercentCodec removeSafe(char c)

移除安全字符
安全字符不被编码

Parameters:

c - 字符

Returns:

this

or

public PercentCodec or(PercentCodec codec)

增加安全字符到挡墙的PercentCodec

Parameters:

codec - PercentCodec

Returns:

this

orNew

public PercentCodec orNew(PercentCodec codec)

组合当前PercentCodec和指定PercentCodec为一个新的PercentCodec，安全字符为并集

Parameters:

codec - PercentCodec

Returns:

新的PercentCodec

setEncodeSpaceAsPlus

public PercentCodec setEncodeSpaceAsPlus(boolean encodeSpaceAsPlus)

是否将空格编码为+
如果为true，则将空格编码为"+"，此项只在"application/x-www-form-urlencoded"中使用
如果为false，则空格编码为"%20",此项一般用于URL的Query部分（RFC3986规范）

Parameters:

encodeSpaceAsPlus - 是否将空格编码为+

Returns:

this

encode

public String encode(CharSequence path,
                     Charset charset,
                     char... customSafeChar)

将URL中的字符串编码为%形式

Parameters:

path - 需要编码的字符串

charset - 编码, null返回原字符串，表示不编码

customSafeChar - 自定义安全字符

Returns:

编码后的字符串