ハンドラ関数の書き方

ハンドラ関数には、レスポンスを書き込むための http.ResponseWriter と、リクエスト情報を保持する *http.Request の2つの引数があります。ここでは、それぞれの役割と書き方を具体例で順に押さえていきます。

1. ResponseWriter への書き込み

http.ResponseWriter は、クライアントに返すレスポンス(ヘッダ・ステータスコード・ボディ)を書き込むための引数です。書き方は以下のとおりです。

まず、レスポンスヘッダは w.Header().Set で設定します。

w.Header().Set("ヘッダ名", "値")

続いて、ステータスコードは w.WriteHeader で明示的に書き込みます(省略時は 200)。

w.WriteHeader(ステータスコード)

最後に、レスポンスボディは fmt.Fprintln などの関数で書き込みます。

fmt.Fprintln(w, "本文")

main.go を以下の内容で置き換えて保存します。これは、/hello にアクセスするとレスポンスヘッダ・ステータスコード・ボディをすべて明示的に書いた こんにちは を返すコードです。

package main

import (
    "fmt"
    "net/http"
)

func hello(w http.ResponseWriter, r *http.Request) {
    // レスポンスヘッダを設定
    w.Header().Set("Content-Type", "text/plain; charset=utf-8")

    // ステータスコードを明示(省略時は200)
    w.WriteHeader(http.StatusOK)

    // レスポンスボディを書く
    fmt.Fprintln(w, "こんにちは")
}

func main() {
    http.HandleFunc("/hello", hello)

    fmt.Println("http://localhost:8080 で起動")
    http.ListenAndServe(":8080", nil)
}

既存のサーバが動いている場合は Ctrl+C で停止し、以下のコマンドで再起動します。

go run main.go

別のターミナルで以下のコマンドを実行します。-i オプションは、レスポンスヘッダとステータスコードもまとめて表示するオプションです。

curl -i http://localhost:8080/hello

以下のような実行結果が表示されます。

HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: XXX, XX XXX XXXX XX:XX:XX GMT
Content-Length: 16

こんにちは

コードで指定した 200 OK と Content-Type: text/plain; charset=utf-8 がヘッダとして返り、レスポンスボディに こんにちは が書き込まれていることが確認できます。

コードを解説します。

w.Header().Set("Content-Type", "text/plain; charset=utf-8")

w.Header().Set はレスポンスヘッダの設定です。Content-Type を指定することで、クライアントに「返すのは UTF-8 のプレーンテキスト」と伝えます。

w.WriteHeader(http.StatusOK)

w.WriteHeader はステータスコードを明示的に書き込みます。省略した場合は 200 OK が自動的に使われます。

fmt.Fprintln(w, "こんにちは")

レスポンスボディへの書き込みです。ヘッダやステータスコードは、ボディを書き始める前に設定する必要があります。

2. Request からの情報取り出し

*http.Request は、クライアントから届いたリクエストを保持する引数です。ここからクエリパラメータやHTTPメソッド、パスなどを取り出せます。書き方は以下のとおりです。

まず、クエリパラメータの値は r.URL.Query().Get で取得します。存在しないキーの場合は空文字列が返ります。

r.URL.Query().Get("キー名")

続いて、HTTPメソッドは r.Method から取り出します。

r.Method

最後に、URLのパスは r.URL.Path から取り出します。

r.URL.Path

main.go を以下の内容で置き換えて保存します。これは、/query にアクセスすると、URL のクエリパラメータ・HTTP メソッド・パスの3つを取り出して表示するコードです。

package main

import (
    "fmt"
    "net/http"
)

func query(w http.ResponseWriter, r *http.Request) {
    name := r.URL.Query().Get("name")
    method := r.Method
    path := r.URL.Path

    fmt.Fprintf(w, "path=%s method=%s name=%s\n", path, method, name)
}

func main() {
    http.HandleFunc("/query", query)

    fmt.Println("http://localhost:8080 で起動")
    http.ListenAndServe(":8080", nil)
}

既存のサーバが動いている場合は Ctrl+C で停止し、以下のコマンドで再起動します。

go run main.go

別のターミナルで以下のコマンドを実行します。

curl "http://localhost:8080/query?name=Taro"

以下のような実行結果が返ります。

path=/query method=GET name=Taro

パスは /query、メソッドは GET、クエリパラメータ name の値は Taro が取り出せていることが分かります。

コードを解説します。

name := r.URL.Query().Get("name")

r.URL.Query().Get("キー名") で、クエリパラメータ(URLの ? 以降)から指定したキーの値を取り出します。存在しないキーの場合は空文字列を返します。

method := r.Method
path := r.URL.Path

r.Method は HTTP メソッド(GET / POST など)、r.URL.Path は URL のパス(/query など)を返します。

3. リクエストボディの読み取り

POSTメソッドの場合、クライアントから送られたリクエストボディを *http.Request の r.Body から受け取れます。JSONボディをGoの構造体に読み込むときは、json.NewDecoder(r.Body).Decode(...) を使うのが一般的です。書き方は以下のとおりです。

json.NewDecoder(r.Body).Decode(&変数)   // リクエストボディのJSONを 変数 に読み込む

main.go を以下の内容で置き換えて保存します。ここでは、/body パスに、JSONボディを受け取って中身をそのまま返すハンドラを登録します。受け取ったJSON({"name":"...", "email":"..."} 形式)を RequestBody 構造体に読み込み、name と email の値をレスポンスに書き出します。

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
)

type RequestBody struct {
    Name  string `json:"name"`
    Email string `json:"email"`
}

func showBody(w http.ResponseWriter, r *http.Request) {
    var input RequestBody
    if err := json.NewDecoder(r.Body).Decode(&input); err != nil {
        http.Error(w, "JSONの解析に失敗", http.StatusBadRequest)
        return
    }
    fmt.Fprintf(w, "Bodyの値: name=%s email=%s\n", input.Name, input.Email)
}

func main() {
    http.HandleFunc("/body", showBody)

    fmt.Println("http://localhost:8080 で起動")
    http.ListenAndServe(":8080", nil)
}

既存のサーバが動いている場合は Ctrl+C で停止し、以下のコマンドで再起動します。

go run main.go

別のターミナルで -d オプションを付けてJSONボディをPOSTします。

curl -X POST -d '{"name":"Taro","email":"taro@example.com"}' http://localhost:8080/body

以下のような実行結果が表示されます。

Bodyの値: name=Taro email=taro@example.com

送信したJSONの name と email の値が読み取られ、Bodyの値: name=Taro email=taro@example.com の形でレスポンスに書き出されました。

コードを解説します。

if err := json.NewDecoder(r.Body).Decode(&input); err != nil {
    http.Error(w, "JSONの解析に失敗", http.StatusBadRequest)
    return
}

json.NewDecoder(r.Body) はリクエストボディを読み取るJSONデコーダを作ります。.Decode(&input) で JSON を input(RequestBody 構造体)に読み込みます。失敗した場合は http.Error で 400 Bad Request を返します。

http.Error はエラーメッセージとステータスコードを設定して即座にレスポンスを返す関数で、エラー処理の定型パターンです。