fiber/.github/README_zh-TW.md

Fiber是移植NodeJS的Express框架改以Go語言編寫。本套件基於Fasthttp，Fasthttp有不分配記憶體空間和Request Pool的特性，在網路效能方面有著顯著的效能。

⚡️ 快速入門

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)
}

🤖 效能

本測試使用TechEmpower和Go Web框架效能測試。如果要看全部的執行結果，請到Wiki 。

⚙️ 安裝

第一步， 下載並安裝Go。 請使用1.11以上版本。

下指令go get下載套件：

go get -u github.com/gofiber/fiber

🎯 功能

• 強大的路由
• 靜態檔案服務
• 超快速
• 佔用很少記憶體
• 支援Express的API
• 支援中介器和下一步
• 立即上手
• 樣板引擎
• 支援WebSocket
• 支援限速
• 被翻譯成[15]國語言(https://docs.gofiber.io/)
• 豐富的文件

💡 理念

不少Node.js的工程師跳到Go必須學習一些知識，因此做了一個跟Express一樣的Fiber省這些麻煩。設計還是照原本的極簡主義還有遵循UNIX慣例，因此新手們可以無痛迅速進入Go的世界。

Fiber 受到 網路上最流行的Web框架ExpressJS啟發，結合Express的易用性和Go的高效能。若你之前用過Node.js寫Web應用(使用ExpressJS/Koa或類似工具)，那你已經上手了。

有什麼問題請發issues或加入Discord channel討論，我們想要創造快速、彈性、友善的社群給任何人使用！就像Express那樣。

👀 範例

以下是一些常見範例。

更多程式碼在範例專案中或直接看API文件。

📖 Basic Routing

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

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

  // GET /john/75
  app.Get("/:name/:age/:gender?", func(c *fiber.Ctx) {
    msg := fmt.Sprintf("👴 %s is %s years old", c.Params("name"), c.Params("age"))
    c.Send(msg) // => 👴 john is 75 years old
  })

  // GET /dictionary.txt
  app.Get("/:file.:ext", func(c *fiber.Ctx) {
    msg := fmt.Sprintf("📃 %s.%s", c.Params("file"), c.Params("ext"))
    c.Send(msg) // => 📃 dictionary.txt
  })

  // GET /flights/LAX-SFO
  app.Get("/flights/:from-:to", func(c *fiber.Ctx) {
    msg := fmt.Sprintf("💸 From: %s, To: %s", c.Params("from"), c.Params("to"))
    c.Send(msg) // => 💸 From: LAX, To: SFO
  })

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

  app.Listen(3000)
}

📖 Serving Static Files

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

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

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

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

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

  app.Listen(3000)
}

📚 顯示更多範例

界面引擎

📖 設定 📖 引擎 📖 渲染

當不指定樣板引擎時Fiber預設用html/template。

如果你想要執行部份或用別的樣板引擎amber、handlebars、mustache、pug之類…請參考符合多樣板引擎的樣板套件。

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

func main() {
  // 你可以在初始化前套用樣板引擎
  app := fiber.New(&fiber.Settings{
    Views: pug.New("./views", ".pug"),
  })

  // 或在初始化後任意時間套用:
  app.Settings.Views = pug.New("./views", ".pug"),

  // 現在，你可以像這樣呼叫樣板 `./views/home.pug`:
  app.Get("/", func(c *fiber.Ctx) {
    c.Render("home", fiber.Map{
      "title": "首頁",
      "year":  1999,
    })
  })

  // ...
}

Grouping routes into chains

📖 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

  // ...
}

中介器logger

📖 Logger

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

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

  // 預設
  app.Use(middleware.Logger())

  // 客制格式
  app.Use(middleware.Logger("${method} - ${path}"))

  // 客制設定
  app.Use(middleware.LoggerWithConfig(middleware.LoggerConfig{
    Next: func(ctx *fiber.Ctx) bool {
      return ctx.Path() != "/private"
    },
    Format: "${method} - ${path}",
    Output: io.Writer,
  }))

  app.Listen(3000)
}

### 跨網域資源共享 (CORS)

📖 [CORS](https://docs.gofiber.io/middleware#cors)

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

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

    // 預設的CORS
    app.Use(cors.New())

    app.Listen(3000)
}

在Origin header中放網域來檢查CORS:

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

客制404回應

📖 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!")
  })

  // 用最後一個中介器攔截剩餘的case
  app.Use(func(c *fiber.Ctx) {
    c.SendStatus(404)
    // => 404 "Not Found"
  })

  app.Listen(3000)
}

JSON 回應

📖 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 升級

📖 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 中介器

📖 Recover

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

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

  app.Use(middleware.Recover())

  app.Get("/", func(c *fiber.Ctx) {
    panic("normally this would crash your app")
  })

  app.Listen(3000)
}

