UnoUrl (bus-all 5.8.2 API)

java.lang.Object
- org.aoju.bus.http.UnoUrl

```
public final class UnoUrl
extends Object
```
统一资源定位器(URL)，其模式为http或https。使用这个类来组合和分解Internet地址这个类有一个现代的API。它避免了惩罚性的检查异常:get()对无效的输入抛出IllegalArgumentException，或者parse()如果输入是无效的URL，则返回null。您甚至可以明确每个组件是否已经编码

Since:

JDK 1.8+

Version:

5.8.2

Author:

Kimi Liu

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UnoUrl.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`UnoUrl.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FORM_ENCODE_SET`
`static String`	`FRAGMENT_ENCODE_SET`
`static String`	`FRAGMENT_ENCODE_SET_URI`
`static String`	`PASSWORD_ENCODE_SET`
`static String`	`PATH_SEGMENT_ENCODE_SET`
`static String`	`PATH_SEGMENT_ENCODE_SET_URI`
`static String`	`QUERY_COMPONENT_ENCODE_SET`
`static String`	`QUERY_COMPONENT_ENCODE_SET_URI`
`static String`	`QUERY_COMPONENT_REENCODE_SET`
`static String`	`QUERY_ENCODE_SET`
`static String`	`USERNAME_ENCODE_SET`

Method Summary

Modifier and Type Method and Description

static String canonicalize(String input, String encodeSet, boolean alreadyEncoded, boolean strict, boolean plusIsSpace, boolean asciiOnly, Charset charset)

static int defaultPort(String scheme)

String

encodedFragment()

返回这个URL的片段 "abc" for http://host/#abc.

String

encodedPassword()

返回密码，如果没有设置则返回空字符串.

String

encodedPath()

该URL编码后用于HTTP资源解析。返回的路径将以/开始 URLencodedPath()http://host//http://host/a/b/c"/a/b/c"http://host/a/b%20c/d"/a/b%20c/d"

List<String>

encodedPathSegments()

返回一个已编码的路径段列表 ["a", "b", "c"] for the URL http://host/a/b/c.

String

encodedQuery()

Returns the query of this URL, encoded for use in HTTP resource resolution.

String encodedUsername()

boolean equals(Object other)

String

fragment()

返回这个URL的片段 "abc" for http://host/#abc.

static UnoUrl get(String url)

static UnoUrl get(URI uri)

static UnoUrl get(URL url)

int hashCode()

String

host()

A regular host name, like android.com.

boolean isHttps()

UnoUrl.Builder newBuilder()

UnoUrl.Builder newBuilder(String link)

static UnoUrl parse(String url)

String

password()

返回已解码的密码，如果不存在，则返回空字符串.

List<String>

pathSegments()

Returns a list of path segments like ["a", "b", "c"] for the URL http://host/a/b/c.

int

pathSize()

Returns the number of segments in this URL's path.

static String percentDecode(String encoded, boolean plusIsSpace)

int

port()

URLport()http://host/80http://host:8000/8000https://host/443

String

query()

Returns this URL's query, like "abc" for http://host/?abc.

String

queryParameter(String name)

Returns the first query parameter named name decoded using UTF-8, or null if there is no such query parameter.

String

queryParameterName(int index)

Returns the name of the query parameter at index.

Set<String>

queryParameterNames()

Returns the distinct query parameter names in this URL, like ["a", "b"] for http://host/?a=apple&b=banana.

String

queryParameterValue(int index)

Returns the value of the query parameter at index.

List<String>

queryParameterValues(String name)

Returns all values for the query parameter name ordered by their appearance in this URL.

int

querySize()

Returns the number of query parameters in this URL, like 2 for http://host/?a=apple&b=banana.

String redact()

UnoUrl resolve(String link)

String scheme()

String

topPrivateDomain()

