encoding/json مع Structs

جزء من قسم Object Oriented Programming في رحلة GO على Coddy — الدرس 76 من 107.

تتيح لك حزمة encoding/json تحويل هياكل Go (structs) إلى JSON والعكس. يعد هذا أمراً ضرورياً لواجهات برمجة التطبيقات (APIs)، وملفات التكوين، وتخزين البيانات. تتحكم وسوم الهياكل (Struct tags) في كيفية تعيين الحقول لمفاتيح JSON.

لتحويل struct إلى JSON، استخدم json.Marshal:

type User struct {
    Name  string `json:"name"`
    Email string `json:"email"`
    Age   int    `json:"age"`
}

func main() {
    user := User{Name: "Alice", Email: "alice@example.com", Age: 30}
    data, _ := json.Marshal(user)
    fmt.Println(string(data))
    // {"name":"Alice","email":"alice@example.com","age":30}
}

تحدد علامات الـ struct مثل `json:"name"` أسماء مفاتيح JSON. بدون العلامات، تستخدم لغة Go اسم الحقل مباشرة. يتم تضمين الحقول المصدرة فقط (التي تبدأ بحرف كبير) في مخرجات JSON.

لتحويل JSON مرة أخرى إلى struct، استخدم json.Unmarshal:

jsonStr := `{"name":"Bob","email":"bob@example.com","age":25}`
var user User
json.Unmarshal([]byte(jsonStr), &user)
fmt.Println(user.Name)  // Bob

تتضمن خيارات الوسوم الشائعة omitempty لتخطي القيم الصفرية و - لتجاهل حقل بالكامل:

type Product struct {
    ID       int    `json:"id"`
    Name     string `json:"name"`
    Price    float64 `json:"price,omitempty"`
    Internal string `json:"-"`
}

باستخدام omitempty، إذا كانت قيمة Price هي صفر، فلن تظهر في الـ JSON. أما الحقل Internal فلا يتم تضمينه أبداً بغض النظر عن قيمته.

التحدي

سهل

لنقم ببناء نظام كتالوج أفلام يقوم بالتحويل بين هياكل Go (structs) وتنسيق JSON! ستتدرب على تحويل الهياكل إلى JSON (marshaling) وفك ترميز JSON مرة أخرى إلى هياكل (unmarshaling)، باستخدام وسوم الهياكل (struct tags) للتحكم في أسماء حقول JSON.

ستقوم بتنظيم الكود الخاص بك عبر ملفين:

movie.go: حدد نموذج بيانات الفيلم الخاص بك مع وسوم JSON المناسبة.
قم بإنشاء هيكل Movie يحتوي على الحقول وتعيينات JSON التالية:
- Title (string) يتم تعيينه إلى "title"
- Director (string) يتم تعيينه إلى "director"
- Year (int) يتم تعيينه إلى "year"
- Rating (float64) يتم تعيينه إلى "rating" مع خاصية omitempty حتى لا تظهر الأفلام غير المصنفة حقل التقييم
- InternalID (string) يجب استبعاده من JSON تماماً باستخدام "-"
قم بإنشاء دالة ToJSON(m Movie) string تقوم بتحويل Movie إلى سلسلة نصية بتنسيق JSON. وقم أيضاً بإنشاء FromJSON(jsonStr string) Movie التي تقوم بتحليل سلسلة JSON النصية وإعادتها إلى هيكل Movie.
main.go: عرض عملية تحويل JSON في كلا الاتجاهين.
اقرأ نوع العملية (encode أو decode).

بالنسبة لـ encode: اقرأ تفاصيل الفيلم (العنوان، المخرج، السنة، التقييم) في أسطر منفصلة. قم بإنشاء Movie مع InternalID بقيمة "internal-123"، وقم بتحويله إلى JSON، واطبع النتيجة.

بالنسبة لـ decode: اقرأ سلسلة JSON نصية، وقم بتحويلها إلى هيكل Movie، واطبع تفاصيل الفيلم بهذا التنسيق:
```
Title: [title]
Director: [director]
Year: [year]
Rating: [rating]
```
اعرض التقييم بمنزلة عشرية واحدة. إذا كان التقييم 0 (غير موجود في JSON)، اطبع Rating: N/A بدلاً من ذلك.

سيتم توفير المدخلات التالية:

