43 KiB
⚡️ شروع سریع
package main
import "github.com/gofiber/fiber/v2"
func main() {
app := fiber.New()
app.Get("/", func(c *fiber.Ctx) error {
return c.SendString("Hello, World 👋!")
})
app.Listen(":3000")
}
🤖 بنچمارک
⚙️ نصب و راه اندازی
پروژه خود را با ساختن یک پوشه و سپس اجرای
go mod init github.com/your/repo
داخل پوشه (یادگیری بیشتر) راه اندازی کنید. سپس Fiber را با دستور go get
نصب کنید :
go get -u github.com/gofiber/fiber/v2
🎯 ویژگی ها
- مسیریابی قدرتمند
- Serve پرونده های ثابت
- حداکثر عملکرد
- مصرف حافظه کم
- قابلیت API endpoints
- پشتیبانی از Middleware & Next
- برنامه نویسی سمت سرور سریع
- دارای Template engines اختصاصی
- پشتیبانی از وب سوکت
- قابلیت Rate Limiter
- ترجمه در 15 زبان
- و امکانات بیشتر, دیدن در داکیومنت
💡 فلسفه
Fiber از Express الهام گرفته, که محبوب ترین فریمورک وب روی اینترنت است. ما سادگی Express را با عملکرد بالا زبان Go ترکیب کردیم. اگر شما قبلا یک برنامه وب را در Node.js (با استفاده از Express یا موارد مشابه) پیاده سازی کرده اید. بسیاری از روش ها و اصول ها برای شما ساده به نظر خواهد رسید.
ما در مورد مشکلات کاربران, کانال Discord سراسر دنیا گوش می دهیم و تا بتوانیم یک وب فریم ورک سریع, مطمئن, ساده ایجاد کنیم. درست مثل Express برای برنامه نویس های جاوا اسکریپت.
محدودیت ها
- به دلیل استفاده ناامن از Fiber, ممکن است کتابخانه همیشه با آخرین نسخه Go سازگار نباشد. Fiber 2.18.0 با زبان گو نسخه ۱.۱۴ تا ۱.۱۷ تست شده است.
- فریمورک Fiber با پکیج net/http سازگار نیست. این بدان معناست شما نمی توانید از پکیج های مانند go-swagger, gqlgen یا سایر پروژه هایی که بخشی از اکوسیستم net/http هستند استفاده کنید.
👀 مثال ها
📖 Basic Routing
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("💸 From: %s, To: %s", c.Params("from"), c.Params("to"))
return c.SendString(msg) // => 💸 From: LAX, To: 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 is %s years old", c.Params("name"), c.Params("age"))
return c.SendString(msg) // => 👴 john is 75 years old
})
// GET /john
app.Get("/:name", func(c *fiber.Ctx) error {
msg := fmt.Sprintf("Hello, %s 👋!", c.Params("name"))
return c.SendString(msg) // => Hello john 👋!
})
log.Fatal(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
log.Fatal(app.Listen(":3000"))
}
📖 Middleware & Next
func main() {
app := fiber.New()
// Match any route
app.Use(func(c *fiber.Ctx) error {
fmt.Println("🥇 First handler")
return c.Next()
})
// Match all routes starting with /api
app.Use("/api", func(c *fiber.Ctx) error {
fmt.Println("🥈 Second handler")
return c.Next()
})
// GET /api/list
app.Get("/api/list", func(c *fiber.Ctx) error {
fmt.Println("🥉 Last handler")
return c.SendString("Hello, World 👋!")
})
log.Fatal(app.Listen(":3000"))
}
📚 نمایش نمونه کدهای بیشتر
View engines
شما می توانید از موتورهای مختلفی نظیر amber, handlebars, mustache یا pug استفاده کنید.
پکیج موتورهای پشتیبانی شده را می توانید در اینجا ببینید.
package main
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/template/pug"
)
func main() {
// You can setup Views engine before initiation app:
app := fiber.New(fiber.Config{
Views: pug.New("./views", ".pug"),
})
// And now, you can call template `./views/home.pug` like this:
app.Get("/", func(c *fiber.Ctx) error {
return c.Render("home", fiber.Map{
"title": "Homepage",
"year": 1999,
})
})
log.Fatal(app.Listen(":3000"))
}
Grouping routes into chains
📖 Group
func middleware(c *fiber.Ctx) error {
fmt.Println("Don't mind me!")
return c.Next()
}
func handler(c *fiber.Ctx) error {
return c.SendString(c.Path())
}
func main() {
app := fiber.New()
// Root API route
api := app.Group("/api", middleware) // /api
// API v1 routes
v1 := api.Group("/v1", middleware) // /api/v1
v1.Get("/list", handler) // /api/v1/list
v1.Get("/user", handler) // /api/v1/user
// API v2 routes
v2 := api.Group("/v2", middleware) // /api/v2
v2.Get("/list", handler) // /api/v2/list
v2.Get("/user", handler) // /api/v2/user
// ...
}
Middleware logger
📖 Logger
package main
import (
"log"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/logger"
)
func main() {
app := fiber.New()
app.Use(logger.New())
// ...
log.Fatal(app.Listen(":3000"))
}
Cross-Origin Resource Sharing (CORS)
📖 CORS
import (
"log"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/cors"
)
func main() {
app := fiber.New()
app.Use(cors.New())
// ...
log.Fatal(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) error {
return c.SendString("This is a demo!")
})
app.Post("/register", func(c *fiber.Ctx) error {
return c.SendString("Welcome!")
})
// Last middleware to match anything
app.Use(func(c *fiber.Ctx) error {
return c.SendStatus(404)
// => 404 "Not Found"
})
log.Fatal(app.Listen(":3000"))
}
JSON Response
📖 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{"John", 20})
// => {"name":"John", "age":20}
})
app.Get("/json", func(c *fiber.Ctx) error {
return c.JSON(fiber.Map{
"success": true,
"message": "Hi John!",
})
// => {"success":true, "message":"Hi John!"}
})
log.Fatal(app.Listen(":3000"))
}
WebSocket Upgrade
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/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("read:", err)
break
}
log.Printf("recv: %s", msg)
err = c.WriteMessage(mt, msg)
if err != nil {
log.Println("write:", err)
break
}
}
}))
log.Fatal(app.Listen(":3000"))
// ws://localhost:3000/ws
}
Recover middleware
📖 Recover
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/recover"
)
func main() {
app := fiber.New()
app.Use(recover.New())
app.Get("/", func(c *fiber.Ctx) error {
panic("normally this would crash your app")
})
log.Fatal(app.Listen(":3000"))
}
🧬 Middleware داخلی
در اینجا لیستی از middleware های Fiber موجود است.
Middleware | توضیحات |
---|---|
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. |
cache | Intercept and cache responses |
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. |
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. |
pprof | Special thanks to Matthew Lee @mthli |
proxy | Allows you to proxy requests to a multiple servers |
requestid | Adds a requestid to every request. |
recover | Recover middleware recovers from panics anywhere in the stack chain and handles the control to the centralized ErrorHandler. |
timeout | Adds a max time for a request and forwards to ErrorHandler if it is exceeded. |
🧬 Middleware خارجی
لیست middleware های خارجی که توسط تیم Fiber نگه داری می شود.
Middleware | توضیحات |
---|---|
adaptor | Converter for net/http handlers to/from Fiber request handlers, special thanks to @arsmn! |
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. |
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. |
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! |
🌱 سایر Middleware ها
Middleware های لیست زیر توسط انجمن Fiber ایجاد است, اگر میخواهید یکی خود را ببینید یک 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
- sujit-baniya/fiber-boilerplate
- ansrivas/fiberprometheus
- LdDl/fiber-long-poll
- K0enM/fiber_vhost
- sacsand/gofiber-firebaseauth
- theArtechnology/fiber-inertia
- aschenmaker/fiber-health-check
- elastic/apmfiber
👍 مشارکت کنندگان
اگر شما میخواهید تشکر کنید و یا از توسعه فعال Fiber حمایت کنید :
- یک GitHub Star به پروژه اضافه کنید.
- ارسال توییت درباره Fiber برروی صفحه توییتر شما.
- یک آموزش یا نظر برروی Medium, Dev.to یا وبلاگ شخصیتان.
- پشتیبانی پروژه با حمایت مالی از طریق یک فنجان قهوه.
☕ حامیان مالی
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 | |
@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 |
💻 مشارکت کنندگان کد
⭐️ ستاره ها
⚠️ لایسنس
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).
مجوزهای کتابخانه شخص ثالث