Fiber

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

## ⚡️ 快速入門 ```go 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](https://www.techempower.com/benchmarks/#section=data-r19&hw=ph&test=plaintext)和[Go Web框架效能測試](https://github.com/smallnest/go-web-framework-benchmark)。如果要看全部的執行結果,請到[Wiki](https://docs.gofiber.io/benchmarks) 。

## ⚙️ 安裝 第一步, [下載](https://golang.org/dl/)並安裝Go。 請使用`1.11`以上版本。 下指令[`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)下載套件: ```bash go get -u github.com/gofiber/fiber ``` ## 🎯 功能 - 強大的[路由](https://docs.gofiber.io/routing) - [靜態檔案](https://docs.gofiber.io/application#static)服務 - [超快速](https://docs.gofiber.io/benchmarks) - [佔用很少記憶體](https://docs.gofiber.io/benchmarks) - 支援Express的[API](https://docs.gofiber.io/context) - 支援中介器和[下一步](https://docs.gofiber.io/context#next) - [立即上手](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) - [樣板引擎](https://github.com/gofiber/template) - 支援[WebSocket](https://docs.gofiber.io/middleware#websocket) - 支援[限速](https://docs.gofiber.io/middleware#limiter) - 被翻譯成[15]國語言(https://docs.gofiber.io/) - 豐富的[文件](https://docs.gofiber.io/) ## 💡 理念 不少[Node.js](https://nodejs.org/en/about/)的工程師跳到[Go](https://golang.org/doc/)必須學習一些知識,因此做了一個跟Express一樣的Fiber省這些麻煩。設計還是照原本的**極簡主義**還有遵循**UNIX慣例**,因此新手們可以**無痛**迅速進入Go的世界。 Fiber **受到** 網路上最流行的Web框架ExpressJS**啟發**,結合Express的**易用性**和Go的**高效能**。若你之前用過Node.js寫Web應用(*使用ExpressJS/Koa或類似工具*),那你已經**上手**了。 有什麼問題請發[issues](https://github.com/gofiber/fiber/issues)或加入Discord [channel](https://gofiber.io/discord)討論,我們想要創造**快速**、**彈性**、**友善**的社群給**任何人**使用!就像Express那樣。 ## 👀 範例 以下是一些常見範例。 > 更多程式碼在[範例專案](https://github.com/gofiber/recipes)中或直接看[API文件](https://docs.gofiber.io)。 #### 📖 [**Basic Routing**](https://docs.gofiber.io/#basic-routing) ```go func main() { app := fiber.New() // GET /john app.Get("/:name", func(c *fiber.Ctx) { c.Send("Hello, ", c.Params("name"), " 👋!") // => Hello john 👋! }) // GET /john/75 app.Get("/:name/:age/:gender?", func(c *fiber.Ctx) { c.Send(c.Params("name"), " is ", c.Params("age"), " years old 👴") // => john is 75 years old 👴 }) // GET /dictionary.txt app.Get("/:file.:ext", func(c *fiber.Ctx) { c.Send("📃 ", c.Params("file"), ".", c.Params("ext")) // => 📃 dictionary.txt }) // GET /flights/LAX-SFO app.Get("/flights/:from-:to", func(c *fiber.Ctx) { c.Send("✈ From ", c.Params("from"), ", To: ", c.Params("to")) // => ✈ From: LAX, To: SFO }) // GET /api/register app.Get("/api/*", func(c *fiber.Ctx) { c.Send("✋ ", c.Params("*")) // => ✋ /api/register }) app.Listen(3000) } ``` #### 📖 [**Serving Static Files**](https://docs.gofiber.io/application#static) ```go 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/context#next) ```go 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) } ```
📚 顯示更多範例 ### 界面引擎 📖 [設定](https://docs.gofiber.io/application#settings) 📖 [引擎](https://github.com/gofiber/template) 📖 [渲染](https://docs.gofiber.io/context#render) 當不指定樣板引擎時Fiber預設用[html/template](https://golang.org/pkg/html/template/)。 如果你想要執行部份或用別的樣板引擎[amber](https://github.com/eknkc/amber)、[handlebars](https://github.com/aymerick/raymond)、[mustache](https://github.com/cbroglie/mustache)、[pug](https://github.com/Joker/jade)之類…請參考符合多樣板引擎的[樣板](https://github.com/gofiber/template)套件。 ```go 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](https://docs.gofiber.io/application#group) ```go 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](https://github.com/gofiber/fiber/blob/master/middleware/logger.md) ```go 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: ```bash curl -H "Origin: http://example.com" --verbose http://localhost:3000 ``` ### 客制404回應 📖 [HTTP Methods](https://docs.gofiber.io/application#http-methods) ```go 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](https://docs.gofiber.io/context#json) ```go 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](https://docs.gofiber.io/middleware#websocket) ```go 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](https://github.com/gofiber/fiber/blob/master/middleware/recover.md) ```go 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中介器 官方[團隊](https://github.com/orgs/gofiber/people)維護的中介器。 | 中介器 | 敘述 | 是否內建 | | :--- | :--- | :--- | | [adaptor](https://github.com/gofiber/adaptor) | Converter for net/http handlers to/from Fiber request handlers, special thanks to @arsmn! | - | | [basicauth](https://github.com/gofiber/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](https://github.com/gofiber/fiber/blob/master/middleware/compress.md) | Compression middleware for Fiber, it supports `deflate`, `gzip` and `brotli` by default. | `middleware.Compress()` | | [cors](https://github.com/gofiber/cors) | Enable cross-origin resource sharing \(CORS\) with various options. | - | | [csrf](https://github.com/gofiber/csrf) | Protect from CSRF exploits. | - | | [embed](https://github.com/gofiber/embed) | FileServer middleware for Fiber, special thanks and credits to Alireza Salary | - | | [favicon](https://github.com/gofiber/fiber/blob/master/middleware/favicon.md) | Ignore favicon from logs or serve from memory if a file path is provided. | `middleware.Favicon()` | | [helmet](https://github.com/gofiber/helmet) | Helps secure your apps by setting various HTTP headers. | - | | [jwt](https://github.com/gofiber/jwt) | JWT returns a JSON Web Token \(JWT\) auth middleware. | - | | [keyauth](https://github.com/gofiber/keyauth) | Key auth middleware provides a key based authentication. | - | | [limiter](https://github.com/gofiber/limiter) | Rate-limiting middleware for Fiber. Use to limit repeated requests to public APIs and/or endpoints such as password reset. | - | | [logger](https://github.com/gofiber/fiber/blob/master/middleware/logger.md) | HTTP request/response logger. | `middleware.Logger()` | | [pprof](https://github.com/gofiber/pprof) | Special thanks to Matthew Lee \(@mthli\) | - | | [recover](https://github.com/gofiber/fiber/blob/master/middleware/recover.md) | Recover middleware recovers from panics anywhere in the stack chain and handles the control to the centralized[ ErrorHandler](error-handling.md). | `middleware.Recover()` | | [rewrite](https://github.com/gofiber/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](https://github.com/gofiber/fiber/blob/master/middleware/request_id.md) | Request ID middleware generates a unique id for a request. | `middleware.RequestID()` | | [session](https://github.com/gofiber/session) | This session middleware is build on top of fasthttp/session by @savsgio MIT. Special thanks to @thomasvvugt for helping with this middleware. | - | | [template](https://github.com/gofiber/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](https://github.com/gofiber/websocket) | Based on Fasthttp WebSocket for Fiber with Locals support! | - | ## 🌱 第三方中介器 由社群建立的中介器列表,要新增請發PR! - [arsmn/fiber-swagger](https://github.com/arsmn/fiber-swagger) - [arsmn/fiber-casbin](https://github.com/arsmn/fiber-casbin) - [arsmn/fiber-introspect](https://github.com/arsmn/fiber-introspect) - [shareed2k/fiber_tracing](https://github.com/shareed2k/fiber_tracing) - [shareed2k/fiber_limiter](https://github.com/shareed2k/fiber_limiter) - [thomasvvugt/fiber-boilerplate](https://github.com/thomasvvugt/fiber-boilerplate) - [arsmn/gqlgen](https://github.com/arsmn/gqlgen) - [kiyonlin/fiber_limiter](https://github.com/kiyonlin/fiber_limiter) ## 💬 新聞

