GoらしいAPIを求める旅路 (Go Conference 2018 Spring)

Goらしい
APIを求める旅路
GoCon 2018 Spring Apr 15 2018
Daisuke Maki @lestrrat (HDE inc)

• @lestrrat
• Perl/Go hacker, author, father
• Author of github.com/peco/peco
• Organizer for builderscon

<宣伝>
http://blog.builderscon.io/entry/call-for-sponsors-2018
スポンサー募集、今月末まで！

Goを使うなら
なるたけGoっぽいAPIがいい

github.com/cenkalti/backoff
backoff.Retry(f, strategy)

github.com/cenkalti/backoff
backoff.Retry(f, strategy)
[func() error]

Callback/Closure
• 関数を受け取るAPIでは、シグネチャがポイ
ントになる
• 関数を許すからにはadhocな関数呼び出しが
できるべき

net/http
type HandleFunc func(ResponseWriter, *Request)
• net/httpでこの関数の副作用は気にしない
でよい
• AdhocなHandlerをポンポン登録できる

func Foo() (Result, Result, Result, error)
What About…

backoff.Retry(Foo, …)
This no worky…

backoff.Retry(Foo, …)
This no worky…
signatureが合わない

backoff.Retry(func() error {
a, b, c, err := Foo()
if err != nil {
return err
}
}, …)
Capture Return Values

if err != nil {
return err
}
}, …)
Capture Return Values
この戻り値をRetryの外側で使うには？

var a, b, c Result
if err != nil {
return err
}
}, …)
Upper Scope

var a, b, c Result
if err != nil {
return err
}
}, …)
Upper Scope
あ！

var a, b, c Result
a, b, c, err = Foo()
if err != nil {
return err
}
}, …)
Final Result

ちょっとまった！
• スコープを気にしながらコードを書かな
いといけない
• := と = を間違ってもコンパイラが怒っ
てくれない
• 毎回ムダ？にクロージャを作ってて

どんなAPIだと ?
＋
拡張性を持たせられる？

Use Interface?
backoff.Retry(f, stretegy)

Use Interface?
backoff.Retry(f, stretegy)
type Operation interface {
Do() error
}

type FooWrapper struct {
A Result
B Result
C Result
}
func (f *FooWrapper) Do() error {
f.A, f.B, f.C, err = Foo()
…
}
Store The Results

var f FooWrapper
backoff.Retry(f, …)
// Use f.A, f.B, f.C
Final Result

var f FooWrapper
backoff.Retry(f, …)
// Use f.A, f.B, f.C
Final Result
「これじゃない感」…
毎回型を作る必要がある…

たとえばadhocな関数は？

type OperationFunc func() error
func (f OperationFunc) Do() error {
return f()
}
Adhoc Functions?

type OperationFunc func() error
func (f OperationFunc) Do() error {
return f()
}
Adhoc Functions?
http.HandlerFuncと同じ
形にすればキレイになる？

var a, b, c Result
backoff.Retry(OperationFunc(func() error {
a, b, c, err = Foo()
if err != nil {
return err
}
}), …)
あ、これ前と同じだ

小細工では同じような形に
なってしまう

一歩引いて考え直す…

backoffは何をするのか
• 関数を実行する
• 成功したら終わる
• 失敗したら、待つ
• optional: context.Contextで途中停止

for {
if err := f(); err == nil {
return
}
time.Sleep(delay)
}
First pass

for {
return
}
time.Sleep(delay)
}
First pass
関数を実行する
成功したら終わる
失敗したら待つ

backoffは何をするのか
• 関数を実行する
• 成功したら終わる
• 失敗したら、待ち時間を増やしながら待つ
• optional: context.Contextで途中停止

for {
return
}
select {
case <-ctx.Done():
return
case <-time.After(nextDelay()):
}
}
Second pass

for {
return
}
select {
case <-ctx.Done():
return
}
}
Second pass

for {
return
}
select {
case <-ctx.Done():
return
}
}
Second pass
失敗したら待ち時間を
増やしながら待つ
context.Contextで
途中停止

この形を簡単に書けるように
すればいいはず…

github.com/lestrrat-go/backoff

policy := backoff.NewExponential(…)
Backoff Policy Object

b, cancel := policy.Start(ctx)
Backoff object

defer cancel()
for {
return
}
select {
case <-b.Done():
return
case <-b.Next():
}
}

defer cancel()
for {
return
}
select {
case <-b.Done():
return
case <-b.Next():
}
}
<-chan time.Time
<-chan struct{}

ただのコードブロックなので
戻り値も自由自在

defer cancel()
for {
a, b, c, err := f()
if err == nil {
// use or return a, b, c here
}
select {
case <-b.Done():
return
case <-b.Next():
}
}

Bonus: separate Policy/Backoff

b := cenkalti.NewExponential()
for … {
go func(b cenkalti.Backoff) {
// b is shared… be careful!
}(b)
}
bを共有せざるを得ない

for … {
go func(b backoff.Backoff, cancel func()) {
// b is safe to be used in a separate goroutine
}(policy.Start(ctx))
}
共有されるpolicyとbは別

Problem:
Boilerplate Code is Long

defer cancel()
for {
a, b, c, err := f()
if err == nil {
return
}
select {
case <-b.Done():
return
case <-b.Next():
}
}

for {
select {
case <-b.Done():
return
case <-b.Next():
}
}

for {
select {
case <-b.Done():
return
case <-b.Next():
}
}
bail out of loop

for {
select {
case <-b.Done():
return
case <-b.Next():
}
}
bail out of loop
continue loop

func Continue(b *Backoff) bool {
select {
case <-b.Done():
return false
case <-b.Next():
return true
}
return false // never reached
}
func to determine loop condition

defer cancel()
for backoff.Continue(b) {
a, b, c, err := f()
if err == nil {
return
}
}
キュッとした！

defer cancel()
for backoff.Continue(b) {
a, b, c, err := f()
if err == nil {
return
}
}
キュッとした！
use as condition

確認
channelでタイミング制御
contextで途中停止

確認
for backoff.Continue() でループ制御

確認
goroutine safe by design

確認
クロージャに頼る必要がない
goroutine safe by design

GoらしいAPIを求める旅路 (Go Conference 2018 Spring)

APIデザインをする時はその言
語の自然なフローを許す形を
考えるのがお勧め

（なお、コードをよく読むと、
cenkalti/backoffも実装はほぼ同じ仕
組みになっているが、公開しているイ
ンターフェースがまったく違う）

「Google APIから学ぶ自動生成」
※ Goの連載記事です
※ GoのためのAPIデザインの話です

GoらしいAPIを求める旅路 (Go Conference 2018 Spring)

Recommended

More Related Content

What's hot (20)

Similar to GoらしいAPIを求める旅路 (Go Conference 2018 Spring) (20)

More from lestrrat (20)

GoらしいAPIを求める旅路 (Go Conference 2018 Spring)