🧬 Fiber中介器

官方團隊維護的中介器。

中介器	敘述	是否內建
adaptor	Converter for net/http handlers to/from Fiber request handlers, special thanks to @arsmn!	-
basicauth	Basic auth middleware provides an HTTP basic authentication. It calls the next handler for valid credentials and 401 Unauthorized for missing or invalid credentials.	-
compress	Compression middleware for Fiber, it supports deflate, gzip and brotli by default.	middleware.Compress()
cors	Enable cross-origin resource sharing CORS with various options.	-
csrf	Protect from CSRF exploits.	-
filesystem	FileSystem middleware for Fiber, special thanks and credits to Alireza Salary	-
favicon	Ignore favicon from logs or serve from memory if a file path is provided.	middleware.Favicon()
helmet	Helps secure your apps by setting various HTTP headers.	-
jwt	JWT returns a JSON Web Token JWT auth middleware.	-
keyauth	Key auth middleware provides a key based authentication.	-
limiter	Rate-limiting middleware for Fiber. Use to limit repeated requests to public APIs and/or endpoints such as password reset.	-
logger	HTTP request/response logger.	middleware.Logger()
pprof	Special thanks to Matthew Lee @mthli	-
recover	Recover middleware recovers from panics anywhere in the stack chain and handles the control to the centralized ErrorHandler.	middleware.Recover()
rewrite	Rewrite middleware rewrites the URL path based on provided rules. It can be helpful for backward compatibility or just creating cleaner and more descriptive links.	-
requestid	Request ID middleware generates a unique id for a request.	middleware.RequestID()
session	This session middleware is build on top of fasthttp/session by @savsgio MIT. Special thanks to @thomasvvugt for helping with this middleware.	-
template	This package contains 8 template engines that can be used with Fiber v1.10.x Go version 1.13 or higher is required.	-
websocket	Based on Fasthttp WebSocket for Fiber with Locals support!	-

🌱 第三方中介器

由社群建立的中介器列表，要新增請發PR!

• arsmn/fiber-swagger
• arsmn/fiber-casbin
• arsmn/fiber-introspect
• shareed2k/fiber_tracing
• shareed2k/fiber_limiter
• thomasvvugt/fiber-boilerplate
• arsmn/gqlgen
• kiyonlin/fiber_limiter
• juandiii/go-jwk-security

💬 新聞

• 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
• Building a Basic REST API in Go using Fiber - 23 Apr 2020
• 📺 Building a REST API using GORM and Fiber - 25 Apr 2020
• 🌎 Create a travel list app with Go, Fiber, Angular, MongoDB and Google Cloud Secret Manager - 25 Apr 2020
• Fiber v1.9.6 🔥 How to improve performance by 817% and stay fast, flexible and friendly? - 12 May 2020
• The road to web-based authentication with Fiber ⚡ - 20 May 2020
• Building an Express-style API in Go with Fiber - 10 June 2020
• 基于golang fiber和angular开发web - 19 June 2020
• 基于延迟计算令牌桶的gofiber频率限制中间件实现 - 20 June 2020
• Construir una API en Golang con Fiber 🇪🇸 - 28 June 2020
• 📺Why Go Fiber Is THE New Framework To Learn - 29 June 2020
• 解析Gofiber路由管理 - 08 July 2020
• 📺 Introduction to Fiber - An Express-inspired web framework - 25 July 2020

👍 貢獻

如果您要說聲謝謝或支援Fiber的積極發展：

1. 點擊GitHub Star關注本專案。
2. 在Twitter轉推。
3. 在Medium、Dev.to、部落格上發表意見或教學。
4. 在Crowdin 幫我們翻譯API文件
5. 贊助我們一杯咖啡。

☕ 支持者

Fiber是一個以贊助維生的開源專案，像是: 網域、gitbook、netlify、serverless伺服器。如果你想贊助也可以☕ 買杯咖啡

	User	Donation
	@destari	☕ x 10
	@dembygenesis	☕ x 5
	@thomasvvugt	☕ x 5
	@hendratommy	☕ x 5
	@ekaputra07	☕ x 5
	@jorgefuertes	☕ x 5
	@candidosales	☕ x 5
	@l0nax	☕ x 3
	@ankush	☕ x 3
	@bihe	☕ x 3
	@justdave	☕ x 3
	@koddr	☕ x 1
	@lapolinar	☕ x 1
	@diegowifi	☕ x 1
	@ssimk0	☕ x 1
	@raymayemir	☕ x 1
	@melkorm	☕ x 1
	@marvinjwendt	☕ x 1
	@toishy	☕ x 1

‎‍💻 貢獻者

⭐️ Stargazers

⚠️ 授權

Copyright (c) 2019-present Fenny and 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).

Third-party library licenses

• schema
• fasthttp
• fasttemplate
• bytebufferpool