Golangのhttp clientのmiddlewearの実装パターン

以前にためしたGolangのmiddlewear実装パターンを学ぶの続きで、
HttpClientでも同じパターンを適用したときのメモ。

とてもシンプルなclientの利用事例は以下のようになる。

1
2
3
4
5
6
7
8
9
10
package main

import (
"net/http"
)

func main() {
client := &http.Client{}
resp, err := client.Get("https://example.com")
}

ますは前回と同じくcallstackを見てみる。

http client callstack

1
2
3
4
5
// net/http/client.go
type Client struct {
...
Transport RoundTripper
...

Client構造体のコードコメントを見ると以下のようにあり

1
2
3
Transport specifies the mechanism by which individual
HTTP requests are made.
If nil, DefaultTransport is used.

どのメカニズムでtransportするのかはTransportの実装できまる。
nilの場合はデフォルトでHTTPが使われる。つまりhttp以外で会話するclientを作成する際も
このtransportをサポートしていれば良いってこと。
実際はhttp clientのtransportがRoundTripperなので、別のプロトコルの場合はこのRoundTripperを実装することになるのかな。

話は少しそれるがTransport構造体もざっとみてみると

  • Transportは将来の再利用のために接続をキャッシュする
    • CloseIdleConnectionsで管理する
    • MaxConnsPerHostで設定可能
  • Transportはgorutineで再利用可能(スレッドセーフ)
  • HTTP URLがHTTP1.1または2を使う
    • HTTP2をサポートしてる
  • ネットワークエラーのときのみ再接続
  • Proxyで特定のURLに対してhttp(s), socketでのproxyができる
  • そのほかTCP dialやkeep-aliveもここで扱かわれる
1
2
3
type RoundTripper interface {
RoundTrip(*Request) (*Response, error)
}

RoundTripperのiterfaceからRoundTrip関数を持ち、実際にこのRoundTripでサーバーとの会話を行う。

続いて実際にRequestを行っている処理を見てみる。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
func (c *Client) Get(url string) (resp *Response, err error) {
req, err := NewRequest("GET", url, nil)
if err != nil {
return nil, err
}
return c.Do(req)
}

...

func (c *Client) Do(req *Request) (*Response, error) {
return c.do(req)
}

...

func (c *Client) do(req *Request) (retres *Response, reterr error) {
...

for {
...

reqs = append(reqs, req)
var err error
var didTimeout func() bool
if resp, didTimeout, err = c.send(req, deadline); err != nil {
// c.send() always closes req.Body
reqBodyClosed = true
if !deadline.IsZero() && didTimeout() {
err = &httpError{
// TODO: early in cycle: s/Client.Timeout exceeded/timeout or context cancelation/
err: err.Error() + " (Client.Timeout exceeded while awaiting headers)",
timeout: true,
}
}
return nil, uerr(err)
}

...
}
}

func (c *Client) send(req *Request, deadline time.Time) (resp *Response, didTimeout func() bool, err error) {
if c.Jar != nil {
for _, cookie := range c.Jar.Cookies(req.URL) {
req.AddCookie(cookie)
}
}
resp, didTimeout, err = send(req, c.transport(), deadline)
if err != nil {
return nil, didTimeout, err
}
if c.Jar != nil {
if rc := resp.Cookies(); len(rc) > 0 {
c.Jar.SetCookies(req.URL, rc)
}
}
return resp, nil, nil
}


// send issues an HTTP request.
// Caller should close resp.Body when done reading from it.
func send(ireq *Request, rt RoundTripper, deadline time.Time) (resp *Response, didTimeout func() bool, err error) {
req := ireq // req is either the original request, or a modified fork

...

resp, err = rt.RoundTrip(req)

...

return resp, nil, nil
}

ということで、最終的にRoundTripperRoundTripをcallすることになる。

これからclientのmiddlewearはRoundTripを実装するRoundTripperであれば良い。

ちなみにTransportのRoundtripの実装を見ると

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// roundTrip implements a RoundTripper over HTTP.
func (t *Transport) roundTrip(req *Request) (*Response, error) {
...
// Get the cached or newly-created connection to either the
// host (for http or https), the http proxy, or the http proxy
// pre-CONNECTed to https server. In any case, we'll be ready
// to send it requests.
pconn, err := t.getConn(treq, cm)
if err != nil {
t.setReqCanceler(req, nil)
req.closeBody()
return nil, err
}

var resp *Response
if pconn.alt != nil {
// HTTP/2 path.
t.decHostConnCount(cm.key()) // don't count cached http2 conns toward conns per host
t.setReqCanceler(req, nil) // not cancelable with CancelRequest
resp, err = pconn.alt.RoundTrip(req)
} else {
resp, err = pconn.roundTrip(treq)
}
...
}

optionのroundTripperであるpconn.altがある場合はhttp2などが利用される。
またgetConnをみると既にidleなconnectionがある場合はそちらを利用する設計なのがわかる。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// getConn dials and creates a new persistConn to the target as
// specified in the connectMethod. This includes doing a proxy CONNECT
// and/or setting up TLS. If this doesn't return an error, the persistConn
// is ready to write requests to.
func (t *Transport) getConn(treq *transportRequest, cm connectMethod) (*persistConn, error) {
...
if pc, idleSince := t.getIdleConn(cm); pc != nil {
if trace != nil && trace.GotConn != nil {
trace.GotConn(pc.gotIdleConnTrace(idleSince))
}
// set request canceler to some non-nil function so we
// can detect whether it was cleared between now and when
// we enter roundTrip
t.setReqCanceler(req, func(error) {})
return pc, nil
}

...

go func() {
pc, err := t.dialConn(ctx, cm)
dialc <- dialRes{pc, err}
}()

idleConnCh := t.getIdleConnCh(cm)
...
}

middlewearの実装

ここまでの結果から実際の具体的な実装をしていく。
middlewearはhttp.RoundTripperをオプションにとりhttp.RoundTripperを返す関数であればよい。
またhttp.Serrverのmiddlewearを実装下のrと同じく、clientのmiddlewear関数もhttp.Requestを受け、http.Responseを返す関数をオプションとする関数を返す必要がある。

1
2
3
4
5
func adapter(next http.RoundTripper) http.RoundTripper {
return RoundTripperFunc(func(r *http.Request) (*http.Response, error) {
return next.RoundTrip(r)
})
}

またこれらの関数をClient構造体のTransportメンバーに渡せるようにする関数を作成する必要がある。

1
2
3
4
5
6
7
8
9
func useAdapters(adapters ...adapter) adapter {
return func(final http.RoundTripper) http.RoundTripper {
fn := final
for i := len(adapters) - 1; i >= 0; i-- {
fn = adapters[i](fn)
}
return fn
}
}

のようにすることでhttp.clientのmiddlewearでmiddlewearを利用できるようになる。
この実装を見ても、serverのmiddlewearと同じ実装出ることがわかる。

実際のコードは以下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
"fmt"
"net/http"
)

