package url · Go 标准库中文参考

# package url `import "net/url"` url包解析URL并实现了查询的逸码，参见[RFC 3986](http://tools.ietf.org/html/rfc3986)。 ## Index * [func QueryEscape(s string) string](#QueryEscape) * [func QueryUnescape(s string) (string, error)](#QueryUnescape) * [type Error](#Error) * [func (e \*Error) Error() string](#Error.Error) * [type EscapeError](#EscapeError) * [func (e EscapeError) Error() string](#EscapeError.Error) * [type URL](#URL) * [func Parse(rawurl string) (url \*URL, err error)](#Parse) * [func ParseRequestURI(rawurl string) (url \*URL, err error)](#ParseRequestURI) * [func (u \*URL) IsAbs() bool](#URL.IsAbs) * [func (u \*URL) Query() Values](#URL.Query) * [func (u \*URL) RequestURI() string](#URL.RequestURI) * [func (u \*URL) String() string](#URL.String) * [func (u \*URL) Parse(ref string) (\*URL, error)](#URL.Parse) * [func (u \*URL) ResolveReference(ref \*URL) \*URL](#URL.ResolveReference) * [type Userinfo](#Userinfo) * [func User(username string) \*Userinfo](#User) * [func UserPassword(username, password string) \*Userinfo](#UserPassword) * [func (u \*Userinfo) Username() string](#Userinfo.Username) * [func (u \*Userinfo) Password() (string, bool)](#Userinfo.Password) * [func (u \*Userinfo) String() string](#Userinfo.String) * [type Values](#Values) * [func ParseQuery(query string) (m Values, err error)](#ParseQuery) * [func (v Values) Get(key string) string](#Values.Get) * [func (v Values) Set(key, value string)](#Values.Set) * [func (v Values) Add(key, value string)](#Values.Add) * [func (v Values) Del(key string)](#Values.Del) * [func (v Values) Encode() string](#Values.Encode) ### Examples * [URL](#example-URL) * [Values](#example-Values) ## func [QueryEscape](https://github.com/golang/go/blob/master/src/net/url/url.go#L173 "View Source") ``` func QueryEscape(s string) string ``` QueryEscape函数对s进行转码使之可以安全的用在URL查询里。 ## func [QueryUnescape](https://github.com/golang/go/blob/master/src/net/url/url.go#L112 "View Source") ``` func QueryUnescape(s string) (string, error) ``` QueryUnescape函数用于将QueryEscape转码的字符串还原。它会把%AB改为字节0xAB，将'+'改为' '。如果有某个%后面未跟两个十六进制数字，本函数会返回错误。 ## type [Error](https://github.com/golang/go/blob/master/src/net/url/url.go#L18 "View Source") ``` type Error struct { Op string URL string Err error } ``` Error会报告一个错误，以及导致该错误发生的URL和操作。 ### func (\*Error) [Error](https://github.com/golang/go/blob/master/src/net/url/url.go#L24 "View Source") ``` func (e *Error) Error() string ``` ## type [EscapeError](https://github.com/golang/go/blob/master/src/net/url/url.go#L59 "View Source") ``` type EscapeError string ``` ### func (EscapeError) [Error](https://github.com/golang/go/blob/master/src/net/url/url.go#L61 "View Source") ``` func (e EscapeError) Error() string ``` ## type [URL](https://github.com/golang/go/blob/master/src/net/url/url.go#L230 "View Source") ``` type URL struct { Scheme string Opaque string // 编码后的不透明数据 User *Userinfo // 用户名和密码信息 Host string // host或host:port Path string RawQuery string // 编码后的查询字符串，没有'?' Fragment string // 引用的片段（文档位置），没有'#' } ``` URL类型代表一个解析后的URL（或者说，一个URL参照）。URL基本格式如下： ``` scheme://[userinfo@]host/path[?query][#fragment] ``` scheme后不是冒号加双斜线的URL被解释为如下格式： ``` scheme:opaque[?query][#fragment] ``` 注意路径字段是以解码后的格式保存的，如/%47%6f%2f会变成/Go/。这导致我们无法确定Path字段中的斜线是来自原始URL还是解码前的%2f。除非一个客户端必须使用其他程序/函数来解析原始URL或者重构原始URL，这个区别并不重要。此时，HTTP服务端可以查询req.RequestURI，而HTTP客户端可以使用URL{Host: "example.com", Opaque: "//example.com/Go%2f"}代替{Host: "example.com", Path: "/Go/"}。 Example ``` u, err := url.Parse("http://bing.com/search?q=dotnet") if err != nil { log.Fatal(err) } u.Scheme = "https" u.Host = "google.com" q := u.Query() q.Set("q", "golang") u.RawQuery = q.Encode() fmt.Println(u) ``` Output: ``` https://google.com/search?q=golang ``` ### func [Parse](https://github.com/golang/go/blob/master/src/net/url/url.go#L333 "View Source") ``` func Parse(rawurl string) (url *URL, err error) ``` Parse函数解析rawurl为一个URL结构体，rawurl可以是绝对地址，也可以是相对地址。 ### func [ParseRequestURI](https://github.com/golang/go/blob/master/src/net/url/url.go#L353 "View Source") ``` func ParseRequestURI(rawurl string) (url *URL, err error) ``` ParseRequestURI函数解析rawurl为一个URL结构体，本函数会假设rawurl是在一个HTTP请求里，因此会假设该参数是一个绝对URL或者绝对路径，并会假设该URL没有#fragment后缀。（网页浏览器会在去掉该后缀后才将网址发送到网页服务器） ### func (\*URL) [IsAbs](https://github.com/golang/go/blob/master/src/net/url/url.go#L624 "View Source") ``` func (u *URL) IsAbs() bool ``` 函数在URL是绝对URL时才返回真。 ### func (\*URL) [Query](https://github.com/golang/go/blob/master/src/net/url/url.go#L677 "View Source") ``` func (u *URL) Query() Values ``` Query方法解析RawQuery字段并返回其表示的Values类型键值对。 ### func (\*URL) [RequestURI](https://github.com/golang/go/blob/master/src/net/url/url.go#L684 "View Source") ``` func (u *URL) RequestURI() string ``` RequestURI方法返回编码好的path?query或opaque?query字符串，用在HTTP请求里。 ### func (\*URL) [String](https://github.com/golang/go/blob/master/src/net/url/url.go#L443 "View Source") ``` func (u *URL) String() string ``` String将URL重构为一个合法URL字符串。 ### func (\*URL) [Parse](https://github.com/golang/go/blob/master/src/net/url/url.go#L631 "View Source") ``` func (u *URL) Parse(ref string) (*URL, error) ``` Parse方法以u为上下文来解析一个URL，ref可以是绝对或相对URL。本方法解析失败会返回nil, err；否则返回结果和ResolveReference一致。 ### func (\*URL) [ResolveReference](https://github.com/golang/go/blob/master/src/net/url/url.go#L645 "View Source") ``` func (u *URL) ResolveReference(ref *URL) *URL ``` 本方法根据一个绝对URI将一个URI补全为一个绝对URI，参见[RFC 3986](http://tools.ietf.org/html/rfc3986) 节 5.2。参数ref可以是绝对URI或者相对URI。ResolveReference总是返回一个新的URL实例，即使该实例和u或者ref完全一样。如果ref是绝对URI，本方法会忽略参照URI并返回ref的一个拷贝。 ## type [Userinfo](https://github.com/golang/go/blob/master/src/net/url/url.go#L261 "View Source") ``` type Userinfo struct { // 内含隐藏或非导出字段 } ``` Userinfo类型是一个URL的用户名和密码细节的一个不可修改的封装。一个真实存在的Userinfo值必须保证有用户名（但根据 [RFC 2396](http://tools.ietf.org/html/rfc2396)可以是空字符串）以及一个可选的密码。 ### func [User](https://github.com/golang/go/blob/master/src/net/url/url.go#L242 "View Source") ``` func User(username string) *Userinfo ``` User函数返回一个用户名设置为username的不设置密码的\*Userinfo。 ### func [UserPassword](https://github.com/golang/go/blob/master/src/net/url/url.go#L253 "View Source") ``` func UserPassword(username, password string) *Userinfo ``` UserPassword函数返回一个用户名设置为username、密码设置为password的\*Userinfo。这个函数应该只用于老式的站点，因为风险很大，不建议使用，参见[RFC 2396](http://tools.ietf.org/html/rfc2396)。 ### func (\*Userinfo) [Username](https://github.com/golang/go/blob/master/src/net/url/url.go#L268 "View Source") ``` func (u *Userinfo) Username() string ``` Username方法返回用户名。 ### func (\*Userinfo) [Password](https://github.com/golang/go/blob/master/src/net/url/url.go#L273 "View Source") ``` func (u *Userinfo) Password() (string, bool) ``` 如果设置了密码返回密码和真，否则会返回假。 ### func (\*Userinfo) [String](https://github.com/golang/go/blob/master/src/net/url/url.go#L282 "View Source") ``` func (u *Userinfo) String() string ``` String方法返回编码后的用户信息，格式为"username[:password]"。 ## type [Values](https://github.com/golang/go/blob/master/src/net/url/url.go#L482 "View Source") ``` type Values map[string][]string ``` Values将建映射到值的列表。它一般用于查询的参数和表单的属性。不同于http.Header这个字典类型，Values的键是大小写敏感的。 Example ``` v := url.Values{} v.Set("name", "Ava") v.Add("friend", "Jess") v.Add("friend", "Sarah") v.Add("friend", "Zoe") // v.Encode() == "name=Ava&friend=Jess&friend=Sarah&friend=Zoe" fmt.Println(v.Get("name")) fmt.Println(v.Get("friend")) fmt.Println(v["friend"]) ``` Output: ``` Ava Jess [Jess Sarah Zoe] ``` ### func [ParseQuery](https://github.com/golang/go/blob/master/src/net/url/url.go#L521 "View Source") ``` func ParseQuery(query string) (m Values, err error) ``` ParseQuery函数解析一个URL编码的查询字符串，并返回可以表示该查询的Values类型的字典。本函数总是返回一个包含了所有合法查询参数的非nil字典，err用来描述解码时遇到的（如果有）第一个错误。 ### func (Values) [Get](https://github.com/golang/go/blob/master/src/net/url/url.go#L488 "View Source") ``` func (v Values) Get(key string) string ``` Get会获取key对应的值集的第一个值。如果没有对应key的值集会返回空字符串。获取值集请直接用map。 ### func (Values) [Set](https://github.com/golang/go/blob/master/src/net/url/url.go#L501 "View Source") ``` func (v Values) Set(key, value string) ``` Set方法将key对应的值集设为只有value，它会替换掉已有的值集。 ### func (Values) [Add](https://github.com/golang/go/blob/master/src/net/url/url.go#L507 "View Source") ``` func (v Values) Add(key, value string) ``` Add将value添加到key关联的值集里原有的值的后面。 ### func (Values) [Del](https://github.com/golang/go/blob/master/src/net/url/url.go#L512 "View Source") ``` func (v Values) Del(key string) ``` Del删除key关联的值集。 ### func (Values) [Encode](https://github.com/golang/go/blob/master/src/net/url/url.go#L563 "View Source") ``` func (v Values) Encode() string ``` Encode方法将v编码为url编码格式("bar=baz&foo=quux")，编码时会以键进行排序。