السطر 1: نوع العملية (encode أو decode)
بالنسبة لـ encode: العنوان، المخرج، السنة، التقييم (أربعة أسطر)
بالنسبة لـ decode: سلسلة JSON نصية (سطر واحد)

على سبيل المثال، إذا كان المدخل:

encode
Inception
Christopher Nolan
2010
8.8

يجب أن يكون مخرجك:

{"title":"Inception","director":"Christopher Nolan","year":2010,"rating":8.8}

لاحظ أن InternalID لا يظهر في المخرج بسبب وسم "-".

وإذا كان المدخل:

encode
The Matrix
Wachowskis
1999
0

يجب أن يكون مخرجك:

{"title":"The Matrix","director":"Wachowskis","year":1999}

لاحظ أن rating تم حذفه لأنه صفر ويحتوي على omitempty.

وإذا كان المدخل:

decode
{"title":"Interstellar","director":"Christopher Nolan","year":2014,"rating":8.6}

يجب أن يكون مخرجك:

Title: Interstellar
Director: Christopher Nolan
Year: 2014
Rating: 8.6

وإذا كان المدخل:

decode
{"title":"Tenet","director":"Christopher Nolan","year":2020}

يجب أن يكون مخرجك:

Title: Tenet
Director: Christopher Nolan
Year: 2020
Rating: N/A

ورقة مرجعية

تقوم حزمة encoding/json بتحويل هياكل Go (structs) إلى JSON والعكس باستخدام json.Marshal و json.Unmarshal.

لتحويل هيكل (struct) إلى JSON:

type User struct {
    Name  string `json:"name"`
    Email string `json:"email"`
    Age   int    `json:"age"`
}

user := User{Name: "Alice", Email: "alice@example.com", Age: 30}
data, _ := json.Marshal(user)
fmt.Println(string(data))
// {"name":"Alice","email":"alice@example.com","age":30}

لتحويل JSON مرة أخرى إلى هيكل (struct):

jsonStr := `{"name":"Bob","email":"bob@example.com","age":25}`
var user User
json.Unmarshal([]byte(jsonStr), &user)
fmt.Println(user.Name)  // Bob

تتحكم وسوم الهياكل (Struct tags) في تعيين حقول JSON:

`json:"name"` - يربط الحقل بمفتاح JSON "name"
`json:"price,omitempty"` - يتجاهل الحقل إذا كانت قيمته صفرية (zero value)
`json:"-"` - يستبعد الحقل من JSON تماماً

type Product struct {
    ID       int     `json:"id"`
    Name     string  `json:"name"`
    Price    float64 `json:"price,omitempty"`
    Internal string  `json:"-"`
}

يتم تضمين الحقول المصدرة فقط (التي تبدأ بحرف كبير Capitalized) في مخرجات JSON.

جرّب بنفسك

package main

import (
	"bufio"
	"fmt"
	"os"
	"strconv"
	"strings"
)

func main() {
	reader := bufio.NewReader(os.Stdin)

	// قراءة نوع العملية
	operation, _ := reader.ReadString('\n')
	operation = strings.TrimSpace(operation)

	if operation == "encode" {
		// قراءة تفاصيل الفيلم
		title, _ := reader.ReadString('\n')
		title = strings.TrimSpace(title)

		director, _ := reader.ReadString('\n')
		director = strings.TrimSpace(director)

		yearStr, _ := reader.ReadString('\n')
		yearStr = strings.TrimSpace(yearStr)
		year, _ := strconv.Atoi(yearStr)

		ratingStr, _ := reader.ReadString('\n')
		ratingStr = strings.TrimSpace(ratingStr)
		rating, _ := strconv.ParseFloat(ratingStr, 64)

		// TODO: إنشاء هيكل Movie بالقيم المقروءة
		// تعيين InternalID إلى "internal-123"
		// التحويل إلى JSON باستخدام ToJSON وطباعة النتيجة

	} else if operation == "decode" {
		// قراءة نص JSON
		jsonStr, _ := reader.ReadString('\n')
		jsonStr = strings.TrimSpace(jsonStr)

		// TODO: تحويل JSON إلى Movie باستخدام FromJSON
		// طباعة تفاصيل الفيلم بالتنسيق المطلوب
		// استخدام fmt.Sprintf("%.1f", rating) لتنسيق التقييم
		// إذا كان rating هو 0، اطبع "Rating: N/A" بدلاً من ذلك

	}
}