echo-v4中文文档（1）概述

本站原创翻译

快速开始

安装

安装Echo需要Go v1.13或更高版本。Go v1.12版的支持有限，一些中间件将无法使用。
请确保你的项目文件夹在你的$GOPATH之外。

$ mkdir myapp && cd myapp
$ go mod init myapp
$ go get github.com/labstack/echo/v4

如果你使用的是Go v1.14或更早的版本，请使用：

$ GO111MODULE=on go get github.com/labstack/echo/v4

你好世界！

创造server.go

package main

import (
    "net/http"

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

func main() {
    e := echo.New()
    e.GET("/", func(c echo.Context) error {
        return c.String(http.StatusOK, "Hello, World!")
    })
    e.Logger.Fatal(e.Start(":1323"))
}

启动服务器

$ go run server.go

浏览到http://localhost:1323，您应该会看到 Hello, World! 在页面上。

路由

e.POST("/users", saveUser)
e.GET("/users/:id", getUser)
e.PUT("/users/:id", updateUser)
e.DELETE("/users/:id", deleteUser)

路径参数

// e.GET("/users/:id", getUser)
func getUser(c echo.Context) error {
    // User ID from path `users/:id`
    id := c.Param("id")
    return c.String(http.StatusOK, id)
}

浏览到 http://localhost:1323/users/Joe
您应该会在页面上看到“Joe”。

查询参数

/show?team=x-men&member=wolverine

//e.GET("/show", show)
func show(c echo.Context) error {
    // Get team and member from the query string
    team := c.QueryParam("team")
    member := c.QueryParam("member")
    return c.String(http.StatusOK, "team:" + team + ", member:" + member)
}

浏览到 http://localhost:1323/show?team=x-men&member=wolverine，
您应该会在页面上看到“team:x-men, member:wolverine”。

application/x-www-form-urlencoded

POST /save

// e.POST("/save", save)
func save(c echo.Context) error {
    // Get name and email
    name := c.FormValue("name")
    email := c.FormValue("email")
    return c.String(http.StatusOK, "name:" + name + ", email:" + email)
}

运行以下命令：

$ curl -d "name=Joe Smith" -d "email=joe@labstack.com" http://localhost:1323/save
// => name:Joe Smith, email:joe@labstack.com

multipart/form-data

POST /save

func save(c echo.Context) error {
    // Get name
    name := c.FormValue("name")
    // Get avatar
    avatar, err := c.FormFile("avatar")
    if err != nil {
        return err
    }

    // Source
    src, err := avatar.Open()
    if err != nil {
        return err
    }
    defer src.Close()

    // Destination
    dst, err := os.Create(avatar.Filename)
    if err != nil {
        return err
    }
    defer dst.Close()

    // Copy
    if _, err = io.Copy(dst, src); err != nil {
        return err
    }

    return c.HTML(http.StatusOK, "<b>Thank you! " + name + "</b>")
}

运行以下命令。

$ curl -F "name=Joe Smith" -F "avatar=@/path/to/your/avatar.png" http://localhost:1323/save
// => <b>Thank you! Joe Smith</b>

要检查上传的图像，请运行以下命令。

cd <project directory>
ls avatar.png
// => avatar.png

处理请求

• 根据请求标头将json、xml或payload 绑定到 Go 结构中 。formqueryContent-Type
• 将响应呈现为json或xml带有状态代码。

type User struct {
    Name  string `json:"name" xml:"name" form:"name" query:"name"`
    Email string `json:"email" xml:"email" form:"email" query:"email"`
}

e.POST("/users", func(c echo.Context) error {
    u := new(User)
    if err := c.Bind(u); err != nil {
        return err
    }
    return c.JSON(http.StatusCreated, u)
    // or
    // return c.XML(http.StatusCreated, u)
})

静态内容

为路径/static/*提供静态文件服务。

e.Static("/static", "static")

中间件

// Root level middleware
e.Use(middleware.Logger())
e.Use(middleware.Recover())

// Group level middleware
g := e.Group("/admin")
g.Use(middleware.BasicAuth(func(username, password string, c echo.Context) (bool, error) {
  if username == "joe" && password == "secret" {
    return true, nil
  }
  return false, nil
}))

// Route level middleware
track := func(next echo.HandlerFunc) echo.HandlerFunc {
    return func(c echo.Context) error {
        println("request to /users")
        return next(c)
    }
}
e.GET("/users", func(c echo.Context) error {
    return c.String(http.StatusOK, "/users")
}, track)

80%的人都看过的文章

• echo-v4中文文档（2）定制化