Ginの構築:EasyよりもSimpleを優先する
Building Gin: Simple over Easy (manualmeida.dev)
要約
この記事は、Go言語のWebフレームワークであるGinの設計哲学「EasyよりもSimple」について解説しています。作成者は、多くのマジックに頼るMartiniのようなフレームワークとは異なり、開発者が明確な制御フローを持ち、ボイラープレートコードを減らすためのシンプルなツールを提供することを目指しました。特に、高速なルーティングとゼロの破壊的変更に焦点を当てた設計原則が強調されています。
全文翻訳
Ginの構築: Simple Over Easy
2014年、私は何の計画もなくサンフランシスコから帰国しました。JoypadとTinySparkでSDKを構築するのに1年を費やし、最初のゲームのいくつかをリリースした後、その1年間で小規模なソフトウェアチームがツールに何を必要とするかについての良い感覚を得ました。スペインに戻り、電気通信工学を始める直前に、次に何を構築するかを決めなければなりませんでした。
その答えは、人々の興味を中心に据えたソーシャルネットワークであるFyveでした。バックエンドにはGoを選びました。なぜなら、その言語は適切な意味でプレーンであり、Ginはその製品のためのWebフレームワークとして始まりました。コードはまだgin-gonic/ginにあります。
[画像: Gin Gonic Go framework illustration]
Fyveは決して成功しませんでした。その過程で私が構築したツールであるGinは、12年経った今でも続いています。
Simple over Easy
当時、人々が私に勧めてくれたGoのWebフレームワークはMartiniでした。すぐにその理由を理解しました。READMEは小さく、ミドルウェアモデルはエレガントに感じられ、数分でルートに応答させることができました。
Martiniはリフレクションベースの依存性注入を使用してハンドラーを配線していましたが、これにより最初のデモはスムーズに感じられましたが、重要な動作が見えにくくなっていました。サービスは、目に見える配線なしにハンドラーに現れたため、何かが誤動作したときに制御フローを追跡するのが困難でした。そして、そのリフレクションはすべてのリクエストで実行されていました。
その頃、私はRob PikeのSimplicity is Complicatedを見ました。それは、Martiniの何が私を悩ませていたのかについて、私に語彙を与えてくれました。私に残ったのは、単純なソフトウェアは、それを使う人の手間を減らすために、それを構築する人により多くの作業を必要とすることがよくあるという考えでした。
それがGinの設計ブリーフになりました。Easy(簡単)とは、最初の例がどれだけ良く見えるかということです。Martiniの最初の例は素晴らしく見えました。Simple(単純)とは、コードベースがあなたを驚かせるほど古くなったときに、理解しなければならない動く部品の数や、覚えておかなければならない例外の数ということです。
中間点を見つける
アリストテレスの徳のバージョンは中間点でした:多すぎず、少なすぎず。 それはフレームワークの問題の形でもありました。
Martiniはあなたに魔法をかけすぎました。プレーンなnet/httpは完全な制御と驚きを提供しませんが、ほとんど何も助けてくれません。そのため、ルートパラメータ、リクエスト解析、検証、レスポンスなどの同じ配線をハンドラーごとに書き続けることになります。どれも難しいことではありませんが、コードがノイズが多くなります。
Ginは、その2つの間のポイントへの私の試みでした。リクエストパスは明示的なまま、それにリフレクションを使用するものはなく、繰り返し発生する配線はContextと呼ばれる単一のオブジェクトにあります。
r := gin.Default()
r.GET("/users/:id", func(c *gin.Context) {
id := c.Param("id") // path params, no reflection
c.JSON(200, gin.H{"id": id}) // response rendering, one call
})
r.Run(":8080")
その*gin.Contextは、リクエスト、レスポンスライター、パスパラメータ、検証ヘルパー、レンダリングを運びます。そのため、それを渡す唯一のものです。一般的な操作はメソッド呼び出し1つでアクセスでき、その背後には本番環境で奇妙なことが起こったときにステップインできるプレーンなGoコードがあります。
面白いことに、gin.Contextは2014年にリリースされました。これは、標準ライブラリのcontext.Contextが存在する2年前でした。標準のものが到着したとき、私たちは名前を維持し、gin.Contextが新しいインターフェースを満たすようにしました。そのため、既存のすべてのプログラムはコンパイルされ続け、context.Contextが期待される場所ならどこでもgin.Contextを渡すことができました。
その本能はSDKの年からのものです。何かを行うための便利な方法が正しい方法でもあるとき、人々はそれに気づかずに、より良いコードを書きます。
ラディックスツリーを中心に構築されたルーター
ルーターは、Simple over Easyの線が具体的になった場所です。Martiniは正規表現のリストをウォークし、それぞれに一致するかどうかを尋ねることでリクエストを照合していました。正規表現は柔軟性があり、ルートが数値のみに一致するようにしたり、パターン内に余分なルールを隠したりできますが、それらはフレームワーク内に存在する第二の言語でもあります。
Ginのルート言語はより小さいです。静的セグメント、名前付きパラメータ、キャッチオールがあり、その制限がルーターがラディックスツリーを使用できる理由であり、これはhttprouterがGoで普及させたアプローチと同じです。それはまた、私が感謝するようになった副作用もありました。ルート言語は巧妙にできることを何も与えないため、Ginのために書かれたルートは、定型的で退屈なものになる傾向があります。
ルートをスキャンせずにルートルックアップ
routes 0 nodes 1 matched /
図。圧縮されたラディックスツリー。ライブで構築および照合されます。共有プレフィックスは1つのパスに折りたたまれ、その後 /blog/42/comments はツリーをウォークし、42 を :slug としてバインドします。
通常のルートから始める
ルーターは、/search、/support、/blog/:slug/commentsのようなルート文字列を見ます。単純なルーターは、リクエストごとにそれらを1つずつテストしますが、ラディックスツリーは、共有テキストを事前に1つの構造にマージします。
共有プレフィックスは折りたたまれる
/searchと/supportは/sを共有し、2つのブログルートは/blog/を共有し、次に:slugを共有します。そのため、各共有プレフィックスは1回だけ格納されます。
マッチングは1つのパスをウォークする
/blog/42/commentsの場合、ルックアップは/blog/をたどり、:slugで42をバインドし、/commentsに進みます。他のルートはまったく訪問されません。
ホットパスは小さく保たれる
ウォークが最終ノードに到達する頃には、ハンドラーはすでにそれにアタッチされており、パスパラメータは事前に割り当てられたスライスにあります。途中でリフレクションを必要とするものはありませんでした。
/blog/42/commentsを照合すると、/blog/を:slugノードまでウォークし、42をバインドし、/commentsに進みます。ルックアップのコストはURLの長さに依存し、アプリに10個のルートが登録されていても1万個のルートが登録されていても同じです。プレフィックスを共有するルートはノードも共有するため、大きなルートテーブルはメモリ内でコンパクトに保たれます。
nn個のルートと長さkkのリクエストパスを持つルーターの場合、ラディックスツリーのルックアップは
Tmatch(k)=O(k)、nに依存しないT_\text{match}(k) = O(k), \quad \text{independent of } n,
while nn個の正規表現のリストをチェックすると、長さmmのパターンの場合、O(n⋅m)O(n \cdot m)のコストがかかります。ツリーは、リクエストごとのスキャンを、共有プレフィックスを1回ウォークすることと交換します。
割り当ても同様の考え方です。パスパラメータは事前に割り当てられたスライスに入り、Contextオブジェクトはsync.Poolから取り出され、リクエスト間でリセットされるため、ガベージコレクターはクリーンアップするジャンクが少なくなり、レイテンシがぐらつく理由が少なくなります。
私はこの種のパフォーマンス作業を信頼しています。なぜなら、スピードはより少ないことを行うことから来るからです。そして、より少ないことを行うことは、コードを読む人に理解することが少なくなることを残します。
ゼロブレークチェンジのための設計
私が自分自身に与えたもう1つの制約は、後方互換性でした。Goは言語自体に互換性の約束をしており、私はGinにもユーザーに同じ取引を提供したかったのです。
その制約は設計方法を変えます。公開APIに何かを入れる前に、それを10年間維持することに満足できるかどうかを自問します。なぜなら、後で削除することはできないからです。5文字を節約する巧妙な名前変更を却下することを学び、すべてのエクスポートされた関数を、見知らぬ人が会社を築いたかもしれないものとして扱います。
その制約は守られました。Ginに対して書かれた最初のプログラムのいくつかは、10年以上経った今でもコンパイルして実行されており、私はそれをベンチマークよりも誇りに思っています。
Hacker News、そして成長
私は適切なタイミングでHacker NewsにGinをリリースしました。Goはそこで注目を集めており、1つのREADMEと良好なベンチマークに収まるフレームワークは、人々が試すのが簡単でした。
その後の成長は着実でした。人々はそれを使用し、問題を報告し、パッチを送り、実際のサービスに導入しました。今日、Ginは約88kのスターを持ち、290k以上のプロジェクトがそれに依存しています。
スターは虚栄心の指標であり、私は主にそのように扱います。依存関係の数は私が気にする数字です。なぜなら、それらのプロジェクトのそれぞれは、APIが下に壊れないという賭けであり、その賭けはFyveが消えたずっと後でも払い戻しを続けているからです。
卒業させる
数年後、私は身を引き、Ginを私なしで改善し続けたメンテナーに引き渡しました。私はそれをプロジェクトの卒業と考えています。特にBo-Yi WuとJavier Provechoに特別な賛辞を送ります。彼らはそれを前進させ、高い基準を維持しました。
それが私が最も尊敬するオープンソースの部分です。プロジェクトが作者を必要としなくなったとき。Ginはその後、他の人々の長年のユースケース、優先順位、好みを吸収し、それによってより良くなりました。
ライブラリを構築しているなら、それが私が目指すべき基準です。10年間維持できると想像できるAPIを設計し、それが簡単にするよりもコストがかかる場合でも、その下に単純にしてください。なぜなら、運が良ければ、そのものはあなたを超えて成長するからです。
私は数年後にコンパイラで同じことをしようとしました。それがQwikの物語です。