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支持
• 快速的服务器端编程
• Template engines
• WebSocket support
• Rate Limiter
• 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

📖 https://docs.gofiber.io/#basic-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://docs.gofiber.io/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://docs.gofiber.io/routing#middleware
📖 https://docs.gofiber.io/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()
  })

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

  app.Listen(3000)
}

📚 Show more code examples

Template engines

📖 https://docs.gofiber.io/application#settings
📖 https://docs.gofiber.io/context#render
📖 https://docs.gofiber.io/middleware#template

Fiber supports the default Go template engine

But if you want to use another template engine like amber, handlebars, mustache or pug.

You can use our Template Middleware.

package main

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

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

  // OR after initiation app at any convenient location:
  app.Settings.TemplateEngine = template.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://docs.gofiber.io/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://docs.gofiber.io/middleware#logger

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

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

    // Optional logger config
    config := logger.Config{
      Format:     "${time} - ${method} ${path}\n",
      TimeFormat: "Mon, 2 Jan 2006 15:04:05 MST",
    }

    // Logger with config
    app.Use(logger.New(config))

    app.Listen(3000)
}

Cross-Origin Resource Sharing (CORS)

📖 https://docs.gofiber.io/middleware#cors

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

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

    // CORS with default config
    app.Use(cors.New())

    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

📖 https://docs.gofiber.io/application#http-methods

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://docs.gofiber.io/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 Upgrade

📖 https://docs.gofiber.io/middleware#websocket

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

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

  app.Get("/ws", websocket.New(func(c *websocket.Conn) {
    for {
      mt, msg, err := c.ReadMessage()
      if err != nil {
        log.Println("read:", err)
        break
      }
      log.Printf("recv: %s", msg)
      err = c.WriteMessage(mt, msg)
      if err != nil {
        log.Println("write:", err)
        break
      }
    }
  }))

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

Recover middleware

📖 https://docs.gofiber.io/middleware#recover

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

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

  // Optional recover config
  config := recover.Config{
    Handler: func(c *fiber.Ctx, err error) {
			c.SendString(err.Error())
			c.SendStatus(500)
		},
  }

  // Logger with custom config
  app.Use(recover.New(config))

  app.Listen(3000)
}

💬 媒体

• Welcome to Fiber — an Express.js styled web framework written in Go with ❤️ — 03 Feb 2020
• Fiber released v1.7! 🎉 What's new and is it still fast, flexible and friendly? — 21 Feb 2020
• 🚀 Fiber v1.8. What's new, updated and re-thinked? — 03 Mar 2020
• Is switching from Express to Fiber worth it? 🤔 — 01 Apr 2020
• Creating Fast APIs In Go Using Fiber — 07 Apr 2020

👍 贡献

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

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

☕ Coffee Supporters

Thomas van Vugt

Ray Mayemir

melkorm

Eka Putra

Henrik Binggl

Vic Shóstak

MarvinJWendt

ToishY

JustDave

melkorm

ekaputra07

‎‍💻 Code Contributors

⚠️ License

Copyright (c) 2019-present Fenny and Fiber Contributors. Fiber is free and open-source software licensed under the MIT License. Official logo was created by Vic Shóstak and distributed under Creative Commons license (CC BY-SA 4.0 International).