govalid ~ Type-safe validation tool ~

Transcript

1. govalid ~ Type-safe validation tool ~ 02/26/2025 sivchari newmo Inc The Go gopher was designed by Renée French.
2. 自己紹介 Goのバリデーションツール 既存ツールの問題点 govalid govalidの仕組み まとめ
3. 自己紹介
4. • sivchari ◦ X/GitHub @sivchari • newmo • Kubernetes maintainer ◦ Cluster API ◦ Kube API Linter • Go Conference メインオーガナイザー
5. Goのバリデーションツール
6. • 有名どころは ◦ go-playground/validator • 他にも ◦ asaskevich/govalidator ◦ go-ozzo/ozzo-validation Goのバリデーションツール
7. 既存ツールの問題点
8. • reflect依存のバリデーション ◦ reflectは実行時評価なのでパフォーマンスが悪い ◦ structのバリデーションだとネストしてくるとその分評価に時間が かかり、reflectする回数が増える ◦ 大規模リクエストを受ける時にいくらパフォーマンスを上ても致命的 で手動でバリデーションする？？ 既存ツールの問題点
9. govalid ~ Type-safe validation tool ~
10. • https://github.com/sivchari/govalid ◦ 型安全にバリデーションコードを自動生成する ◦ kubebuilderを意識したmarker指向でコード生成を制御する ◦ 公式ページ ▪ https://sivchari.github.io/govalid/ govalid
11. • ◦ 型安全にバリデーションコードを自動生成する ◦ kubebuilderを意識したmarker指向でコード生成を制御する ◦ 公式ページ ▪ https://sivchari.github.io/govalid/ govalid
12. • https://sivchari.github.io/govalid/examples/ ◦ コメントベースを書くだけ ◦ 生成された関数に置き換えるだけ ◦ govalidの生成コードは標準パッケージがメイン ▪ 一部依存パッケージあり govalid
13. • VS reflection-based validators ◦ 全部のバリデーションツールに対して圧倒的勝利 ▪ https://sivchari.github.io/govalid/benchmarks/ ◦ ex. ▪ go-playgroundのRequiredに約40倍 ▪ URLのような複雑なvalidationでも約5倍 • ozzo-validationに対しては186倍 govalid
14. govalidの仕組み
15. • メインはast ◦ markers analyzerがそれぞれのstructやフィールドに紐づいたmarker を集める ◦ govalidがmarker analyzerの結果を受け取りコード生成を行う govalidの仕組み
16. • ResultとFact ◦ Result ▪ Analyzerが解析した結果をほかAnalyzerに伝搬するための仕組み ▪ ResultTypeで指定できる ◦ Fact ▪ 特定のオブジェクトに対してどのようなことがあったか記録するための 仕組み ▪ FactTypeで指定できる govalidの仕組み
17. govalidの仕組み
18. govalidの仕組み • Factはテスト可能 ◦ linterのテストのようにwantで書いて同じ内容が出力されて いるか確認する
19. まとめ
20. • reflection-based validationの不満を解決するツールを作ったよ ◦ Goの自動生成の強みを活かしたvalidationツール ◦ Goのvalidationツールのデファクトにしたい ◦ スターと拡散の協力お願いします！！！ ◦ まだまだやることたくさんあるので一緒に開発してくれる人を募集し ています！！！ まとめ