cn.hutool.core.net

Class URLEncodeUtil

java.lang.Object

cn.hutool.core.net.URLEncodeUtil

Direct Known Subclasses:

URLUtil

public class URLEncodeUtil
extends Object

URL编码工具
TODO 在6.x中移除此工具（无法很好区分URL编码和www-form编码）

Since:

5.7.13

Author:

looly

Constructor Summary

Constructors

Constructor and Description
URLEncodeUtil()

Method Summary

Modifier and Type	Method and Description
static String	encode(String url) 编码URL，默认使用UTF-8编码 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encode(String url, Charset charset) 编码字符为 application/x-www-form-urlencoded 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encodeAll(String url) 编码URL，默认使用UTF-8编码 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encodeAll(String url, Charset charset) 编码URL 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encodeFragment(String url) 编码URL，默认使用UTF-8编码 URL的Fragment URLEncoder 默认的编码器针对Fragment，定义如下： fragment = *( pchar / "/" / "?"
static String	encodeFragment(String url, Charset charset) URL的Fragment URLEncoder 默认的编码器针对Fragment，定义如下： fragment = *( pchar / "/" / "?"
static String	encodePathSegment(String url) 编码URL，默认使用UTF-8编码 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encodePathSegment(String url, Charset charset) 编码字符为URL中查询语句 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encodeQuery(String url) 编码URL，默认使用UTF-8编码 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
static String	encodeQuery(String url, Charset charset) 编码字符为URL中查询语句 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。

Methods inherited from class java.lang.Object

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

Constructor Detail

URLEncodeUtil

public URLEncodeUtil()

Method Detail

encodeAll

public static String encodeAll(String url)

编码URL，默认使用UTF-8编码
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。

Parameters:

url - URL

Returns:

编码后的URL

Throws:

UtilException - UnsupportedEncodingException

encodeAll

public static String encodeAll(String url,
                               Charset charset)
                        throws UtilException

编码URL
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。

Parameters:

url - URL

charset - 编码，为null表示不编码

Returns:

编码后的URL

Throws:

UtilException - UnsupportedEncodingException

encode

public static String encode(String url)
                     throws UtilException

编码URL，默认使用UTF-8编码
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
此方法用于URL自动编码，类似于浏览器中键入地址自动编码，对于像类似于“/”的字符不再编码

Parameters:

url - URL

Returns:

编码后的URL

Throws:

UtilException - UnsupportedEncodingException

Since:

3.1.2

encode

public static String encode(String url,
                            Charset charset)

编码字符为 application/x-www-form-urlencoded
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
此方法用于URL自动编码，类似于浏览器中键入地址自动编码，对于像类似于“/”的字符不再编码

Parameters:

url - 被编码内容

charset - 编码

Returns:

编码后的字符

Since:

4.4.1

encodeQuery

public static String encodeQuery(String url)
                          throws UtilException

编码URL，默认使用UTF-8编码
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
此方法用于POST请求中的请求体自动编码，转义大部分特殊字符

Parameters:

url - URL

Returns:

编码后的URL

Throws:

UtilException - UnsupportedEncodingException

Since:

3.1.2

encodeQuery

public static String encodeQuery(String url,
                                 Charset charset)

编码字符为URL中查询语句
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
此方法用于POST请求中的请求体自动编码，转义大部分特殊字符

Parameters:

url - 被编码内容

charset - 编码

Returns:

编码后的字符

Since:

4.4.1

encodePathSegment

public static String encodePathSegment(String url)
                                throws UtilException

编码URL，默认使用UTF-8编码
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
此方法用于URL的Segment中自动编码，转义大部分特殊字符

 pchar = unreserved（不处理） / pct-encoded / sub-delims（子分隔符） / "@"
 unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
 sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
 

Parameters:

url - URL

Returns:

编码后的URL

Throws:

UtilException - UnsupportedEncodingException

Since:

5.6.5

encodePathSegment

public static String encodePathSegment(String url,
                                       Charset charset)

编码字符为URL中查询语句
将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
此方法用于URL的Segment中自动编码，转义大部分特殊字符

 pchar = unreserved / pct-encoded / sub-delims / ":" / "@"
 unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
 sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
 

Parameters:

url - 被编码内容

charset - 编码

Returns:

编码后的字符

Since:

5.6.5

encodeFragment

public static String encodeFragment(String url)
                             throws UtilException

编码URL，默认使用UTF-8编码
URL的Fragment URLEncoder
默认的编码器针对Fragment，定义如下：

 fragment    = *( pchar / "/" / "?" )
 pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
 unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
 sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
 

具体见：https://datatracker.ietf.org/doc/html/rfc3986#section-3.5

Parameters:

url - 被编码内容

Returns:

编码后的字符

Throws:

UtilException

Since:

5.7.13

encodeFragment

public static String encodeFragment(String url,
                                    Charset charset)

URL的Fragment URLEncoder
默认的编码器针对Fragment，定义如下：

 fragment    = *( pchar / "/" / "?" )
 pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
 unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
 sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
 

具体见：https://datatracker.ietf.org/doc/html/rfc3986#section-3.5

Parameters:

url - 被编码内容

charset - 编码

Returns:

编码后的字符

Since:

5.7.13