JSON、ルーティング、埋め込み

JSON, routing and embedding

この章のすべてのコードはここにあります

前の章 プレイヤーが勝ったゲームの数を保存するWebサーバーを作成しました。

私たちの製品所有者には新しい要件があります。保存されているすべてのプレーヤーのリストを返す「/league」という新しいエンドポイントを作成します。彼女はこれがJSONとして返されることを望んでいます。

ここまでのコードは

// server.go
package main

import (
    "fmt"
    "net/http"
	"strings"
)

type PlayerStore interface {
    GetPlayerScore(name string) int
    RecordWin(name string)
}

type PlayerServer struct {
    store PlayerStore
}

func (p *PlayerServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	player := strings.TrimPrefix(r.URL.Path, "/players/")

    switch r.Method {
    case http.MethodPost:
        p.processWin(w, player)
    case http.MethodGet:
        p.showScore(w, player)
    }
}

func (p *PlayerServer) showScore(w http.ResponseWriter, player string) {
    score := p.store.GetPlayerScore(player)

    if score == 0 {
        w.WriteHeader(http.StatusNotFound)
    }

    fmt.Fprint(w, score)
}

func (p *PlayerServer) processWin(w http.ResponseWriter, player string) {
    p.store.RecordWin(player)
    w.WriteHeader(http.StatusAccepted)
}

章の上部にあるリンクで対応するテストを見つけることができます。

まず、「/league」テーブルのエンドポイントを作成します。

最初にテストを書く

いくつかの便利なテスト関数と偽のPlayerStoreを使用するため、既存のスイートを拡張します。

実際のスコアとJSONについて心配する前に、目標に向かって反復する計画で変更を小さく保つようにします。最も簡単な開始は、/leagueを押してOKが返されることを確認することです。

テストを実行してみます

私たちの PlayerServer404 Not Found を返し、まるで未知のプレイヤーの勝利を得ようとしているかのようです。server.go がどのように ServeHTTP を実装しているかを見てみると、常に特定のプレイヤーを指す URL で呼び出されることを想定していることが分かります。

前章で、これはかなり素朴なルーティングの方法であると述べました。このテストは、異なるリクエストの経路をどのように扱うかについての概念が必要であることを正しく知らせてくれています。

成功させるのに十分なコードを書く

GoにはServeMux (request multiplexer)と呼ばれるルーティング機構が組み込まれており、http.Handlerを特定のリクエストパスにアタッチすることができます。

いくつかの罪を犯して、テストをできる限り迅速に通過させましょう。テストに成功したら、安全にリファクタリングできます。

  • リクエストの開始時にはルータを作成し、xのパスにはyハンドラを使用するように指示します。

  • 新しいエンドポイントにはhttp.HandlerFuncを使用し、/leagueがリクエストされたときに w.WriteHeader(http.StatusOK) を指定する anonymous function を使用して、新しいテストをパスするようにします。

  • /players/のルートについては、コードを切り取り、別のhttp.HandlerFuncに貼り付けています。

  • 最後に、新しいルータの ServeHTTP を呼び出して、リクエストを処理します。

これでテストはパスするはずです。

リファクタリング♪

ServeHTTPはかなり大きく見えます。ハンドラを別のメソッドにリファクタリングすることで、物事を少し分離することができます。

リクエストが来てからルータの設定をして、それを呼び出すというのは、なんだか変な感じがします。理想的には、ある種のNewPlayerServer関数を持っていて、依存関係を取り込んで、 ルータを作成するための一度きりのセットアップを行うことです。それぞれのリクエストはそのルーターのインスタンスを使うだけです。

  • PlayerServerはルータを保存する必要があります。

  • ルーティングの作成をServeHTTPからNewPlayerServerに移動したので、これはリクエストごとではなく一度だけで済みます。

  • NewPlayerServer(&store)PlayerServer{&store}を実行するために使用していたすべてのテストおよび製品コードを更新する必要があります。

最後のリファクタリング

以下のようにコードを変更してみてください。

そして、server_test.go, server_integration_test.go, main.go 内の server := &PlayerServer{&store}server := NewPlayerServer(&store) に置き換えてみてください。

最後に、func (p *PlayerServer) ServeHTTP(w http.ResponseWriter, r *http.Request)が不要になったので、delete が不要になったので、削除してください。

埋め込み

PlayerServerの2番目のプロパティを変更し、名前付きプロパティrouter http.ServeMuxを削除して、http.Handlerに置き換えました。 これは 埋め込み(embedding) と呼ばれます。

