Go Iris 初心者向けガイド

Go Iris Web Frameworkのはじめ方

インストール

注意：Goバージョン1.20以上が必要です。

$ mkdir myapp
$ cd myapp
$ go mod init myapp
$ go get github.com/kataras/iris/v12@latest

コードにインポートします:

import "github.com/kataras/iris/v12"

インストールのトラブルシューティング

インストール中にネットワークエラーが発生した場合は、GOPROXY環境変数が有効な値に設定されていることを確認してください。

go env -w GOPROXY=https://goproxy.io,direct

上記の方法で問題が解決しない場合、goモジュールキャッシュをクリアしてください:

go clean --modcache

クイックスタート

関数モード

$ cat main.go

package main

import "github.com/kataras/iris/v12"

func main() {
    // irisのインスタンスを定義
    app := iris.New()

    // ルートグループを定義します（ここでは/booksプレフィックスを持つルートグループを定義）
    booksAPI := app.Party("/books")
    {
        // ミドルウェアを使用
        booksAPI.Use(iris.Compression)

        // ルートとルートハンドラを設定
        // GET: http://localhost:8080/books
        booksAPI.Get("/", list)
        // POST: http://localhost:8080/books
        booksAPI.Post("/", create)
    }

    // ポートでリッスン
    app.Listen(":8080")
}

// 書籍の例.
type Book struct {
    Title string `json:"title"`
}

func list(ctx iris.Context) {
    books := []Book{
        {"Mastering Concurrency in Go"},
        {"Go Design Patterns"},
        {"Black Hat Go"},
    }

    ctx.JSON(books)
    // 注意: サーバーとクライアントの優先度に基づいたレスポンスの交渉
   // ctx.JSONの代わりに以下を使用:
   // ctx.Negotiation().JSON().MsgPack().Protobuf()
   // ctx.Negotiate(books)
}

func create(ctx iris.Context) {
    var b Book
    err := ctx.ReadJSON(&b)
    // 注意: 任意のタイプの受信データをバインドするにはctx.ReadBody(&b)を使用します。
    if err != nil {
        ctx.StopWithProblem(iris.StatusBadRequest, iris.NewProblem().
            Title("Failed to create book").DetailErr(err))
        // 注意: エラーが発生した場合は、プレーンテキストのレスポンスのみを期待する場合はctx.StopWithError(code, err)を使用してください。
        return
    }

    println("Received book: " + b.Title)

    ctx.StatusCode(iris.StatusCreated)
}

MVCアーキテクチャパターン

MVCパッケージをインポートする

import "github.com/kataras/iris/v12/mvc"

ルートグループに基づいてコントローラーを設定する

m := mvc.New(booksAPI)
m.Handle(new(BookController))

コントローラーの実装

type BookController struct {
    /* 依存性注入 */
}

// GETに応答: http://localhost:8080/books
func (c *BookController) Get() []Book {
    return []Book{
        {"Mastering Go Concurrency"},
        {"Go Design Patterns"},
        {"Black Hat Go"},
    }
}

// POSTに応答: http://localhost:8080/books
func (c *BookController) Post(b Book) int {
    println("Received book: " + b.Title)

    return iris.StatusCreated
}

Iris Webサーバーを実行する：

$ go run main.go
> Listening on: http://localhost:8080
> アプリケーションが開始されました。終了するにはCTRL+Cを押してください。

書籍をリストする：

$ curl --header 'Accept-Encoding:gzip' http://localhost:8080/books

[
  {
    "title": "Mastering Go Concurrency"
  },
  {
    "title": "Go Design Patterns"
  },
  {
    "title": "Black Hat Go"
  }
]

新しい書籍を作成する：

$ curl -i -X POST \
--header 'Content-Encoding:gzip' \
--header 'Content-Type:application/json' \
--data "{\"title\":\"Writing an Interpreter in Go\"}" \
http://localhost:8080/books

> HTTP/1.1 201 Created

これはエラー応答の例です：

$ curl -X POST --data "{\"title\" \"Invalid Book\"}" \
http://localhost:8080/books

> HTTP/1.1 400 Bad Request

{
  "status": 400,
  "title": "Book creation failed",
  "detail": "invalid character '\"' after object key"
}