دليل البداية السريعة لـ Go Iris

البدء مع إطار عمل Go Iris Web

التثبيت

ملاحظة: يتطلب الإصدار 1.20 أو أعلى من Go.

$ mkdir myapp
$ cd myapp
$ go mod init myapp
$ go get github.com/kataras/iris/v12@latest

قم بإستيراده في كودك:

import "github.com/kataras/iris/v12"

حل مشكلات التثبيت

إذا واجهت أخطاء شبكة أثناء التثبيت، تأكد من أن متغير البيئة GOPROXY مضبوط على قيمة صالحة.

go env -w GOPROXY=https://goproxy.io,direct

إذا لم تحل الطرق السابقة المشكلة، قم بمسح ذاكرة التخزين المؤقت للوحدة الخاصة بـ go:

go clean --modcache

البدء السريع

وضع الوظائف

$ cat main.go

package main

import "github.com/kataras/iris/v12"

func main() {
    // قم بتعريف نسخة iris
    app := iris.New()

    // قم بتعريف مجموعة مسارات، (هنا تم تعريف مجموعة مسارات ببادئة /books)
    booksAPI := app.Party("/books")
    {
        // استخدام الوسيط
        booksAPI.Use(iris.Compression)

        // تعيين المسارات ومعالجات المسارات
        // GET: http://localhost:8080/books
        booksAPI.Get("/", list)
        // POST: http://localhost:8080/books
        booksAPI.Post("/", create)
    }

    // الاستماع على المنفذ
    app.Listen(":8080")
}

// مثال كتاب
type Book struct {
    Title string `json:"title"`
}

func list(ctx iris.Context) {
    books := []Book{
        {"Mastering Concurrency in Go"},
        {"Go Design Patterns"},
        {"Black Hat Go"},
    }

    ctx.JSON(books)
    // ملاحظة: تفاوض الاستجابة بناءً على أولوية الخادم وتفضيل العميل بدلاً من استخدام ctx.JSON:
    // ctx.Negotiation().JSON().MsgPack().Protobuf()
    // ctx.Negotiate(books)
}

func create(ctx iris.Context) {
    var b Book
    err := ctx.ReadJSON(&b)
    // ملاحظة: استخدم ctx.ReadBody(&b) لربط البيانات الواردة من أي نوع.
    if err != nil {
        ctx.StopWithProblem(iris.StatusBadRequest, iris.NewProblem().
            Title("فشل في إنشاء الكتاب").DetailErr(err))
        // ملاحظة: استخدم ctx.StopWithError(code, err) عند توقع استجابة نصية عادية فقط في حالة حدوث خطأ.
        return
    }

    println("Received book: " + b.Title)

    ctx.StatusCode(iris.StatusCreated)
}

نمط العمارة MVC

استيراد حزمة MVC

import "github.com/kataras/iris/v12/mvc"

إعداد التحكم بناءً على مجموعة المسارات

m := mvc.New(booksAPI)
m.Handle(new(BookController))

تنفيذ التحكم

type BookController struct {
    /* حقن التبعية */
}

// الاستجابة للطلب: http://localhost:8080/books
func (c *BookController) Get() []Book {
    return []Book{
        {"Mastering Go Concurrency"},
        {"Go Design Patterns"},
        {"Black Hat Go"},
    }
}

// الاستجابة للطلب:  http://localhost:8080/books
func (c *BookController) Post(b Book) int {
    println("Received book: " + b.Title)

    return iris.StatusCreated
}

قم بتشغيل خادم الويب Iris:

$ go run main.go
> الاستماع على: http://localhost:8080
> قد بدأ التطبيق. اضغط CTRL+C لإيقاف التشغيل.

قائمة الكتب:

$ curl --header 'Accept-Encoding:gzip' http://localhost:8080/books

[
  {
    "title": "Mastering Go Concurrency"
  },
  {
    "title": "Go Design Patterns"
  },
  {
    "title": "Black Hat Go"
  }
]

إنشاء كتاب جديد:

$ curl -i -X POST \
--header 'Content-Encoding:gzip' \
--header 'Content-Type:application/json' \
--data "{\"title\":\"Writing an Interpreter in Go\"}" \
http://localhost:8080/books

> HTTP/1.1 201 Created

هذا مثال على استجابة خطأ:

$ curl -X POST --data "{\"title\" \"Invalid Book\"}" \
http://localhost:8080/books

> HTTP/1.1 400 Bad Request

{
  "status": 400,
  "title": "فشل إنشاء الكتاب",
  "detail": "invalid character '\"' after object key"
}