通常，这个方法不应该用来测试一个域是否有效或可路由。相反，DNS是推荐的信息来源 URLtopPrivateDomain()http://google.com"google.com"http://adwords.google.co.uk"google.co.uk"http://co.uknull http://localhostnull http://127.0.0.1null

`String`	`toString()`
`URI`	`uri()`
`URL`	`url()`
`String`	`username()` 返回已解码的用户名，如果不存在，则返回空字符串.

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

Field Detail
- USERNAME_ENCODE_SET
```
public static final String USERNAME_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- PASSWORD_ENCODE_SET
```
public static final String PASSWORD_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- PATH_SEGMENT_ENCODE_SET
```
public static final String PATH_SEGMENT_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- PATH_SEGMENT_ENCODE_SET_URI
```
public static final String PATH_SEGMENT_ENCODE_SET_URI
```
  See Also:
  
  Constant Field Values
- QUERY_ENCODE_SET
```
public static final String QUERY_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- QUERY_COMPONENT_REENCODE_SET
```
public static final String QUERY_COMPONENT_REENCODE_SET
```
  See Also:
  
  Constant Field Values
- QUERY_COMPONENT_ENCODE_SET
```
public static final String QUERY_COMPONENT_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- QUERY_COMPONENT_ENCODE_SET_URI
```
public static final String QUERY_COMPONENT_ENCODE_SET_URI
```
  See Also:
  
  Constant Field Values
- FORM_ENCODE_SET
```
public static final String FORM_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- FRAGMENT_ENCODE_SET
```
public static final String FRAGMENT_ENCODE_SET
```
  See Also:
  
  Constant Field Values
- FRAGMENT_ENCODE_SET_URI
```
public static final String FRAGMENT_ENCODE_SET_URI
```
  See Also:
  
  Constant Field Values

Method Detail

defaultPort

public static int defaultPort(String scheme)

parse

public static UnoUrl parse(String url)

get
```
public static UnoUrl get(String url)
```

get
```
public static UnoUrl get(URL url)
```

get
```
public static UnoUrl get(URI uri)
```

percentDecode

public static String percentDecode(String encoded,
                                   boolean plusIsSpace)

canonicalize

public static String canonicalize(String input,
                                  String encodeSet,
                                  boolean alreadyEncoded,
                                  boolean strict,
                                  boolean plusIsSpace,
                                  boolean asciiOnly,
                                  Charset charset)

url
```
public URL url()
```

uri
```
public URI uri()
```

scheme
```
public String scheme()
```

isHttps
```
public boolean isHttps()
```

encodedUsername
```
public String encodedUsername()
```

username
```
public String username()
```
返回已解码的用户名，如果不存在，则返回空字符串.

URL username()

http://host/ ""

http://username@host/ "username"

http://username:password@host/ "username"

http://a%20b:c%20d@host/ "a b"

Returns:

用户信息

encodedPassword
```
public String encodedPassword()
```
返回密码，如果没有设置则返回空字符串.

URL encodedPassword()

http://host/ ""

http://username@host/ ""

http://username:password@host/ "password"

http://a%20b:c%20d@host/ "c%20d"

Returns:

返回密码

password
```
public String password()
```
返回已解码的密码，如果不存在，则返回空字符串.

URL password()

http://host/ ""

http://username@host/ ""

http://username:password@host/ "password"

http://a%20b:c%20d@host/ "c d"

Returns:

返回已解码的密码

host
```
public String host()
```
- A regular host name, like android.com.
- An IPv4 address, like 127.0.0.1.
- An IPv6 address, like ::1.
- An encoded IDN, like xn--n3h.net.
URL host()

http://android.com/ "android.com"

http://127.0.0.1/ "127.0.0.1"

http://[::1]/ "::1"

http://xn--n3h.net/ "xn--n3h.net"
Returns:

主机host

port
```
public int port()
```
URL port()

http://host/ 80

http://host:8000/ 8000

https://host/ 443

Returns:

端口

