(cache) Go言語 Web フレームワークはこれを使おう 2016年12月版

この記事は Qiita Advent Calendar 2016 Go (その2) 10日目の記事です。

Go言語の Web アプリケーションフレームワーク (以下、Web フレームワーク) は、群雄割拠の時代を経てわずかばかりまとまってきた印象があります。今回、Go言語の Web フレームワークを選定するさいの参考になればと思い、あらためていくつかのフレームワークの特長や最近の動向をまとめました。

結論

現時点では iris または Echo の選択をおすすめします。

選定と推薦の根拠

主観
GitHub Trending, Star, Issue
プロダクトでの使用経験 (Gin, Echo)

現在、株式会社ユーリエのプロダクト eurie Desk 開発における主たる言語として Go言語を利用しています。プロダクション環境での利用をつうじて得た知見を判断材料の1つにしています。

今回の候補一覧

他にも伝統的なパッケージがいくつか存在しますが、開発の状況やその他理由により選外としました。

前提として RESTful API (以下、REST API) の実装に採用することを念頭に置いていますので、HTML Template Engine に関連した情報は登場しません。掲載していないものがよくないというわけではありませんのであしからず。

Gin

github.com

Gin は古くから人気のあったパッケージの1つです。一時期開発が停滞していましたが Contributor 増員後はそこそこの頻度で開発が続いています。Microframework ながらかゆいところに手が届く実装で、Echo や iris の機能開発の参考にされていた印象があります。

REST API の Request Body を Struct に Bind するさい、Struct に定義した binding タグの内容にもとづき値の Validation を行うが特長です。

type User struct {
    Name  string `json:"name" binding:"required"`
    Age   uint   `json:"age" binding:"gte=0,lte=130"`
    Email string `json:"email" binding:"required,email"`
}

上記の Struct を以下のように利用します。

func PostUser(c *gin.Context) {

    user := new(model.User)
    if err := c.BindJSON(user); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"message": err.Error()})
        return
    }

    c.JSON(http.StatusCreated, gin.H{"status": "ok"})
}

以下の JSON を POST で送付します。

{
    "name" : "Your Name.",
    "age": 30,
    "email": "invalid.com"
}

この場合 Email の書式が不正なためエラー "Key: 'User.Email' Error:Field validation for 'Email' failed on the 'email' tag" が生じます。

処理としては go-playground/validator を利用しているというシンプルなアプローチです。Gin を利用しない場合でもこの実装は参考になると思います。

// https://github.com/gin-gonic/gin/blob/master/binding/json.go#L19
func (jsonBinding) Bind(req *http.Request, obj interface{}) error {
    decoder := json.NewDecoder(req.Body)
    if err := decoder.Decode(obj); err != nil {
        return err
    }
    return validate(obj)
}

Validation に関する補足

ところで、Struct の binding タグによる Validation を行う場合には、以下の課題があります。結論からいうと、ある程度の規模以上のアプリケーションではこの方法の採用はおすすめできません。

可読性が悪い
タグは build 時に Check されないためミスのもとになる
- go vet で検出する方法はあります*1
POST/PUT で Struct を共有する場合かつ Validation の内容が異なる場合、複数タグを付与して使い分けるなど更に可読性が悪くなる
- 僕が以前取り入れていた方法*2はあまりよくありませんでした

Model の構造や Validation の要件がごく単純な場合には手軽に利用できます。

Echo

Echo は、Gin の開発停滞期に人気が急上昇した印象のある Web フレームワークです。公式サイトのドキュメントが詳しく、Web アプリの汎用的な課題を解決できるミドルウェアがバンドルされています。

echo.labstack.com

たとえば、Cross-Origin Resource Sharing の設定を行える CORS Middleware) や、Request Header に含まれる JWT を Parse する JWT Middleware などが便利なミドルウェアの一例です。

ミドルウェアに関する補足

ミドルウェアの実装と活用は Echo に限った話ではないのですが、ここで補足しておきます。典型的な汎用処理は、データベースのトランザクションの管理です。

const (
    TxKey = "Tx"
)

func TransactionHandler(db *sql.DB) echo.MiddlewareFunc {
    return func(next echo.HandlerFunc) echo.HandlerFunc {
        return echo.HandlerFunc(func(c echo.Context) error {
            tx, _ := db.Begin()

            c.Set(TxKey, tx) // echo.Context にトランザクションの pointer をセットして、後続の処理の中で取り出せるようにしています

            if err := next(c); err != nil {
                tx.Rollback() // このミドルウェア以後でエラーが発生した場合はロールバックします
                return err
            }
            helper.Logger.Debug("Transaction has been committed.")
            tx.Commit() // エラーが発生しなかった場合はコミットします

            return nil
        })
    }
}

実装したミドルウェアを、以下のようにセットします。

e := echo.New()
e.Use(middleware.TransactionHandler())

e.POST("/users", api.PostUser())
e.PUT("/users/:id", api.PutUser())

このようにしておくとすべてのエンドポイントが 1 Request = 1 Transaction で管理されます*3。

ロギングや認証周り、例外発生後の共通処理などをミドルウェアとして実装しておくとコアロジックの実装に集中できるようになります。

iris

github.com

iris は非常に開発が活発な Web フレームワークで、GitHub の Trending にもたびたび登場していた時期がありました。比較的後発ですがバージョンが 5.0 まであがっています。ベンチマーク最速をうたっている*6のが特長でしょうか。後発らしく (?) Go の v1.7 以上が動作要件です。

GitBook で書かれた丁寧なドキュメントが用意されていることも特長の1つです。

Introduction · Iris

また、サンプル集が多く用意されています。

github.com

Echo も充分にドキュメントが揃っていますが、iris はさらに充実している印象です。このドキュメントに書かれているコードををひととおり動作させることで、いくつかの重要な要素技術 (例えば CORS やセキュリティに関する HTTP Header の仕様についてなど) についても触れることができます。そうした観点から、REST API を初めて実装してみようとされているかたにも iris はおすすめできるかも知れません。ただし日本語情報はほぼ皆無と言えますのでその点は気にとめておいてください。

まとめ

今回取り上げた 3つの Web フレームワークはいずれも癖がなく使いやすいものです。もしも将来的に移行の必要が生じた場合でも、現実的なコストで行える程度だと考えています。いずれを選んでも宜しいと思いますが、結論で述べたとおり、ドキュメントの充実度や継続可能性も踏まえ今回は Echo と iris をおすすめ Web フレームワークとしました。

Go 言語のエコシステムは現在成長著しく、じつにさまざまな OSS パッケージが日々登場しています。Web フレームワークの勢力図が半年後にまたどのように変化しているか楽しみです。