Go は典型的な型駆動型のサブクラス化の概念を提供しませんが、構造体やインターフェイス内に型を埋め込むことで、実装の一部を「借用」する機能があります。

効果的なGo - Embedding

これが意味することは、私たちの PlayerServer http.Handlerが持つすべてのメソッドを持っているということです。これは単なる ServeHTTPです。

このhttp.Handlerを「埋める」ために、NewPlayerServerで作成したrouterに割り当てます。これはhttp.ServeMuxServeHTTPというメソッドを持っているからです。

埋め込み型を介してすでに公開しているため、これにより独自のServeHTTPメソッドを削除できます。

埋め込みは非常に興味深い言語機能です。埋め込みは非常に興味深い言語の機能で、新しいインターフェースを構成するためにインターフェースと一緒に使うことができます。

また、インターフェースだけでなく、具象型でも使用できます。具象型を埋め込むと予想されるように、そのすべてのパブリックメソッドとフィールドにアクセスできます。

欠点はありますか?

埋め込む型のすべてのパブリックメソッドとフィールドを公開するため、埋め込み型には注意する必要があります。私たちの場合、(http.Handler)を公開したい interface だけを埋め込んだので問題ありません。

怠惰で埋め込まれたhttp.ServeMuxではなく具象型でも機能しますが、Handle(path、handler)が原因で、PlayerServerのユーザーはサーバーに新しいルートを追加できます公開する。

型を埋め込むときは、公開APIにどのような影響があるかをよく考えてください

埋め込みを誤用してAPIを汚染し、型の内部を公開することは、よくある間違いです。

これでアプリケーションが再構築され、新しいルートを簡単に追加して、 /leagueエンドポイントの開始を設定できます。ここで、いくつかの有用な情報を返すようにする必要があります。

このようなJSONを返す必要があります。

最初にテストを書く

まず、応答を意味のあるものに解析することから始めます。

SON文字列をテストしないのはなぜですか?

より単純な最初のステップは、応答の本文に特定のJSON文字列があることを表明することだと主張できます。

私の経験では、JSON文字列に対して評価するテストには次の問題があります。

  • もろさ。データモデルを変更すると、テストは失敗します。

  • デバッグが難しい。 2つのJSON文字列を比較するときに実際の問題が何であるかを理解するのは難しい場合があります。

  • 悪い意図。出力はJSONである必要がありますが、本当に重要なのは、データがエンコードされる方法ではなく、データが正確に何であるかです。

  • 標準ライブラリの再テスト。標準ライブラリがJSONを出力する方法をテストする必要はありません。すでにテストされています。他の人のコードをテストしないでください。

代わりに、JSONを解析して、テストに関連するデータ構造に変換する必要があります。

データモデリング

JSONデータモデルを考えると、いくつかのフィールドを持つPlayerの配列が必要なようですので、これをキャプチャする新しいタイプを作成しました。

JSONデコード

JSONを解析してデータモデルにするには、 encoding/jsonパッケージからDecoderを作成し、そのDecodeメソッドを呼び出します。Decoderを作成するには、読み取るためのio.Readerが必要です。この場合は、応答スパイのBodyです。

Decodeは、デコードしようとしているもののアドレスを受け取ります。そのため、前の行でPlayerの空のスライスを宣言します。

JSONの解析が失敗する可能性があるため、Decodeerrorを返す可能性があります。それが失敗した場合にテストを続行する意味はないので、エラーを確認し、エラーが発生した場合は t.Fatalfでテストを停止します。テストを実行している誰かが解析できない文字列を確認することが重要であるため、エラーとともに応答本文を表示することに注意してください。

Try to run the test

現在、エンドポイントは本文を返さないため、JSONに解析できません。

成功させるのに十分なコードを書く

テストに成功しました。

エンコードとデコード

標準ライブラリの素敵な対称性に注目してください。

  • Encoderを作成するには、http.ResponseWriterが実装するio.Writerが必要です。

  • Decoderを作成するには、レスポンススパイのBodyフィールドが実装するio.Readerが必要です。

この本を通して、io.Writerを使用しました。これは、標準ライブラリでの普及と、多くのライブラリが簡単に動作することを示すもう1つのデモです。

リファクタリング♪

ハンドラーとleagueTableを取得することの間に懸念の分離を導入すると、すぐにはハードコードしないことになるので便利です。

次に、テストを拡張して、必要なデータを正確に制御できるようにします。

最初にテストを書く

テストを更新して、Leagueテーブルにストアでスタブするプレーヤーが含まれていることをアサートできます。

Leagueを保存できるように、StubPlayerStoreを更新します。これは、Playerのスライスにすぎません。そこに期待されるデータを保存します。

