Go Iris ルーティング

アイリスフレームワークには、ルートバインディングのための2つのモードがあります。1つは機能的なモードであり、もう1つはMVC（Model-View-Controller）モードです。機能的なモードでは、指定されたURLパスに対するハンドリング関数をバインドします。一方、MVCモードでは、コントローラをURLパスにバインドします。フレームワークは、コントローラメソッドの命名規則に基づいて対応するURLパスを自動的に生成し、対応するコントローラ関数を自動的にバインドします。

機能的なルートバインディング

アイリスフレームワークの中で最もシンプルなルーティングモデルであり、任意のURLに関数をバインドすることができます。

func main() {
    // デフォルトのミドルウェアを使用してアイリスアプリケーションを作成します。
    // デフォルトでは、"debug"ログレベルを使用します。
    // "./locales"ディレクトリに配置されたローカライゼーションをサポートします。
    // HTMLテンプレートは"./views"または"./templates"ディレクトリに配置されています。
    // アクセスログは"./access.log"に保存され、クラッシュせずにリカバリとリクエストIDのミドルウェアがすでにアタッチされています。
    app := iris.Default()

	// HTTPリクエストメソッドとパスに基づいて、簡単にルート関数をバインドします。これは、Ginやechoなどのフレームワークのルーティングメカニズムに似ています。
    app.Get("/someGet", getting)
    app.Post("/somePost", posting)
    app.Put("/somePut", putting)
    app.Delete("/someDelete", deleting)
    app.Patch("/somePatch", patching)
    app.Header("/someHead", head)
    app.Options("/someOptions", options)
    
	// ポートでリッスンします
    app.Listen(":8080")
}

パス内のパラメータ

func main() {
    app := iris.Default()

    // このハンドラは/user/johnにはマッチしますが、/user/や/userにはマッチしません
    app.Get("/user/{name}", func(ctx iris.Context) {
        name := ctx.Params().Get("name")
        ctx.Writef("こんにちは %s", name)
    })
    
    // しかしながら、このハンドラは/user/john/や/user/john/sendにはマッチします
    // /user/johnに他のルートがマッチしない場合、/user/john/にリダイレクトされます
    app.Get("/user/{name}/{action:path}", func(ctx iris.Context) {
        name := ctx.Params().Get("name")
        action := ctx.Params().Get("action")
        message := name + "は" + action
        ctx.WriteString(message)
    })
    
    // 一致するリクエストごとに、Contextはルート定義を保持します
    app.Post("/user/{name:string}/{action:path}", func(ctx iris.Context) {
        ctx.GetCurrentRoute().Tmpl().Src == "/user/{name:string}/{action:path}" // true
    })
    
    app.Listen(":8080")
}

利用可能な組み込みパラメータの種類:

グループルーティング

時には、APIバージョン管理が必要な場合や、大規模なモジュールのルーティングに統一された接頭辞を設定する必要があります。このような場合には、グループルーティングの機能が必要となります。

func main() {
    app := iris.Default()

    // シンプルなグループ: v1
    v1 := app.Party("/v1")
    {
        v1.Post("/login", loginEndpoint)
        v1.Post("/submit", submitEndpoint)
        v1.Post("/read", readEndpoint)
    }
    
    // シンプルなグループ: v2
    v2 := app.Party("/v2")
    {
        v2.Post("/login", loginEndpoint)
        v2.Post("/submit", submitEndpoint)
        v2.Post("/read", readEndpoint)
    }
    
    app.Listen(":8080")
}

MVC ルーティング

GoのIrisフレームワークはMVCアーキテクチャをサポートし、特定のルールに従ってルートを特定のコントローラー関数にマッピングします。

package main

import (
	"strings"
	"github.com/kataras/iris/v12"
	"github.com/kataras/iris/v12/middleware/logger"
	"github.com/kataras/iris/v12/middleware/recover"
	"github.com/kataras/iris/v12/mvc"
)

// Irisアプリケーションを作成する
func newApp() *iris.Application {
	app := iris.New()
	// 2つのミドルウェアを設定
	// recoverはパニックエラーを傍受して異常なプログラム終了を回避するために使用されます
	// loggerはリクエストをログに記録するために使用されます
	app.Use(recover.New())
	app.Use(logger.New())

	// コントローラーを"/"ルートルートに登録
	mvc.New(app).Handle(new(ExampleController))
	
	// ルートグループを利用して特定のパスに登録することもできます
	// 例: /booksの下にコントローラーを登録
	// mvc.New(app.Party("/books")).Handle(new(ExampleController))
}

func main() {
	// アプリケーションを作成
	app := newApp()

	// http://localhost:8080
	// http://localhost:8080/ping
	// http://localhost:8080/hello
	// http://localhost:8080/custom_path
	app.Listen(":8080")
}

// "/"、"/ping"、および"/hello"のリクエストを処理するためのExampleControllerを定義します。
type ExampleController struct{}

// GETリクエストを処理
// リクエストURL: http://localhost:8080
func (c *ExampleController) Get() mvc.Result {
	return mvc.Response{
		ContentType: "text/html",
		Text:        "<h1>ようこそ</h1>",
	}
}

// GetPing です
// メソッド:   GET
// リクエストURL: http://localhost:8080/ping
func (c *ExampleController) GetPing() string {
	return "pong"
}

// GetHello です
// メソッド:   GET
// リクエストURL: http://localhost:8080/hello
func (c *ExampleController) GetHello() interface{} {
	return map[string]string{"message": "こんにちは、アイリス！"}
}

// GetHelloWorld です
// メソッド:   GET
// リクエストURL: http://localhost:8080/hello/world
func (c *ExampleController) GetHelloWorld() interface{} {
	return map[string]string{"message": "こんにちは、アイリス！DefaultPath"}
}

MVCルーティングとコントローラー関数の命名規則の関係。

ルートアドレス: ルートグループ + HTTPメソッド名 + 関数名（小文字）

例:

func (c *ExampleController) GetPing() string {
	return "pong"

ルートグループが設定されていないため、この関数はhttp://localhost:8080/pingのGETリクエストを処理できます。