serialize و unserialize

جزء من قسم Object Oriented Programming في رحلة PHP على Coddy — الدرس 49 من 91.

عندما تحتاج إلى تحويل كائن إلى سلسلة نصية للتخزين أو النقل، يستخدم PHP الـ serialization. تمنحك الدوال السحرية __serialize() و __unserialize() التحكم الكامل في البيانات التي يتم حفظها بالضبط وكيفية استعادتها.

تقوم الدالة __serialize() بإرجاع مصفوفة من البيانات ليتم تسلسلها، بينما تستقبل الدالة __unserialize() تلك المصفوفة وتُعيد بناء الكائن:

<?php
class Session {
    public function __construct(
        private string $userId,
        private array $data,
        private int $createdAt
    ) {}
    
    public function __serialize(): array {
        return [
            'userId' => $this->userId,
            'data' => $this->data
        ];
    }
    
    public function __unserialize(array $data): void {
        $this->userId = $data['userId'];
        $this->data = $data['data'];
        $this->createdAt = time();
    }
    
    public function getCreatedAt(): int {
        return $this->createdAt;
    }
}

$session = new Session("user123", ["theme" => "dark"], time());
$serialized = serialize($session);

$restored = unserialize($serialized);
echo "User: " . $restored->getCreatedAt();

لاحظ كيف يتم استثناء createdAt من التسلسل (serialization) ويحصل على طابع زمني جديد عند إلغاء التسلسل (unserialized). هذا مفيد لاستبعاد البيانات الحساسة، أو القيم المؤقتة، أو الموارد التي لا يمكن تسلسلها مثل اتصالات قاعدة البيانات.

هذه الطرق حلت محل الطرق الأقدم __sleep() و __wakeup() في PHP 7.4، مما يوفر نهجاً أكثر نظافة حيث تعمل مباشرة مع مصفوفات البيانات بدلاً من أسماء الخصائص.

التحدي

سهل

لنقم ببناء نظام تخزين مؤقت لملف تعريف المستخدم يوضح كيف تمنحك __serialize() و __unserialize() التحكم في البيانات التي يتم حفظها وكيفية استعادتها.

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

UserProfile.php — أنشئ فئة UserProfile تمثل ملف تعريف المستخدم مع إمكانيات التخزين المؤقت. استخدم خاصية constructor promotion لتعريف خصائص خاصة (private) لكل من $userId (string)، و $username (string)، و $email (string)، و $accessToken (string). أضف خاصية $cachedAt خاصة تخزن وقت تخزين ملف التعريف مؤقتًا (قم بتعيينها إلى "not cached" مبدئيًا في المنشئ). تحتاج فئتك إلى:
- __serialize() — تعيد مصفوفة تحتوي فقط على userId، و username، و email. يعتبر accessToken حساسًا ولا يجب تسلسله أبدًا. سيتم إعادة إنشاء الطابع الزمني cachedAt عند الاستعادة.
- __unserialize() — تستعيد userId، و username، و email من مصفوفة البيانات. وتعين accessToken إلى "expired" (بما أن الرموز المميزة لا ينبغي أن تستمر).
- getInfo() — تعيد سلسلة نصية بالتنسيق التالي: "[username] ([email]) - Token: [accessToken] - Cached: [cachedAt]"
main.php — قم بتضمين ملف UserProfile. ستتلقى أربعة مدخلات: معرف المستخدم، واسم المستخدم، والبريد الإلكتروني، ورمز الوصول. أنشئ مثيلًا من UserProfile بهذه القيم. اطبع ثلاثة أسطر:
- معلومات ملف التعريف الأصلي (قبل التسلسل)
- قم بتسلسل ملف التعريف باستخدام serialize()، ثم قم بإلغاء تسلسله باستخدام unserialize() لإنشاء ملف تعريف مستعاد. اطبع معلومات ملف التعريف المستعاد.
- اطبع "Token preserved: yes" أو "Token preserved: no" اعتمادًا على ما إذا كان رمز ملف التعريف المستعاد يطابق الرمز الأصلي (تلميح: لا ينبغي أن يتطابق لأن الرموز تنتهي صلاحيتها عند الاستعادة)

هذا النمط ضروري لتخزين بيانات المستخدم مؤقتًا بأمان — فأنت تريد تخزين معلومات ملف التعريف ولكن لا تريد أبدًا الاحتفاظ ببيانات الاعتماد الحساسة مثل رموز الوصول. عندما يتم استعادة ملف التعريف من التخزين المؤقت، يتم وضع علامة على الرمز كمنتهي الصلاحية، مما يجبر التطبيق على الحصول على رمز جديد.

ورقة مرجعية

تتحكم الدوال السحرية __serialize() و __unserialize() في البيانات التي يتم حفظها أثناء التسلسل (serialization) وكيفية استعادة الكائنات.

تعيد __serialize() مصفوفة من البيانات ليتم تسلسلها:

<?php
public function __serialize(): array {
    return [
        'userId' => $this->userId,
        'data' => $this->data
    ];
}

تستقبل __unserialize() المصفوفة وتعيد بناء الكائن:

<?php
public function __unserialize(array $data): void {
    $this->userId = $data['userId'];
    $this->data = $data['data'];
    $this->createdAt = time();
}

استخدم serialize() لتحويل كائن إلى سلسلة نصية و unserialize() لاستعادته:

<?php
$serialized = serialize($session);
$restored = unserialize($serialized);

هذه الدوال مفيدة لاستبعاد البيانات الحساسة، أو القيم المؤقتة، أو الموارد التي لا يمكن تسلسلها (مثل اتصالات قاعدة البيانات). يمكن إعادة توليد الخصائص بقيم جديدة أثناء عملية إلغاء التسلسل (unserialization).

جرّب بنفسك

<?php

require_once 'UserProfile.php';

// قراءة المدخلات
$userId = trim(fgets(STDIN));
$username = trim(fgets(STDIN));
$email = trim(fgets(STDIN));
$accessToken = trim(fgets(STDIN));

// TODO: إنشاء مثيل (instance) من UserProfile باستخدام قيم المدخلات

// TODO: طباعة معلومات الملف الشخصي الأصلي (قبل التسلسل)

// TODO: تسلسل (Serialize) الملف الشخصي، ثم إلغاء التسلسل (unserialize) لإنشاء ملف شخصي مستعاد

// TODO: طباعة معلومات الملف الشخصي المستعاد

// TODO: طباعة "Token preserved: yes" أو "Token preserved: no"
// بناءً على ما إذا كان رمز الوصول (token) للملف الشخصي المستعاد يطابق الأصلي

?>