fiber/.github/README_zh-CN.md

Fiber是一个基于Express的 Web框架，建立在Go语言写的 最快的FasthttpHTTP引擎的基础上。皆在简化 零内存分配和提高性能，以便快速开发。

⚡️ 快速入门

package main

import "github.com/gofiber/fiber"

func main() {
  app := fiber.New()

  app.Get("/", func(c *fiber.Ctx) {
    c.Send("Hello, World!")
  })

  app.Listen(3000)
}

⚙️ 安装

首先， 下载并安装Go。 1.11或更高。

使用go get命令完成安装：

export GO111MODULE=on
export GOPROXY=https://goproxy.cn

go get -u github.com/gofiber/fiber

🤖 性能

这些测试由TechEmpower和Go Web执行 。如果要查看所有结果，请访问我们的Wiki 。

🎯 特点

• 强大的路由
• 静态文件服务
• 极限表现
• 内存占用低
• Express API端点
• 中间件和Next支持
• 快速的服务器端编程
• Available in 10 languages
• 以及更多文档

💡 哲学

从Node.js切换到Go的新gopher在开始构建Web应用程序或微服务之前正在应对学习过程。 Fiber作为一个Web框架 ，是按照极简主义的思想并遵循UNIX方式创建的，因此新的gopher可以以热烈和可信赖的欢迎方式迅速进入Go的世界。

Fiber 受 Internet上最流行的Web框架Expressjs的启发 。我们结合了Express的易用性和Go的原始性能 。如果您曾经在Node.js上实现过Web应用程序(使用Express.js或类似工具)，那么许多方法和原理对您来说似乎非常易懂。

👀 示例

下面列出了一些常见示例。如果您想查看更多代码示例，请访问我们的Recipes存储库或访问我们的API文档 。

Routing

func main() {
  app := fiber.New()

  // GET /john
  app.Get("/:name", func(c *fiber.Ctx) {
    fmt.Printf("Hello %s!", c.Params("name"))
    // => Hello john!
  })

  // GET /john
  app.Get("/:name/:age?", func(c *fiber.Ctx) {
    fmt.Printf("Name: %s, Age: %s", c.Params("name"), c.Params("age"))
    // => Name: john, Age:
  })

  // GET /api/register
  app.Get("/api*", func(c *fiber.Ctx) {
    fmt.Printf("/api%s", c.Params("*"))
    // => /api/register
  })

  app.Listen(3000)
}

Serve static files

https://fiber.wiki/application#static

func main() {
  app := fiber.New()

  app.Static("/", "/public")
  // => http://localhost:3000/js/script.js
  // => http://localhost:3000/css/style.css

  app.Static("/prefix", "/public")
  // => http://localhost:3000/prefix/js/script.js
  // => http://localhost:3000/prefix/css/style.css

  app.Static("*", "/public/index.html")
  // => http://localhost:3000/any/path/shows/index/html

  app.Listen(3000)
}

Middleware & Next

https://fiber.wiki/routing#middleware https://fiber.wiki/context#next

func main() {
  app := fiber.New()

  // Match any route
  app.Use(func(c *fiber.Ctx) {
    fmt.Println("First middleware")
    c.Next()
  })

  // Match all routes starting with /api
  app.Use("/api", func(c *fiber.Ctx) {
    fmt.Println("Second middleware")
    c.Next()
  })

  // POST /api/register
  app.Post("/api/register", func(c *fiber.Ctx) {
    fmt.Println("Last middleware")
    c.Send("Hello, World!")
  })

  app.Listen(3000)
}

📚 Show more code examples

Template engines

https://fiber.wiki/application#settings https://fiber.wiki/context#render

Supported engines:

• html
• amber
• handlebars
• mustache
• pug

func main() {
  // You can setup template engine before initiation app:
  app := fiber.New(&fiber.Settings{
    TemplateEngine:    "mustache",
    TemplateFolder:    "./views",
    TemplateExtension: ".tmpl",
  })

  // OR after initiation app at any convenient location:
  app.Settings.TemplateEngine = "mustache"
  app.Settings.TemplateFolder = "./views"
  app.Settings.TemplateExtension = ".tmpl"

  // And now, you can call template `./views/home.tmpl` like this:
  app.Get("/", func(c *fiber.Ctx) {
    c.Render("home", fiber.Map{
      "title": "Homepage",
      "year":  1999,
    })
  })

  // ...
}

Grouping routes into chains

https://fiber.wiki/application#group

