Menu
CoddyTech

__serialize と __unserialize

CoddyのPHPジャーニー「オブジェクト指向プログラミング」セクションの一部。レッスン 49/91。

オブジェクトを保存または送信するために文字列に変換する必要がある場合、PHPではシリアライズを使用します。マジックメソッドの__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 "Created at: " . $restored->getCreatedAt();

createdAtがシリアライズから除外され、デシリアライズ時に新しいタイムスタンプが設定されることに注目してください。これは、機密データ、一時的な値、データベース接続のようにシリアライズできないリソースを除外するのに便利です。

これらのメソッドは PHP 7.4 で古い __sleep() メソッドと __wakeup() メソッドに取って代わり、プロパティ名ではなくデータ配列を直接扱う、よりすっきりとした方法を提供します。

challenge icon

チャレンジ

簡単

ユーザープロファイルのキャッシュシステムを作成して、__serialize()と__unserialize()を使うと、保存されるデータと復元方法をどのように制御できるかを確認しましょう。

コードを2つのファイルに分けて構成します。

  • UserProfile.php:キャッシュ機能を備えたユーザープロファイルを表すUserProfileクラスを作成します。コンストラクターのプロパティ昇格を使って、$userId(string)、$username(string)、$email(string)、$accessToken(string)のprivateプロパティを定義します。プロファイルがキャッシュされた日時を保存するprivateプロパティ$cachedAtを追加します(コンストラクターで初期値を"not cached"に設定します)。クラスには以下が必要です。
    • __serialize():userId、username、emailのみを含む配列を返します。accessTokenは機密情報なので、決してシリアライズしてはいけません。cachedAtのタイムスタンプは復元時に再生成されます。
    • __unserialize():データ配列からuserId、username、emailを復元します。トークンは保持されるべきではないため、accessTokenを"expired"に設定します。
    • getInfo():次の形式の文字列を返します:"[username] ([email]) - Token: [accessToken]"
  • main.php:UserProfileファイルを読み込みます。ユーザーID、ユーザー名、メールアドレス、アクセストークンの4つの入力を受け取ります。これらの値を使ってUserProfileのインスタンスを作成します。以下の3行を出力します。
    • シリアライズ前の元のプロファイル情報
    • serialize()を使ってプロファイルをシリアライズし、その後unserialize()を使ってデシリアライズし、復元されたプロファイルを作成します。復元されたプロファイルの情報を出力します。
    • 復元されたプロファイルのトークンが元のトークンと一致するかどうかに応じて、"Token preserved: yes"または"Token preserved: no"を出力します(ヒント:復元時にトークンは期限切れになるため、一致しないはずです)。

このパターンは、ユーザーデータを安全にキャッシュするうえで不可欠です。プロファイル情報は保存しつつ、アクセストークンのような機密性の高い認証情報は決して保持しないようにします。プロファイルがキャッシュから復元されると、トークンは期限切れとしてマークされ、アプリケーションは新しいトークンを取得する必要があります。

自分で試してみよう

<?php

require_once 'UserProfile.php';

// 入力を読み取る
$userId = trim(fgets(STDIN));
$username = trim(fgets(STDIN));
$email = trim(fgets(STDIN));
$accessToken = trim(fgets(STDIN));

// TODO: 入力値を使ってUserProfileのインスタンスを作成する

// TODO: 元のプロファイルの情報を表示する(シリアライズ前)

// TODO: プロファイルをシリアライズし、デシリアライズして復元したプロファイルを作成する

// TODO: 復元したプロファイルの情報を表示する

// TODO: "Token preserved: yes" または "Token preserved: no" を表示する
// 復元したプロファイルのトークンが元のプロファイルのトークンと一致するかどうかに応じて

?>
quiz icon腕試し

このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。

オブジェクト指向プログラミングのすべてのレッスン

自分で練習してみよう: PHPオンラインコンパイラ