[Go 言語]EchoでQueryStringをパースする方法

はじめに

Go 言語は、その高速性と効率性から、Web アプリケーションの開発に非常に適したプログラミング言語です。Go 言語の Web アプリケーション開発において、 Echo フレームワークは軽量かつ強力なツールとして広く使用されています。この記事では、 Echo を使用してクエリ文字列（QueryString）をパースし、 Web アプリケーションでその値を取得する方法を解説します。

The Go Programming Language

Go is an open source programming language that makes it simp...

go.dev

High performance, extensible, minimalist Go web framework | Echo

Echo is a high-performance web framework for building robust...

echo.labstack.com

Echo フレームワークの概要

Echo は、非常にシンプルで使いやすい Go 言語用のWebフレームワークです。パフォーマンスに優れ、直感的な API を提供しており、小規模から大規模なアプリケーションまで幅広く対応できます。

まず、 Echo をインストールする方法を紹介します。

Echo のインストール

Go Modules を使用しているプロジェクトでは、以下のコマンドで Echo をインストールできます。

go get -u github.com/labstack/echo/v4

インストールが完了したら、 Echo を使って Web アプリケーションを開発していきましょう。

クエリ文字列（QueryString）とは？

クエリ文字列とは、URL の末尾に付加されるパラメータのことです。たとえば、以下のURLでは、nameとageがクエリパラメータです。

http://example.com/search?name=John&age=30

このクエリ文字列をパースして、nameやageの値を取得することが、 Web アプリケーション開発ではよく必要になります。

Echo での QueryString のパース方法

Echo を使ってクエリ文字列をパースするのは非常に簡単です。以下に、その具体的な方法を紹介します。

1. 基本的なクエリパラメータの取得

以下のコード例では、クエリ文字列からnameとageというパラメータを取得しています。

package main

import (
    "net/http"

    "github.com/labstack/echo/v4"
)

func main() {
    e := echo.New()

    // ルートハンドラーを定義
    e.GET("/search", func(c echo.Context) error {
        // QueryStringのパラメータを取得
        name := c.QueryParam("name")
        age := c.QueryParam("age")

        // レスポンスを返す
        return c.String(http.StatusOK, "Name: " + name + ", Age: " + age)
    })

    // サーバーをポート8080で起動
    e.Start(":8080")
}

このコードでは、/searchエンドポイントに対するGETリクエストが処理されます。例えば、以下のURLにアクセスすると、

http://localhost:8080/search?name=John&age=30

ブラウザにはName: John, Age: 30と表示されます。

2. デフォルト値の設定

もしクエリパラメータが指定されていない場合に、デフォルト値を設定したい場合があります。これも簡単に実現できます。

e.GET("/search", func(c echo.Context) error {
    name := c.QueryParam("name")
    if name == "" {
        name = "Guest"
    }

    age := c.QueryParam("age")
    if age == "" {
        age = "0"
    }

    return c.String(http.StatusOK, "Name: " + name + ", Age: " + age)
})

これで、nameやageが指定されていない場合に、それぞれGuestと0がデフォルトで使用されます。

3. 複数の値を取得

クエリパラメータには、同じキーに対して複数の値が指定される場合もあります。Echoでは、これらの値をスライスとして取得することができます。

e.GET("/search", func(c echo.Context) error {
    tags := c.QueryParams()["tag"]

    response := "Tags: "
    for _, tag := range tags {
        response += tag + " "
    }

    return c.String(http.StatusOK, response)
})

例えば、以下のURLにアクセスすると、

http://localhost:8080/search?tag=golang&tag=echo&tag=web

ブラウザにはTags: golang echo web と表示されます。

4. 全てのクエリパラメータを取得

全てのクエリパラメータをマップとして取得したい場合もあるでしょう。その場合は、QueryParamsメソッドを使用します。

e.GET("/search", func(c echo.Context) error {
    queryParams := c.QueryParams()

    response := "Query Parameters:\n"
    for key, values := range queryParams {
        response += key + ": " + values[0] + "\n"
    }

    return c.String(http.StatusOK, response)
})

まとめ

Go 言語の Echo フレームワークを使って、クエリ文字列（QueryString）をパースする方法を紹介しました。Echo の直感的なAPIを使うことで、 Web アプリケーションの開発が非常にシンプルかつ効率的になります。クエリパラメータを活用して、ユーザーからの入力を柔軟に処理する Web アプリケーションを開発してください。

参考書籍

• 「Go言語によるWebアプリケーション開発」 - Mat Ryer
• 「Go Programming Blueprints」 - Mat Ryer
• 「Hands-On Go Programming」 - Tarik Guney