func main() {
  app := fiber.New()

  // Root API route
  api := app.Group("/api", cors())  // /api

  // API v1 routes
  v1 := api.Group("/v1", mysql())   // /api/v1
  v1.Get("/list", handler)          // /api/v1/list
  v1.Get("/user", handler)          // /api/v1/user

  // API v2 routes
  v2 := api.Group("/v2", mongodb()) // /api/v2
  v2.Get("/list", handler)          // /api/v2/list
  v2.Get("/user", handler)          // /api/v2/user

  // ...
}

Middleware logger

https://fiber.wiki/middleware#logger

import (
    "github.com/gofiber/fiber"
    "github.com/gofiber/fiber/middleware"
)

func main() {
    app := fiber.New()
    
    // If you want to change default Logger config
    loggerConfig := middleware.LoggerConfig{
      Format:     "${time} - ${method} ${path}\n",
      TimeFormat: "Mon, 2 Jan 2006 15:04:05 MST",
    }

    // Middleware for Logger with config
    app.Use(middleware.Logger(loggerConfig))

    // ...
}

Cross-Origin Resource Sharing (CORS)

https://fiber.wiki/middleware#cors

CORS is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.

import (
    "github.com/gofiber/fiber"
    "github.com/gofiber/fiber/middleware"
)

func main() {
    app := fiber.New()

    // Connect CORS for each route as middleware
    app.Use(middleware.CORS())

    app.Get("/", func(c *fiber.Ctx) {
        c.Send("CORS is enabled!")
    })

    app.Listen(3000)
}

Check CORS by passing any domain in Origin header:

curl -H "Origin: http://example.com" --verbose http://localhost:3000

Custom 404 response

func main() {
  app := fiber.New()

  app.Static("/public")

  app.Get("/demo", func(c *fiber.Ctx) {
    c.Send("This is a demo!")
  })

  app.Post("/register", func(c *fiber.Ctx) {
    c.Send("Welcome!")
  })

  // Last middleware to match anything
  app.Use(func(c *fiber.Ctx) {
    c.SendStatus(404) // => 404 "Not Found"
  })

  app.Listen(3000)
}

JSON Response

https://fiber.wiki/context#json

type User struct {
  Name string `json:"name"`
  Age  int    `json:"age"`
}

func main() {
  app := fiber.New()

  app.Get("/user", func(c *fiber.Ctx) {
    c.JSON(&User{"John", 20})
    // {"name":"John", "age":20}
  })

  app.Get("/json", func(c *fiber.Ctx) {
    c.JSON(&fiber.Map{
			"success": true,
			"message": "Hi John!",
    })
    // {"success":true, "message":"Hi John!"}
  })

  app.Listen(3000)
}

WebSocket support

https://fiber.wiki/application#websocket

func main() {
  app := fiber.New()

  app.WebSocket("/ws", func(c *fiber.Conn) {
    for {
      mt, msg, err := c.ReadMessage()
      if err != nil {
        log.Println("read:", err)
        break
      }

      log.Printf("recovery: %s", msg)

      err = c.WriteMessage(mt, msg)
      if err != nil {
        log.Println("write:", err)
        break
      }
    }
  })

  // Listen on ws://localhost:3000/ws
  app.Listen(3000)
}

Recover middleware

https://fiber.wiki/middleware#recover

package main

import (
    "github.com/gofiber/fiber"
    "github.com/gofiber/fiber/middleware"
)

func main() {
  app := fiber.New()

  app.Use(middleware.Recover(func(c *fiber.Ctx, err error) {
    log.Println(err)  // "Something went wrong!"
    c.SendStatus(500) // Internal Server Error
  })))
  
  app.Get("/", func(c *fiber.Ctx) {
    panic("Something went wrong!")
  })

  app.Listen(3000)
}

💬 媒体

• 欢迎使用Fiber —用Go语言编写的Express.js风格的Web框架 ❤️ 作者维克·肖斯塔克(VicShóstak)，2020年2月3日
• Fiber 1.7 已经发布! 🎉 他仍然快速、灵活且友善 *作者维克·肖斯塔克(VicShóstak), 2020年2月21日)
• 🚀 Fiber v1.8. What's new, updated and re-thinked? (by Vic Shóstak, 03 Mar 2020)

👍 贡献

如果您要说声谢谢或支持Fiber的积极发展：

1. 将GitHub Star添加到项目中。
2. 在Twitter上发布有关项目的推文。
3. 在Medium，Dev.to或个人博客上写评论或教程。
4. 帮助我们将此README文件翻译成其它语言。

☕ Supporters

HenrikBinggl

Vic Shóstak

MarvinJWendt

ToishY

JustDave

⭐️ 星星

⚠️ 许可证

Fiber是根据MIT许可证许可的免费开源软件。Official logotype was created by Vic Shóstak and distributed under Creative Commons license (CC BY-SA 4.0 International).