- [Welcome to Fiber — an Express.js styled web framework written in Go with ❤️](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) — _03 Feb 2020_ - [Fiber released v1.7! 🎉 What's new and is it still fast, flexible and friendly?](https://dev.to/koddr/fiber-v2-is-out-now-what-s-new-and-is-he-still-fast-flexible-and-friendly-3ipf) — _21 Feb 2020_ - [🚀 Fiber v1.8. What's new, updated and re-thinked?](https://dev.to/koddr/fiber-v1-8-what-s-new-updated-and-re-thinked-339h) — _03 Mar 2020_ - [Is switching from Express to Fiber worth it? 🤔](https://dev.to/koddr/are-sure-what-your-lovely-web-framework-running-so-fast-2jl1) — _01 Apr 2020_ - [Creating Fast APIs In Go Using Fiber](https://dev.to/jozsefsallai/creating-fast-apis-in-go-using-fiber-59m9) — _07 Apr 2020_ - [Building a Basic REST API in Go using Fiber](https://tutorialedge.net/golang/basic-rest-api-go-fiber/) - _23 Apr 2020_ - [📺 Building a REST API using GORM and Fiber](https://youtu.be/Iq2qT0fRhAA) - _25 Apr 2020_ - [🌎 Create a travel list app with Go, Fiber, Angular, MongoDB and Google Cloud Secret Manager](https://blog.yongweilun.me/create-a-travel-list-app-with-go-fiber-angular-mongodb-and-google-cloud-secret-manager-ck9fgxy0p061pcss1xt1ubu8t) - _25 Apr 2020_ - [Fiber v1.9.6 🔥 How to improve performance by 817% and stay fast, flexible and friendly?](https://dev.to/koddr/fiber-v1-9-5-how-to-improve-performance-by-817-and-stay-fast-flexible-and-friendly-2dp6) - _12 May 2020_ - [The road to web-based authentication with Fiber ⚡](https://vugt.me/the-road-to-web-based-authentication-with-fiber/) - _20 May 2020_ - [Building an Express-style API in Go with Fiber](https://blog.logrocket.com/express-style-api-go-fiber/) - _10 June 2020_ - [Construir una API en Golang con Fiber 🇪🇸](https://enbonnet.me/article/53/construir-api-golang-con-fiber) - _28 June 2020_ - [📺Why Go Fiber Is THE New Framework To Learn](https://www.youtube.com/watch?v=kvwsPeWDLM8) - _29 June 2020_ ## 👍 貢獻 如果您要說聲**謝謝**或支援`Fiber`的積極發展: 1. 點擊[GitHub Star](https://github.com/gofiber/fiber/stargazers)關注本專案。 2. 在[Twitter](https://twitter.com/intent/tweet?text=Fiber%20is%20an%20Express%20inspired%20%23web%20%23framework%20built%20on%20top%20of%20Fasthttp%2C%20the%20fastest%20HTTP%20engine%20for%20%23Go.%20Designed%20to%20ease%20things%20up%20for%20%23fast%20development%20with%20zero%20memory%20allocation%20and%20%23performance%20in%20mind%20%F0%9F%9A%80%20https%3A%2F%2Fgithub.com%2Fgofiber%2Ffiber)轉[推](https://twitter.com/intent/tweet?text=Fiber%20is%20an%20Express%20inspired%20%23web%20%23framework%20built%20on%20top%20of%20Fasthttp%2C%20the%20fastest%20HTTP%20engine%20for%20%23Go.%20Designed%20to%20ease%20things%20up%20for%20%23fast%20development%20with%20zero%20memory%20allocation%20and%20%23performance%20in%20mind%20%F0%9F%9A%80%20https%3A%2F%2Fgithub.com%2Fgofiber%2Ffiber)。 3. 在[Medium](https://medium.com/)、[Dev.to](https://dev.to/)、部落格上發表意見或教學。 4. 在[Crowdin](https://crowdin.com/project/gofiber) [![Crowdin](https://badges.crowdin.net/gofiber/localized.svg)](https://crowdin.com/project/gofiber)幫我們翻譯API文件 5. 贊助我們[一杯咖啡](https://buymeacoff.ee/fenny)。 ## ☕ 支持者 Fiber是一個以贊助維生的開源專案,像是: 網域、gitbook、netlify、serverless伺服器。如果你想贊助也可以☕ [**買杯咖啡**](https://buymeacoff.ee/fenny) | | User | Donation | | :---------------------------------------------------------- | :----------------------------------------------- | :-------- | | ![](https://avatars.githubusercontent.com/u/204341?s=25 ) | [@destari](https://github.com/destari) | ☕ x 10 | | ![](https://avatars.githubusercontent.com/u/56607882?s=25 ) | [@thomasvvugt](https://github.com/thomasvvugt) | ☕ x 5 | | ![](https://avatars.githubusercontent.com/u/27820675?s=25 ) | [@hendratommy](https://github.com/hendratommy) | ☕ x 5 | | ![](https://avatars.githubusercontent.com/u/1094221?s=25 ) | [@ekaputra07](https://github.com/ekaputra07) | ☕ x 5 | | ![](https://avatars.githubusercontent.com/u/194590?s=25 ) | [@jorgefuertes](https://github.com/jorgefuertes) | ☕ x 5 | | ![](https://avatars.githubusercontent.com/u/186637?s=25 ) | [@candidosales](https://github.com/candidosales) | ☕ x 5 | | ![](https://avatars.githubusercontent.com/u/29659953?s=25 ) | [@l0nax](https://github.com/l0nax) | ☕ x 3 | | ![](https://avatars.githubusercontent.com/u/59947262?s=25 ) | [@ankush](https://github.com/ankush) | ☕ x 3 | | ![](https://avatars.githubusercontent.com/u/635852?s=25 ) | [@bihe](https://github.com/bihe) | ☕ x 3 | | ![](https://avatars.githubusercontent.com/u/307334?s=25 ) | [@justdave](https://github.com/justdave) | ☕ x 3 | | ![](https://avatars.githubusercontent.com/u/11155743?s=25 ) | [@koddr](https://github.com/koddr) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/29042462?s=25 ) | [@lapolinar](https://github.com/lapolinar) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/2978730?s=25 ) | [@diegowifi](https://github.com/diegowifi) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/44171355?s=25 ) | [@ssimk0](https://github.com/ssimk0) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/5638101?s=25 ) | [@raymayemir](https://github.com/raymayemir) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/619996?s=25 ) | [@melkorm](https://github.com/melkorm) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/31022056?s=25 ) | [@marvinjwendt](https://github.com/thomasvvugt) | ☕ x 1 | | ![](https://avatars.githubusercontent.com/u/31921460?s=25 ) | [@toishy](https://github.com/toishy) | ☕ x 1 | ## ‎‍💻 貢獻者 Code Contributors ## ⭐️ Stargazers Stargazers over time ## ⚠️ 授權 Copyright (c) 2019-present [Fenny](https://github.com/fenny) and [Contributors](https://github.com/gofiber/fiber/graphs/contributors). `Fiber` is free and open-source software licensed under the [MIT License](https://github.com/gofiber/fiber/blob/master/LICENSE). Official logo was created by [Vic Shóstak](https://github.com/koddr) and distributed under [Creative Commons](https://creativecommons.org/licenses/by-sa/4.0/) license (CC BY-SA 4.0 International). **Third-party library licenses** - [schema](https://github.com/gorilla/schema/blob/master/LICENSE) - [fasthttp](https://github.com/valyala/fasthttp/blob/master/LICENSE) - [fasttemplate](https://github.com/valyala/fasttemplate/blob/master/LICENSE) - [bytebufferpool](https://github.com/valyala/bytebufferpool/blob/master/LICENSE)