Go API Validation error handling

GoのAPIでのValidation Error Handlingの実装例です。

Transcript

1. © - BASE, Inc.
   Go製APIの
   Validation error
   handling
   . . #gouncon kg
   Go Un Conference kg - @hgsgtk
   

   View Slide

2. © - BASE, Inc.
   このトークで持ち帰れること
   • Goでのバリデーションハンドリングの実例
   • ネット上でなかなか⾒つからない（個⼈談）
   • UseCase: HTTPリクエスト時‧DB保存時
   • Question/Suggestionください
   • 即時に反映されるかも知れません
   

   View Slide

3. © - BASE, Inc.
   ⾃⼰紹介
   東⼝和暉 （Kazuki Higashiguchi）
   Twitter / GitHub : @hgsgtk
   バックエンドエンジニア
   BASE BANK, Inc. / Dev Division
   Go歴:
   - 趣味：2017.7〜
   - 仕事：2018.6〜
   

   View Slide

4. © - BASE, Inc.
   前提：全体パッケージ構成とUseCase
   バリデーション発⽣箇所
   バリデーション発⽣箇所
   

   View Slide

5. © - BASE, Inc.
   こんな感じのバリデーションエラーを返したい
   

   View Slide

6. © - BASE, Inc.
   バリデーション実装全体像
   

   View Slide

7. © - BASE, Inc.
   バリデーション実装STEP >
   

   View Slide

8. © - BASE, Inc.
   Step Validatorを作成する > 使⽤ライブラリ
   • go-playground/validator
   • https://github.com/go-playground/validator
   • ginフレームワークで公式採⽤されている
   • →このライブラリをwrapした validation パッケージ
   を作成
   

   View Slide

9. © - BASE, Inc.
   go-playground/validatorの利⽤例
   こんな感じで validate タグ設定できる
   

   View Slide

10. © - BASE, Inc.
    Step : Validatorを作成する > validation パッケージ
    • go-playground/validator を各種import
    

    View Slide

11. © - BASE, Inc.
    Step : Validatorを作成する
    • NewRequestValidator: Request Validator
    • NewDBValidator: Database Validator
    

    View Slide

12. © - BASE, Inc.
    バリデータを作成する NewValidator()
    Step : Validatorを作成する
    

    View Slide

13. © - BASE, Inc.
    カスタムエラーメッセージの定義
    デフォルトは構造体名が出る → タグ名に変更
    Step : Validatorを作成する
    

    View Slide

14. © - BASE, Inc.
    Step : Validatorを作成する > tagNameFuncの作成
    • tagNameFuncを作成
    • See also: https://github.com/go-playground/
    validator/issues/
    •
    

    View Slide

15. © - BASE, Inc.
    Step : Validatorを作成する > 作成されたValidator
    

    View Slide

16. © - BASE, Inc.
    バリデーション実装STEP >
    

    View Slide

17. © - BASE, Inc.
    Step : バリデーション実⾏
    

    View Slide

18. © - BASE, Inc.
    Step : カスタムタグ登録
    

    View Slide

19. © - BASE, Inc.
    Step : カスタムタグを作って利⽤する
    • “inlist”というタグを作る例
    

    View Slide

20. © - BASE, Inc.
    Step : カスタムタグを作って利⽤する
    • “inlist”というタグを作る例
    “Inlist”タグは、
    “inStatusList()”というルールを実⾏
    

    View Slide

21. © - BASE, Inc.
    バリデーション実装STEP >
    

    View Slide

22. © - BASE, Inc.
    Step : バリデーション結果
    • error interfaceを満たした独⾃エラー型を作成する
    • 独⾃エラー型は、GetDetail()をシグネチャに持つ
    

    View Slide

23. © - BASE, Inc.
    Step : バリデーション結果 >
    バリデータが返すバリデーション結果
    

    View Slide

24. © - BASE, Inc.
    Step : バリデーション結果 >
    バリデータが返すバリデーション結果
    Detail内に
    バリデーション結果が含まれる
    

    View Slide

25. © - BASE, Inc.
    バリデーション実装STEP >
    

    View Slide

26. © - BASE, Inc.
    Step : バリデーション結果を利⽤ > 構造体への設定
    • バリデーションしたい構造体に validate タグを設定
    • 構造体⾃⾝がvalidatorを実⾏する振る舞いを持つ
    

    View Slide

27. © - BASE, Inc.
    Step : バリデーション結果を利⽤ > エラー結果を利⽤
    • error 型で返却される
    • validation.Error interface型か判定
    

    View Slide

28. © - BASE, Inc.
    Step : バリデーション結果を利⽤ > エラーレスポンス
    

    View Slide

29. © - BASE, Inc.
    Step : バリデーション結果を利⽤ >
    こんな感じのバリデーションエラーを返る
    

    View Slide

30. © - BASE, Inc.
    Step : バリデーション結果を利⽤ >
    DB保存時のバリデーション
    

    View Slide

31. © - BASE, Inc.
    Step : バリデーション結果を利⽤ >
    DB保存時のバリデーション
    INSERTのSQL実⾏前に
    バリデーション
    

    View Slide

32. © - BASE, Inc.
    まとめ
    • ネット上にGoでのバリデーションハンドリングの実
    例を晒した
    • Question/Suggestionください
    • 即時に反映されるかも知れません
    

    View Slide

33. Any Question or Suggestion?
    

    View Slide