type adapter func(http.RoundTripper) http.RoundTripper
type RoundTripperFunc func(*http.Request) (*http.Response, error)

func (f RoundTripperFunc) RoundTrip(r *http.Request) (res *http.Response, err error) {
return f(r)
}

func adapterA(next http.RoundTripper) http.RoundTripper {
return RoundTripperFunc(func(r *http.Request) (*http.Response, error) {
fmt.Println("Executing adapterA before adapter")
res, err := next.RoundTrip(r)
fmt.Println("Executing adapterA after adapter")

return res, err
})
}

func adapterB(next http.RoundTripper) http.RoundTripper {
return RoundTripperFunc(func(r *http.Request) (*http.Response, error) {
fmt.Println("Executing adapterB before adapter")
res, err := next.RoundTrip(r)
fmt.Println("Executing adapterB after adapter")
return res, err
})
}

func useAdapters(adapters ...adapter) adapter {
return func(final http.RoundTripper) http.RoundTripper {
fn := final
for i := len(adapters) - 1; i >= 0; i-- {
fn = adapters[i](fn)
}
return fn
}
}

func main() {
adapters := useAdapters(adapterA, adapterB)
client := &http.Client{
Transport: adapters(http.DefaultTransport),
}
resp, err := client.Get("https://example.com")
fmt.Println("RES: %s, Log: %s", resp, err)
}

まとめ

golangのhttp server, clientともに同じ設計でmiddleweaerの実装があ可能な設計が取られており、
またclientはtransporterの実装によりプロトコルを変更・拡張することができる。
柔軟な設計はgolangでアプリケーションを作成するにあたっても良い手本となりそう。

Comments