pathSize
```
public int pathSize()
```
Returns the number of segments in this URL's path. This is also the number of slashes in the URL's path, like 3 in http://host/a/b/c. This is always at least 1.

URL pathSize()

http://host/ 1

http://host/a/b/c 3

http://host/a/b/c/ 4

Returns:

the size

encodedPath
```
public String encodedPath()
```
该URL编码后用于HTTP资源解析。返回的路径将以/开始

URL encodedPath()

http://host/ /

http://host/a/b/c "/a/b/c"

http://host/a/b%20c/d "/a/b%20c/d"

Returns:

URL的完整路径

encodedPathSegments
```
public List<String> encodedPathSegments()
```
返回一个已编码的路径段列表 ["a", "b", "c"] for the URL http://host/a/b/c. 这个列表从不为空，尽管它可能包含一个空字符串.

URL encodedPathSegments()

http://host/ [""]

http://host/a/b/c ["a", "b", "c"]

http://host/a/b%20c/d ["a", "b%20c", "d"]

Returns:

路径段列表

pathSegments
```
public List<String> pathSegments()
```
Returns a list of path segments like ["a", "b", "c"] for the URL http://host/a/b/c. This list is never empty though it may contain a single empty string.

URL pathSegments()

http://host/ [""]

http://host/a/b/c" ["a", "b", "c"]

http://host/a/b%20c/d" ["a", "b c", "d"]

Returns:

the string

encodedQuery
```
public String encodedQuery()
```
Returns the query of this URL, encoded for use in HTTP resource resolution. The returned string may be null (for URLs with no query), empty (for URLs with an empty query) or non-empty (all other URLs).

URL encodedQuery()

http://host/ null

http://host/? ""

http://host/?a=apple&k=key+lime "a=apple&k=key+lime"

http://host/?a=apple&a=apricot "a=apple&a=apricot"

http://host/?a=apple&b "a=apple&b"

Returns:

the string

query
```
public String query()
```
Returns this URL's query, like "abc" for http://host/?abc. Most callers should prefer queryParameterName(int) and queryParameterValue(int) because these methods offer direct access to individual query parameters.

URL query()

http://host/ null

http://host/? ""

http://host/?a=apple&k=key+lime "a=apple&k=key lime"

http://host/?a=apple&a=apricot "a=apple&a=apricot"

http://host/?a=apple&b "a=apple&b"

Returns:

the string

querySize
```
public int querySize()
```
Returns the number of query parameters in this URL, like 2 for http://host/?a=apple&b=banana. If this URL has no query this returns 0. Otherwise it returns one more than the number of "&" separators in the query.

URL querySize()

http://host/ 0

http://host/? 1

http://host/?a=apple&k=key+lime 2

http://host/?a=apple&a=apricot 2

http://host/?a=apple&b 2

Returns:

the int

queryParameter
```
public String queryParameter(String name)
```
Returns the first query parameter named name decoded using UTF-8, or null if there is no such query parameter.

URL queryParameter("a")

http://host/ null

http://host/? null

http://host/?a=apple&k=key+lime "apple"

http://host/?a=apple&a=apricot "apple"

http://host/?a=apple&b "apple"

Parameters:

name - 名称

Returns:

the string

queryParameterNames
```
public Set<String> queryParameterNames()
```
Returns the distinct query parameter names in this URL, like ["a", "b"] for http://host/?a=apple&b=banana. If this URL has no query this returns the empty set.

URL queryParameterNames()

http://host/ []

http://host/? [""]

http://host/?a=apple&k=key+lime ["a", "k"]

http://host/?a=apple&a=apricot ["a"]

http://host/?a=apple&b ["a", "b"]

Returns:

the set

queryParameterValues

public List<String> queryParameterValues(String name)

Returns all values for the query parameter name ordered by their appearance in this URL. For example this returns ["banana"] for queryParameterValue("b") on http://host/?a=apple&b=banana.

