fiber

50 KiB

Raw Blame History

فايبر هي ويب فريمورك مستوحاه من اكسبريس ومبنيه على فاست اتش تي تي بي وهي اسرع محركات الويب للغه جو. مصممة عشان تسهل و تسرع التطوير ومابتعملش memory allocation زيادة. وبتهتم بالبيرفورمانس.

⚡️ بداية سريعة

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

🤖 القياسات

القياسات دي اتعملت عن طريق TechEmpower و Go Web. لو عاوز تشوف كل النتايج زور الويكي بتاعتنا.

⚙️ التسطيب

أتأكد انك مسطب جو (تحميل). الاصدار 1.17 او اعلى.

ابدأ البروجكت بتاعك بعمل فولدر وبعدين رن الكوماند ده go mod init github.com/your/repo (اعرف اكتر) بعدين سطب فايبر بكوماند go get:

go get -u github.com/gofiber/fiber/v2

🎯 المميزات

💡 الفكرة

الجوفرز الجداد اللي بيسوتشوا من نود جي اس لـجو بيتعاملوا مع مرحلة تعلم قبل ما يبدأوا يبنوا تطبيقاتهم و مايكروسيرفساتهم. فايبر, كـويب فريمورك, اتعملت بفكرة البساطة و بتتبع طريقة يونكس, عشان الجوفرز الجداد يقدروا يدخلوا عالم جو بسرعة و بثقة.

فايبر مستوحاة من اكسبريس اللي هي اشهر ويب فريمورك عالانترنت. احنا جمعنا بين سهولة اكسبريس و سرعة جو. لو انت عملت تطبيق ويب في نود جي اس (باستخدام اكسبريس او حاجة شبهها), هتلاقي ان معظم الطرق و المبادئ بتاعت فايبر مألوفة جدا.

احنا بنسمع لمستخدمينا في الايشوز و قناة الديسكورد و في كل حتة عالنت عشان نعمل فريمورك ويب جو سريع, مرن و سهل لاي تاسك, ديدلاين واي مستوى مبرمج! زي اكسبريس في عالم الجافاسكريبت.

⚠️ القيود

بسبب استخدام فايبر لـunsafe ممكن انها متتوافقش مع اخر اصدار من جو. فايبر 2.40.0 اتتست بـجو من اصدار 1.17 لـ1.21
فايبر مش متوافقة مع واجهات net/http. ده يعني انك مش هتقدر تستخدم مشاريع زي gqlgen, go-swagger, او اي حاجة تانية متعلقة بـnet/http

👀 أمثلة

دي بعض الامثلة الشائعة. لو عايز تشوف امثلة اكتر, زور Recipes repository او زور API documentation.

📖 الراوتنج البسيط

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

📖 تسمية الراوتس

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))
    // Prints:
    // {
    //    "method": "GET",
    //    "name": "api",
    //    "path": "/api/*",
    //    "params": [
    //      "*1"
    //    ]
    // }


    log.Fatal(app.Listen(":3000"))
}

📖 ازاي تسيرف فايلات ستاتك

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

📖 الميدلويرز ونيكست

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

📚 اعرض امثلة اكتر

محركات الفيوز

📖 Config 📖 Engines 📖 Render

فايبر بتستخدم html/template لما مايكونش في محرك فيوز متعرف

لو عاوز تستخدم فيوز جزئية او محرك فيوز تاني زي 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"))
}

تجميع الراوتس في سلسلة

📖 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

    // ...
}

ميدل وير لوجر

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

هيدر الكروس اوريجن (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"))
}

جرب الCORS بانك تبعت اي دومين في هيدر Origin وتشوف الرد بتاع السيرفر

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) 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 ريبسونس

📖 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

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
}

Server-Sent Events

📖 More Info

import (
    "github.com/gofiber/fiber/v2"
    "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 - the time is %v", i, time.Now())
        fmt.Fprintf(w, "data: Message: %s\n\n", msg)
        fmt.Println(msg)

        w.Flush()
        time.Sleep(5 * time.Second)
      }
    }))

    return nil
  })

  log.Fatal(app.Listen(":3000"))
}

ميدلوير ريكوفر

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

استخدام بروكسي موثوق

📖 Config

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

func main() {
    app := fiber.New(fiber.Config{
        EnableTrustedProxyCheck: true,
        TrustedProxies: []string{"0.0.0.0", "1.1.1.1/30"}, // IP address or IP address range
        ProxyHeader: fiber.HeaderXForwardedFor,
    })

    // ...

    log.Fatal(app.Listen(":3000"))
}

🧬 ميدلوير داخلي

Here is a list of middleware that are included within the Fiber framework. دي ليستة بالميدلوير الموجودة في فايبر

Middleware	Description
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.
cache	Intercept and cache responses
compress	Compression middleware for Fiber, it supports `deflate`, `gzip` and `brotli` by default.
cors	Enable cross-origin resource sharing `CORS` with various options.
csrf	Protect from CSRF exploits.
encryptcookie	Encrypt middleware which encrypts cookie values.
envvar	Expose environment variables with providing an optional config.
etag	ETag middleware that lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content has not changed.
expvar	Expvar middleware that serves via its HTTP server runtime exposed variants in the JSON format.
favicon	Ignore favicon from logs or serve from memory if a file path is provided.
filesystem	FileSystem middleware for Fiber, special thanks and credits to Alireza Salary
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.
monitor	Monitor middleware that reports server metrics, inspired by express-status-monitor
pprof	Special thanks to Matthew Lee `@mthli`
proxy	Allows you to proxy requests to a multiple servers
recover	Recover middleware recovers from panics anywhere in the stack chain and handles the control to the centralized ErrorHandler.
requestid	Adds a requestid to every request.
session	Session middleware. NOTE: This middleware uses our Storage package.
skip	Skip middleware that skips a wrapped handler if a predicate is true.
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.
timeout	Adds a max time for a request and forwards to ErrorHandler if it is exceeded.
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.
redirect	Redirect middleware
keyauth	Key auth middleware provides a key based authentication.

🧬 ميدلوير خارجي

لستة ميدلويرز خارجية بتطور من تيم فايبر.

Middleware	Description
jwt	JWT returns a JSON Web Token `JWT` auth middleware.
storage	Premade storage drivers that implement the Storage interface, designed to be used with various Fiber middlewares.
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!

🕶️ لستة الجامدين

لو عاوز تشوف مقالات او ميدل وير او امثلة او ادوات بص على اللستة دي awesome list.

👍 شاركنا

لو عاوز تقول شكرا او تدعمنا في تطوير فايبر:

اعمل GitHub Star للبروجكت.
تويت عن البروجكت على تويتر.
اكتب ريفيو او توتوريال على Medium, Dev.to او البلوج بتاعتك.
او ادعم المشروع بكوباية شاي.

☕ الداعمين

فايبر مشروع اوبن سورس وشغال على التبرعات عشان ندفع فواتير الدومين والجيت بوك والنتليفاي والسيرفرات. لو عاوز تدعم فايبر تقدر تشتري كوباية شاي من هنا.

	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
	@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

‎‍💻 Code Contributors

⭐️ Stargazers

⚠️ License

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

50 KiB Raw Blame History Unescape Escape