在调用第三方请求时,正确使用Client
也不是一件非常容易的事。
下面是截取的一段描述,建议Client
或Transport
在整个服务期间最好是全局单例的,Transport
本身会维护连接的状态,而且线程安全。强烈建议,不要使用系统提供的任何默认值。
The Client's Transport typically has internal state (cached TCP connections), so Clients should be reused instead of created as needed. Clients are safe for concurrent use by multiple goroutines.
Transport
如下是官方的简要描述。Transport
字段在Client
中被声明为接口类型,而实现这个接口的是Transport
类型(略显绕)。在net
包内部也提供了默认的实现变量:DefaultTransport
。
// Transport specifies the mechanism by which individual
// HTTP requests are made.
// If nil, DefaultTransport is used.
Transport RoundTripper
看一下RoundTripper
这个接口,官方描述:
RoundTripper is an interface representing the ability to execute a single HTTP transaction, obtaining the Response for a given Request.
既然是一个接口类型,我们就有理由自己去实现它,我们可以自定义自己的Transport
。比如客户端发起一个请求,我们可以先去查询缓存中是否存在。如果存在,则将缓存中的数据写回response
。如果不存在,请求远端服务获取数据,并缓存。
实现这样的功能,完全没有必要自定义一个Transport
,我们也可以使用先请求缓存服务器,在请求远端服务器的方案来实现。但其实Transport
就可以实现封装这些功能。
func cacheResponse(b []byte, r *http.Request) (*http.Response, error) {
//NewBuffer is intended to prepare a Buffer to read existing data.
buf := bytes.NewBuffer(b)
return http.ReadResponse(bufio.NewReader(buf), r)
}
官方提供了默认的Transport
。如果不明确指定,那么底层就使用默认值。所以,可能连你也没有意识到,你在使用长链接。
另外:一定要记得当请求返回的error
为空时,读取连接返回的数据,并明确调用Close
关闭连接。否则连接会没法继续复用。
func (c *Client) transport() RoundTripper {
if c.Transport != nil {
return c.Transport
}
return DefaultTransport
}
缓存Idle
连接
首先了解缓存长链接的Key
是什么,即用来唯一确定连接的Key
。我们选来看看它如何从缓存池获取的空闲连接:
//1. 获取的方法,截取其中一部分代码
func (t *Transport) getIdleConn(cm connectMethod) (pconn *persistConn, idleSince time.Time) {
key := cm.key()
t.idleMu.Lock()
defer t.idleMu.Unlock()
for {
pconns, ok := t.idleConn[key]
if !ok {
return nil, time.Time{}
}
if len(pconns) == 1 {
pconn = pconns[0]
delete(t.idleConn, key)
} else {
// 2 or more cached connections; use the most
// recently used one at the end.
pconn = pconns[len(pconns)-1]
t.idleConn[key] = pconns[:len(pconns)-1]
}
t.idleLRU.remove(pconn)
//省略之后的代码......
通过如下代码,可以确定net
包通过当前请求的proxy URL
、Scheme
、Addr
来缓存建立的连接。缓存的连接存储在一个MAP
结构中: map[connectMethodKey][]*persistConn
。map
中的每一个Key
对应了连接的slice
数组,最新创建的连接会追加到slice
的末尾。
func (cm *connectMethod) key() connectMethodKey {
proxyStr := ""
targetAddr := cm.targetAddr
if cm.proxyURL != nil {
proxyStr = cm.proxyURL.String()
if (cm.proxyURL.Scheme == "http" || cm.proxyURL.Scheme == "https") && cm.targetScheme == "http" {
targetAddr = ""
}
}
return connectMethodKey{
proxy: proxyStr,
scheme: cm.targetScheme,
addr: targetAddr,
}
}
因为Key
中存在了Host
地址,所以MaxIdleConnsPerHost
这个值就显得格外重要。当准备缓存连接时,如果检测到当前的空闲连接数大于MaxIdleConnsPerHost
,系统便会主动将这个连接关闭。这可能会是一个坑,特别要注意这一点。
如果不指定MaxIdleConnsPerHost
,那么程序使用默认的值:DefaultMaxIdleConnsPerHost
,这个默认值好比DefaultClient
,都是问题所在。前者的默认值是2,可能直接导致在并发的时候,长链接的效率还不如短链接。后者的默认超时时间是0,这可能导致一个连接永远的挂在了那里。
使用net
包提供的默认值,很多时候都不会是一件明智的事情。
func (t *Transport) tryPutIdleConn(pconn *persistConn) error {
//省略之前的代码......
if t.idleConn == nil {
t.idleConn = make(map[connectMethodKey][]*persistConn)
}
idles := t.idleConn[key]
if len(idles) >= t.maxIdleConnsPerHost() {
return errTooManyIdleHost
}
//省略之后的代码......
//主动关闭连接的代码
func (t *Transport) putOrCloseIdleConn(pconn *persistConn) {
if err := t.tryPutIdleConn(pconn); err != nil {
pconn.close(err)
}
}
客户端对每个主机最多可以保持Transport.MaxIdleConnsPerHost
个长链接。对于长链接而言,一般是由服务端主动关闭的,而连接维持的时间也由服务端来决定。如果对于请求的域名,对应的Host
足够多,在服务端关闭这些连接之前,可能会存在大量的空闲连接,造成资源浪费。
参考文章:
有疑问加站长微信联系(非本文作者)