次に、スタブのLeagueプロパティに一部のプレーヤーを配置して現在のテストを更新し、サーバーから返されることを評価します。

テストを実行してみます

テストを実行するための最小限のコードを記述し、失敗したテスト出力を確認します

StubPlayerStoreに新しいフィールドがあるので、他のテストを更新する必要があります。他のテストではnilに設定します。

テストをもう一度実行してみてください。

成功させるのに十分なコードを書く

データがStubPlayerStoreにあることを知っており、それをインターフェイス PlayerStoreに抽象化しました。PlayerStoreで私たちを渡す誰もがリーグのデータを提供できるように、これを更新する必要があります。

これで、ハードコードされたリストを返すのではなく、ハンドラーコードを更新してそれを呼び出すことができます。メソッドgetLeagueTable()を削除してから、leagueHandlerを更新してGetLeague()を呼び出します。

テストを実行してみてください。

InMemoryPlayerStoreStubPlayerStoreには、インターフェイスに追加した新しいメソッドがないため、コンパイラーは不平を言っています。

StubPlayerStoreの場合は非常に簡単です。先ほど追加したleagueフィールドを返すだけです。

ここでは、InMemoryStoreの実装方法について説明します。

GetLeagueを「適切に」実装することは、マップを反復することでかなり簡単ですが、テストをパスするための最小限のコードを記述しようとしていることを思い出してください。

それでは、コンパイラーを今のところ幸せにして、InMemoryStoreでの実装が不完全であるという不快な気持ちに耐えてみましょう。

これが実際に私たちに伝えていることは、これをテストしたいのですが、とりあえずここに置いておきましょう。

テストを試して実行すると、コンパイラーはパスし、テストはパスするはずです!

リファクタリング♪

テストコードは意図をうまく伝えておらず、リファクタリングできる定型文がたくさんあります。

ここに新しいヘルパーがあります

サーバーが機能するために必要な最後の1つは、JSONを返していることをマシンが認識できるように、応答でcontent-typeヘッダーを返すことを確認することです。

最初にテストを書く

このアサーションを既存のテストに追加します

テストを実行してみます

成功させるのに十分なコードを書く

leagueHandlerを更新します

テストは成功するはずです。

リファクタリング♪

application/json の定数を作成し、それを leagueHandler で使用します。

それから assertContentTypeのヘルパーを追加します

テストで使用してください。

これでPlayerServerを整理したので、InMemoryPlayerStoreに目を向けることができます。これを製品の所有者にデモしようとした場合、/leagueは機能しないためです。

確信を得るための最も簡単な方法は、統合テストに追加することです。新しいエンドポイントにアクセスして、 /leagueから正しい応答が返されることを確認できます。

最初にテストを書く

t.Runを使用してこのテストを少し分解し、サーバーテストのヘルパーを再利用できます。これもリファクタリングテストの重要性を示しています。

テストを実行してみます

成功させるのに十分なコードを書く

GetLeague()を呼び出すと、InMemoryPlayerStorenilを返すため、修正する必要があります。

必要なのは、マップを反復処理して、各キー/値をPlayerに変換することだけです。

これでテストに成功するはずです。

まとめ

TDDを使用してプログラムを安全に反復し続け、ルーターで保守可能な方法で新しいエンドポイントをサポートし、コンシューマーにJSONを返すことができるようになりました。次の章では、データの永続化とリーグの分類について説明します。

ここで習得したもの

  • ルーティング. 標準ライブラリには、ルーティングを行うための使いやすい型が用意されています。標準ライブラリはhttp.Handlerインターフェースを完全に取り入れており、Handlerにルートを割り当て、ルータ自身もHandlerになります。しかし、パス変数のような、あなたが期待するような機能はありません。この情報を自分で簡単に解析することはできますが、それが面倒になったら他のルーティングライブラリを見ることを検討したほうがいいかもしれません。人気のあるもののほとんどは、http.Handlerも実装するという標準ライブラリの哲学に固執しています。

  • 型の埋め込み. この手法については少し触れましたが、Effective Goから学ぶもあります。ここから一つだけ取っておくべきことがあるとすれば、非常に便利なことがあるということですが、常にパブリックAPIのことを考えて、適切なものだけを公開するということです。

  • JSONのデシリアライズとシリアライズ. 標準ライブラリは、データのシリアライズとデシリアライズを非常に簡単にしてくれます。また、設定にもオープンで、必要に応じてこれらのデータ変換がどのように動作するかをカスタマイズできます。

最終更新

役に立ちましたか?