Fiber是一个受Express启发的Web框架,建立在Fasthttp之上,Fasthttp是Go最快的HTTP引擎。设计目的是为了简化事情,以便快速开发,同时考虑到零内存分配和性能。
⚠️ 注意
Fiber v3目前处于测试版,正在积极开发中。虽然它提供了令人兴奋的新功能,但请注意,它可能不适合用于生产环境。我们建议对于关键任务应用程序,坚持使用最新的稳定版本(v2.x)。如果您选择使用v3,请做好应对潜在错误和重大变更的准备。请随时查看官方文档和发布说明以获取更新,并谨慎使用。祝编码愉快!🚀
⚙️ 安装
Fiber需要Go版本1.22
或更高才能运行。如果您需要安装或升级Go,请访问Go官方下载页面。要开始设置您的项目,请为您的项目创建一个新目录并进入其中。然后,通过在终端中执行以下命令,使用Go模块初始化您的项目:
go mod init github.com/your/repo
要了解更多关于Go模块及其工作原理的信息,您可以查看使用Go模块博客文章。
设置项目后,您可以使用go get
命令安装Fiber:
go get -u github.com/gofiber/fiber/v3
此命令获取Fiber包并将其添加到您项目的依赖项中,允许您开始使用Fiber构建Web应用程序。
⚡️ 快速入门
开始使用Fiber很简单。以下是一个基本示例,创建一个简单的Web服务器,在根路径上响应"Hello, World 👋!"。这个示例演示了初始化新的Fiber应用、设置路由和启动服务器。
package main
import (
"log"
"github.com/gofiber/fiber/v3"
)
func main() {
// 初始化一个新的Fiber应用
app := fiber.New()
// 为根路径'/'的GET方法定义一个路由
app.Get("/", func(c fiber.Ctx) error {
// 向客户端发送字符串响应
return c.SendString("Hello, World 👋!")
})
// 在3000端口启动服务器
log.Fatal(app.Listen(":3000"))
}
这个简单的服务器很容易设置和运行。它介绍了Fiber的核心概念:应用初始化、路由定义和启动服务器。只需运行这个Go程序,然后在浏览器中访问http://localhost:3000
即可看到消息。
零分配
Fiber针对高性能进行了优化,这意味着从fiber.Ctx返回的值默认情况下不是不可变的,并且将在请求之间重复使用。作为一般规则,您必须仅在处理程序内使用上下文值,并且不得保留任何引用。一旦您从处理程序返回,从上下文获得的任何值都将在未来的请求中重复使用。访问我们的文档了解更多信息。
🤖 基准测试
这些测试由TechEmpower和Go Web执行。如果您想查看所有结果,请访问我们的Wiki。
🎯 特性
- 强大的路由
- 服务静态文件
- 极致性能
- 低内存占用
- API端点
- 中间件和Next支持
- 快速的服务器端编程
- 模板引擎
- WebSocket支持
- Socket.io支持
- 服务器发送事件
- 速率限制
- 以及更多,探索Fiber
💡 理念
从Node.js转向Go的新手在开始构建Web应用或微服务之前,需要面对一定的学习曲线。Fiber作为一个Web框架,秉承极简主义的理念,遵循UNIX方式,使新手能够快速进入Go的世界,获得温暖而可信赖的欢迎。
Fiber受启发于Express,这是互联网上最流行的Web框架。我们结合了Express的易用性和Go的原始性能。如果您曾经在Node.js中实现过Web应用(使用Express或类似框架),那么许多方法和原则对您来说将会非常熟悉。
我们倾听用户在issues、Discord频道_以及互联网上各处_的声音,以创建一个快速、灵活且友好的Go Web框架,适用于任何任务、截止日期和开发者技能水平!就像Express在JavaScript世界中所做的那样。
⚠️ 限制
- 由于Fiber使用了不安全操作,该库可能并不总是与最新的Go版本兼容。Fiber v3已经在Go 1.22和1.23版本上进行了测试。
- Fiber与net/http接口不兼容。这意味着您将无法使用gqlgen、go-swagger或任何其他属于net/http生态系统的项目。
👀 示例
以下列出了一些常见示例。如果您想查看更多代码示例,请访问我们的Recipes仓库或访问我们托管的API文档。
📖 基本路由
func main() {
app := fiber.New()
// GET /api/register
app.Get("/api/*", func(c fiber.Ctx) error {
msg := fmt.Sprintf("✋ %s", c.Params("*"))
return c.SendString(msg) // => ✋ register
})
// GET /flights/LAX-SFO
app.Get("/flights/:from-:to", func(c fiber.Ctx) error {
msg := fmt.Sprintf("💸 出发地: %s, 目的地: %s", c.Params("from"), c.Params("to"))
return c.SendString(msg) // => 💸 出发地: LAX, 目的地: SFO
})
// GET /dictionary.txt
app.Get("/:file.:ext", func(c fiber.Ctx) error {
msg := fmt.Sprintf("📃 %s.%s", c.Params("file"), c.Params("ext"))
return c.SendString(msg) // => 📃 dictionary.txt
})
// GET /john/75
app.Get("/:name/:age/:gender?", func(c fiber.Ctx) error {
msg := fmt.Sprintf("👴 %s 今年 %s 岁", c.Params("name"), c.Params("age"))
return c.SendString(msg) // => 👴 john 今年 75 岁
})
// GET /john
app.Get("/:name", func(c fiber.Ctx) error {
msg := fmt.Sprintf("你好, %s 👋!", c.Params("name"))
return c.SendString(msg) // => 你好 john 👋!
})
log.Fatal(app.Listen(":3000"))
}
📖 路由命名
func main() {
app := fiber.New()
// GET /api/register
app.Get("/api/*", func(c fiber.Ctx) error {
msg := fmt.Sprintf("✋ %s", c.Params("*"))
return c.SendString(msg) // => ✋ register
}).Name("api")
data, _ := json.MarshalIndent(app.GetRoute("api"), "", " ")
fmt.Print(string(data))
// 输出:
// {
// "method": "GET",
// "name": "api",
// "path": "/api/*",
// "params": [
// "*1"
// ]
// }
log.Fatal(app.Listen(":3000"))
}
📖 提供静态文件
func main() {
app := fiber.New()
app.Get("/*", static.New("./public"))
// => http://localhost:3000/js/script.js
// => http://localhost:3000/css/style.css
app.Get("/prefix*", static.New("./public"))
// => http://localhost:3000/prefix/js/script.js
// => http://localhost:3000/prefix/css/style.css
app.Get("*", static.New("./public/index.html"))
// => http://localhost:3000/any/path/shows/index/html
log.Fatal(app.Listen(":3000"))
}
📖 中间件与Next
func main() {
app := fiber.New()
// 匹配任何路由
app.Use(func(c fiber.Ctx) error {
fmt.Println("🥇 第一个处理程序")
return c.Next()
})
// 匹配所有以 /api 开头的路由
app.Use("/api", func(c fiber.Ctx) error {
fmt.Println("🥈 第二个处理程序")
return c.Next()
})
// GET /api/list
app.Get("/api/list", func(c fiber.Ctx) error {
fmt.Println("🥉 最后一个处理程序")
return c.SendString("你好, 世界 👋!")
})
log.Fatal(app.Listen(":3000"))
}
📚 显示更多代码示例
视图引擎
当未设置视图引擎时,Fiber 默认使用 html/template。
如果你想执行部分模板或使用其他引擎,如 amber、handlebars、mustache 或 pug 等..
请查看我们的 Template 包,它支持多种视图引擎。
package main
import (
"log"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/template/pug"
)
func main() {
// 你可以在初始化应用之前设置视图引擎:
app := fiber.New(fiber.Config{
Views: pug.New("./views", ".pug"),
})
// 现在,你可以像这样调用模板 `./views/home.pug`:
app.Get("/", func(c fiber.Ctx) error {
return c.Render("home", fiber.Map{
"title": "首页",
"year": 1999,
})
})
log.Fatal(app.Listen(":3000"))
}
将路由分组到链中
📖 Group
func middleware(c fiber.Ctx) error {
fmt.Println("别在意我!")
return c.Next()
}
func handler(c fiber.Ctx) error {
return c.SendString(c.Path())
}
func main() {
app := fiber.New()
// 根 API 路由
api := app.Group("/api", middleware) // /api
// API v1 路由
v1 := api.Group("/v1", middleware) // /api/v1
v1.Get("/list", handler) // /api/v1/list
v1.Get("/user", handler) // /api/v1/user
// API v2 路由
v2 := api.Group("/v2", middleware) // /api/v2
v2.Get("/list", handler) // /api/v2/list
v2.Get("/user", handler) // /api/v2/user
// ...
}
中间件日志记录器
📖 Logger
package main
import (
"log"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/logger"
)
func main() {
app := fiber.New()
app.Use(logger.New())
// ...
log.Fatal(app.Listen(":3000"))
}
跨源资源共享 (CORS)
📖 CORS
import (
"log"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/cors"
)
func main() {
app := fiber.New()
app.Use(cors.New())
// ...
log.Fatal(app.Listen(":3000"))
}
通过在 Origin
头中传递任何域来检查 CORS:
curl -H "Origin: http://example.com" --verbose http://localhost:3000
自定义 404 响应
📖 HTTP 方法
func main() {
app := fiber.New()
app.Get("/", static.New("./public"))
app.Get("/demo", func(c fiber.Ctx) error {
return c.SendString("这是一个演示!")
})
app.Post("/register", func(c fiber.Ctx) error {
return c.SendString("欢迎!")
})
// 最后一个中间件匹配任何内容
app.Use(func(c fiber.Ctx) error {
return c.SendStatus(404)
// => 404 "未找到"
})
log.Fatal(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) error {
return c.JSON(&User{"约翰", 20})
// => {"name":"约翰", "age":20}
})
app.Get("/json", func(c fiber.Ctx) error {
return c.JSON(fiber.Map{
"success": true,
"message": "你好约翰!",
})
// => {"success":true, "message":"你好约翰!"}
})
log.Fatal(app.Listen(":3000"))
}
WebSocket 升级
import (
"log"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/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("读取:", err)
break
}
log.Printf("接收: %s", msg)
err = c.WriteMessage(mt, msg)
if err != nil {
log.Println("写入:", err)
break
}
}
}))
log.Fatal(app.Listen(":3000"))
// ws://localhost:3000/ws
}
服务器发送事件
📖 更多信息
import (
"log"
"github.com/gofiber/fiber/v3"
"github.com/valyala/fasthttp"
)
func main() {
app := fiber.New()
app.Get("/sse", func(c fiber.Ctx) error {
c.Set("Content-Type", "text/event-stream")
c.Set("Cache-Control", "no-cache")
c.Set("Connection", "keep-alive")
c.Set("Transfer-Encoding", "chunked")
c.Context().SetBodyStreamWriter(fasthttp.StreamWriter(func(w *bufio.Writer) {
fmt.Println("WRITER")
var i int
for {
i++
msg := fmt.Sprintf("%d - 当前时间是 %v", i, time.Now())
fmt.Fprintf(w, "data: 消息: %s\n\n", msg)
fmt.Println(msg)
w.Flush()
time.Sleep(5 * time.Second)
}
}))
return nil
})
log.Fatal(app.Listen(":3000"))
}
Recover 中间件
📖 Recover
import (
"log"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
)
func main() {
app := fiber.New()
app.Use(recover.New())
app.Get("/", func(c fiber.Ctx) error {
panic("通常这会导致你的应用崩溃")
})
log.Fatal(app.Listen(":3000"))
}
使用可信代理
📖 Config
import (
"log"
"github.com/gofiber/fiber/v3"
)
func main() {
app := fiber.New(fiber.Config{
EnableTrustedProxyCheck: true,
TrustedProxies: []string{"0.0.0.0", "1.1.1.1/30"}, // IP 地址或 IP 地址范围
ProxyHeader: fiber.HeaderXForwardedFor,
})
log.Fatal(app.Listen(":3000"))
}
🧬 内置中间件
以下是 Fiber 框架内置的中间件列表。
中间件 | 描述 |
---|---|
adaptor | 用于将 net/http 处理器转换为/从 Fiber 请求处理器的转换器。 |
basicauth | 提供 HTTP 基本认证。对有效凭据调用下一个处理器,对缺失或无效凭据返回 401 未授权。 |
cache | 拦截并缓存 HTTP 响应。 |
compress | Fiber 的压缩中间件,支持 deflate 、gzip 、brotli 和 zstd 。 |
cors | 启用具有各种选项的跨源资源共享 (CORS)。 |
csrf | 防止 CSRF 攻击。 |
earlydata | 添加对 TLS 1.3 early data ("0-RTT") 特性的支持。 |
encryptcookie | 加密中间件,用于加密 cookie 值。 |
envvar | 暴露环境变量并提供可选配置。 |
etag | 允许缓存更高效并节省带宽,因为如果内容未更改,web 服务器无需重新发送完整响应。 |
expvar | 通过其 HTTP 服务器以 JSON 格式提供运行时暴露的变量。 |
favicon | 忽略日志中的 favicon 或从内存中提供(如果提供了文件路径)。 |
healthcheck | Fiber 的存活和就绪探针。 |
helmet | 通过设置各种 HTTP 头来帮助保护您的应用。 |
idempotency | 允许容错 API,其中重复请求不会在服务器端错误地多次执行相同的操作。 |
keyauth | 添加基于密钥的认证支持。 |
limiter | 为 Fiber 添加速率限制支持。用于限制对公共 API 和/或端点(如密码重置)的重复请求。 |
logger | HTTP 请求/响应日志记录器。 |
pprof | 以 pprof 格式提供运行时分析数据。 |
proxy | 允许您将请求代理到多个服务器。 |
recover | 从堆栈链中的任何位置恢复 panic,并将控制权交给集中的 ErrorHandler。 |
redirect | 重定向中间件。 |
requestid | 为每个请求添加请求 ID。 |
rewrite | 基于提供的规则重写 URL 路径。这对向后兼容或创建更清晰、更具描述性的链接很有帮助。 |
session | 会话中间件。注意:此中间件使用我们的存储包。 |
skip | 如果谓词为真,则跳过包装的处理器的 Skip 中间件。 |
static | Fiber 的静态中间件,用于提供静态文件,如图片、CSS 和 JavaScript。 |
timeout | 为请求添加最大时间限制,如果超过则转发到 ErrorHandler。 |
🧬 外部中间件
由 Fiber 团队 维护的外部托管中间件模块列表。
中间件 | 描述 |
---|---|
contrib | 第三方中间件 |
storage | 预制存储驱动程序,实现存储接口,设计用于与各种 Fiber 中间件一起使用。 |
template | 此包包含 9 个模板引擎,可与 Fiber v3 一起使用。需要 Go 版本 1.22 或更高版本。 |
🕶️ 精选列表
更多文章、中间件、示例或工具,请查看我们的 精选列表。
👍 贡献
如果您想说谢谢并/或支持 Fiber
的积极开发:
- 为项目添加 GitHub Star。
- 在您的 𝕏 (Twitter) 上 发推文介绍这个项目。
- 在 Medium、Dev.to 或个人博客上写评论或教程。
- 通过捐赠 一杯咖啡 来支持这个项目。
🖥️ 开发
为确保您的贡献准备好进行拉取请求,请使用以下 Makefile
命令。这些工具有助于保持代码质量和一致性。
- make help:显示可用命令。
- make audit:进行质量检查。
- make benchmark:对代码性能进行基准测试。
- make coverage:生成测试覆盖率报告。
- make format:自动格式化代码。
- make lint:运行 lint 检查。
- make test:执行所有测试。
- make tidy:整理依赖项。
运行这些命令以确保您的代码符合项目标准和最佳实践。
☕ 支持者
Fiber 是一个开源项目,依靠捐赠来支付账单,例如我们的域名、gitbook、netlify 和无服务器托管。如果您想支持 Fiber,您可以 ☕ 在这里买杯咖啡。
用户 | 捐赠 | |
---|---|---|
@destari | ☕ x 10 | |
@dembygenesis | ☕ x 5 | |
@thomasvvugt | ☕ x 5 | |
@hendratommy | ☕ x 5 | |
@ekaputra07 | ☕ x 5 | |
@jorgefuertes | ☕ x 5 | |
@candidosales | ☕ x 5 | |
@l0nax | ☕ 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 |
💻 代码贡献者
⭐️ 点赞者
🧾 许可证
版权所有 (c) 2019-至今 Fenny 和贡献者。Fiber
是根据 MIT 许可证 授权的免费开源软件。官方标志由 Vic Shóstak 创作,并根据 知识共享 许可证(CC BY-SA 4.0 国际版)分发。