URL	`queryParameterValues("a")`	`queryParameterValues("b")`
`http://host/`	`[]`	`[]`
`http://host/?`	`[]`	`[]`
`http://host/?a=apple&k=key+lime`	`["apple"]`	`[]`
`http://host/?a=apple&a=apricot`	`["apple", "apricot"]`	`[]`
`http://host/?a=apple&b`	`["apple"]`	`[null]`

Parameters:: name - 名称
Returns:: the list

queryParameterName

public String queryParameterName(int index)

Returns the name of the query parameter at index. For example this returns "a" for queryParameterName(0) on http://host/?a=apple&b=banana. This throws if index is not less than the query size.

URL	`queryParameterName(0)`	`queryParameterName(1)`
`http://host/`	exception	exception
`http://host/?`	`""`	exception
`http://host/?a=apple&k=key+lime`	`"a"`	`"k"`
`http://host/?a=apple&a=apricot`	`"a"`	`"a"`
`http://host/?a=apple&b`	`"a"`	`"b"`

Parameters:: index - 索引
Returns:: the string

queryParameterValue

public String queryParameterValue(int index)

Returns the value of the query parameter at index. For example this returns "apple" for queryParameterName(0) on http://host/?a=apple&b=banana. This throws if index is not less than the query size.

URL	`queryParameterValue(0)`	`queryParameterValue(1)`
`http://host/`	exception	exception
`http://host/?`	null	exception
`http://host/?a=apple&k=key+lime`	`"apple"`	`"key lime"`
`http://host/?a=apple&a=apricot`	`"apple"`	`"apricot"`
`http://host/?a=apple&b`	`"apple"`	null

Parameters:: index - 索引
Returns:: the string

encodedFragment
```
public String encodedFragment()
```
返回这个URL的片段 "abc" for http://host/#abc. 如果URL没有片段，则返回null

URL encodedFragment()

http://host/ null

http://host/# ""

http://host/#abc "abc"

http://host/#abc|def "abc|def"

Returns:

the string

fragment
```
public String fragment()
```
返回这个URL的片段 "abc" for http://host/#abc. 如果URL没有片段，则返回null

URL fragment()

http://host/ null

http://host/# ""

http://host/#abc "abc"

http://host/#abc|def "abc|def"

Returns:

the string

redact
```
public String redact()
```

resolve
```
public UnoUrl resolve(String link)
```

newBuilder
```
public UnoUrl.Builder newBuilder()
```

newBuilder

public UnoUrl.Builder newBuilder(String link)

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

topPrivateDomain
```
public String topPrivateDomain()
```
通常，这个方法不应该用来测试一个域是否有效或可路由。相反，DNS是推荐的信息来源

URL topPrivateDomain()

http://google.com "google.com"

http://adwords.google.co.uk "google.co.uk"

http://co.uk null

http://localhost null

http://127.0.0.1 null

Returns:

the string

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class UnoUrl

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USERNAME_ENCODE_SET

PASSWORD_ENCODE_SET

PATH_SEGMENT_ENCODE_SET

PATH_SEGMENT_ENCODE_SET_URI

QUERY_ENCODE_SET

QUERY_COMPONENT_REENCODE_SET

QUERY_COMPONENT_ENCODE_SET

QUERY_COMPONENT_ENCODE_SET_URI

FORM_ENCODE_SET

FRAGMENT_ENCODE_SET

FRAGMENT_ENCODE_SET_URI

Method Detail

defaultPort

parse

get

get

get

percentDecode

canonicalize

url

uri

scheme

isHttps

encodedUsername

username

encodedPassword

password

host

port

pathSize

encodedPath

encodedPathSegments

pathSegments

encodedQuery

query

querySize

queryParameter

queryParameterNames

queryParameterValues

queryParameterName

queryParameterValue

encodedFragment

fragment

redact

resolve

newBuilder

newBuilder

equals

hashCode

toString

topPrivateDomain