google/wireを使った Goらしいアーキテクチャへの取り組み / gocon-fukuoka-2019-summer

2019/07/13 に行われたGo Conference '19 Summer in Fukuoka で発表した資料です。

https://fukuoka.gocon.jp/ja/speakers/budougumi0617/

Transcript

1. GoConference’19
   google/wireを使った
   Goらしいアーキテクチャへの取り組み
   Go Conference ‘19 in Summer
   2019/07/13 Yoichiro Shimizu @budougumi0617
   

   View Slide

2. GoConference’19
   2
   Yoichiro Shimizu @freee K.K.
   https://budougumi0617.github.io/
   

   View Slide

3. GoConference’19
   3
   

   View Slide

4. View Slide

5. 今日のゴール
   ● google/wireの概要・利用方法を紹介する
   ● （私が考える）Goらしいパッケージ設計の共有する
   ● 実際にgoogle/wireを使ったコードの紹介する
   ● google/wireのCons/Prodを共有する
   5
   

   View Slide

6. google/wire
   6
   /
   

   View Slide

7. Dependency Injection
   7
   

   View Slide

8. github.com/google/wire
   ● DIを行うためのCLIツールと実装用APIライブラリ
   ○ 2018年7月に公開されたgoogle/go-cloudに付属
   ○ 同年12月頃に独立したリポジトリに分離
   ○ 現在 v0.3.0（beta release）
   ○ DIの定義をするライブラリ
   ○ 定義からDIコードを自動生成するCLI
   8
   

   View Slide

9. wireがもつ2つの概念
   ● Provider
   ○ どのような依存関係があるのか
   ● Injector
   ○ どうやって依存を解決するのか
   9
   

   View Slide

10. Provider
    wire.NewSetで定義
    10
    

    View Slide

11. wire show
    11
    

    View Slide

12. Inejctor
    wire.Buildで定義
    12
    この宣言はBuild Constraintsを使ってgo build時には使われない
    

    View Slide

13. wire gen
    依存性を解決したコードを自動生成
    13
    wire genで生成したこちらのコードが go build時に利用される
    

    View Slide

14. Inejctor
    先ほど程度ではあまりメリットを感じないが…
    14
    

    View Slide

15. wire gen
    自動生成結果
    クリーンアップ処理も
    よしなに書いてくれる
    15
    

    View Slide

16. wireを使った
    アーキテクチャ
    16
    /
    

    View Slide

17. その前に
    17
    /
    

    View Slide

18. Goらしい
    設計とは？
    18
    /
    

    View Slide

19. 良いアーキテクチャ設計をしたい
    ● Goにおいて何をもって「よい」と言えるのか？
    ○ フラットパッケージにすればよい？
    ○ DDDのような本のレイヤー構成通りにすればよい？
    ● 言語思想に沿った設計を心がける
    ○ Simplicity
    19
    

    View Slide

20. Simplicity - 徹底的な簡潔性
    ● GoのMission
    ○ Creating software at scale
    ○ Running software at scale
    ● システムは成長する際に、デザインの簡潔性を通してのみ、
    安定し、安全であり、首尾一貫したままでいられる
    20
    Go's New Brand の Mission, プログラミング言語 Go まえがき より
    

    View Slide

21. ● 小さなInterfaceで他pkgへの依存を絞る
    ○ 高々1つしかメソッドを持たないXXXer
    ● Interfaceとダックタイピング
    ○ 利用package側でInterfaceを宣言
    疎でひとつのことをうまくやるレイヤー構成
    21
    

    View Slide

22. コード
    22
    /
    

    View Slide

23. 各レイヤーの実装イメージを簡単に紹介
    ● 題材: OAuth2.0トークンを生成するHTTPサーバ
    ○ HTTPリクエストパラメータを使って認可サーバからトークンを
    生成する
    ○ 生成したアクセストークンをDBに永続化
    23
    

    View Slide

24. package構成
    24
    entity データの定義
    domain ドメインロジックの実装
    repository データの永続化
    usecase ドメインモデルとリポジトリからシナリオを作る
    http HTTPとプリミティブなパラメータを仲介
    app Injectorを配置し自動生成コードを置く
    

    View Slide

25. entity
    素朴なデータ構造
    25
    

    View Slide

26. domain
    ドメインロジックの実
    装
    ダミー認可サーバを
    使ったテストなど結
    構真面目に書いて
    いる
    26
    

    View Slide

27. repository
    RDBMSに対する
    CRUD
    UTではsqlmockな
    どを利用
    27
    モックで済ませているのは基盤ライブラリを使っているからという事情もある
    

    View Slide

28. usecase 1
    リポジトリ層に対す
    る抽象化
    28
    

    View Slide

29. usecase 2
    ドメインモデルとリポ
    ジトリを組み合わせ
    る層
    UTではgo-mockを
    利用
    wireでSetを定義
    29
    リポジトリは各ユースケース共通になることが多いのでドメインモデルのみ DIしている
    

    View Slide

30. http
    HTTPリクエストをプ
    リミティブなパラメー
    タに分解
    UTではgo-mockと
    httptestを利用
    wireでSetを定義
    30
    

    View Slide

31. app
    全ての依存関係の
    解決方法を定義
    wire genでコードを
    自動生成する
    31
    HealthCheckやメトリクスチェックなどアプリとして必要な機能も全て DIしている
    

    View Slide

32. 所感と利点
    32
    /
    

    View Slide

33. ● package間のインターフェイスにwire wayができる
    ○ wireが使いやすい構造 == 疎な構造
    ● パッケージ間の依存関係を機械的に表現できる
    ○ wire show
    ● あまり独自要素がない
    ○ ロジック部分に癒着しないので最悪すぐ辞められる
    使っていてよいところ
    33
    

    View Slide

34. ● 単純にDIコードを書かなくて済んでいる
    ○ 自動生成前 36行 / 自動生成後 91行
    ■ 4 API, RDS, KMS, Redis etc...
    ● wireコマンド自体も使いやすい
    ○ エラーメッセージなどが親切
    使っていてよいところ
    34
    

    View Slide

35. ● 先月にbetaリリース
    ○ まだ破壊的変更が入る可能性がある
    ● 単純に依存するツールが増える
    ○ wire”コマンド”もバージョン管理しないといけない
    ● Interface増えがち
    ○ wireのためのInterfaceになっている気もする
    難しいところ
    35
    

    View Slide

36. まとめ
    36
    /
    

    View Slide

37. 今日のゴール
    ● google/wireの概要・利用方法を紹介する
    ● （私が考える）Goらしいパッケージ設計の共有する
    ● 実際にgoogle/wireを使ったコードの紹介する
    ● google/wireのCons/Prodを共有する
    37
    

    View Slide