マイクロサービスのためのgoa

1. マイクロサービスのための
フレームワークgoaのご紹介
2017. 06. 23 オレシカナイトVol.2

2. Self Introduction

3. 渋江 一晃
MDH アドテク局 基盤グループ サーバーサイドエンジニア
2016年サイバーエージェント中途入社
最近Go始めました（Go歴3ヶ月（実質1ヶ月半））

4. Introduce goa

5. APIをどのように設計します
か？

6. 考えることは色々ある
- ルーティング
- バリデーション
- APIドキュメント
...

7. いざ始めると色々な問題が…
- ころころ変わるAPI仕様
- バリデーションどうしよう
- 追従できないAPIドキュメント
APIの「側」を作るだけでも大変

8. ビジネスロジックに集中し
たい

9. マイクロサービスのためのフレームワーク
https://github.com/goadesign/goa

10. goa
design firstを謳っているgoでマイクロサービスを構築するためのフレームワーク
design DSLからコード生成（goagen）してAPIを作る

11. APIデザインライフサイクル

12. swagger生成ツール
- go-swagger
→ swaggerが既にあると便利
→ EP毎のミドルウェアの設定ができなかった
- goa
→ DSLが読みやすかった
→ ドキュメントもgo-swaggerと比べて多かった

13. goaが自動生成してくれるもの
- ルーティング
- バリデーション
- コントローラー
- APIドキュメント（swagger）

14. How to use goa

15. 0. prepare
$ go get -u github.com/goadesign/goa/...
$ mkdir $GOPATH/src/goa-adder

17. 1.design
$GOPATH/src/goa-adder/design/design.go

18. generate
$ goagen bootstrap -d goa-adder/design

20. 2. review
APIデザイン→generateした結果、以下が生成される
- コントローラー
- バリデーション
- リクエスト・レスポンスのモデル
- swagger定義
インターフェースのレビュー

22. 3. Implement
プロジェクトルート直下にあるoperands.goを開く

23. 3. Implement
operands.goを編集

24. 4. Run
$ go build
$ ./goa-adder
2017/06/20 16:51:49 [INFO] mount ctrl=Operands action=Add route=GET /add/:left/:right
2017/06/20 16:51:49 [INFO] listen transport=http addr=:8080

25. Swagger
design/design.goに追記

26. $ goagen bootstrap -d goa-adder/design
swagger.goが生成される
main.goに追記してControllerをmountする

27. 再コンパイル
$ go build && ./goa-adder

28. Tips

29. 基本的にいじるのは
- Controller
- main.go
他はgoaが生成するので触らない（上書きされる）
追加したControllerのマウントし忘れがちょくちょくある

30. ミドルウェア

31. エラーハンドリング
goaが自動生成するエラーではなくアプリ独自のエラーで返したい
→ issue（#1076）で質問

32. goaが生成するエラーメッセージに該当のエラーが含まれていたら自前のエラー
に置き換えるミドルウェアを実装

33. gorma
goa向けのストレージプラグイン
カスタムDSLをgenerateすると、自動でモデルの生成とDaoなどの便利なヘルパ
ーも生成してくれる

34. まとめ
- APIを作る上で最低限必要なコードを自動生成してくれる
- swagger（json/yaml）も生成してくれる
- DSLは読みやすい
- 日本語ドキュメントも充実