PHPのSerializableインターフェースとは？カスタムシリアライズの実装方法を解説

はじめに

PHPには、独自のシリアライズ処理（カスタムシリアライズ）を実装したクラスを作成するための Serializable インターフェースが用意されています。PHPの組み込み関数である serialize() は、ほとんどの値を保存可能な形式にシリアライズできますが、ユーザー定義クラスのオブジェクトはそのままではシリアライズできません。Serializableインターフェースを実装することで、この制限を回避できます。

Syntax（構文）

Serializable {
    /* メソッド */
    abstract public serialize ( void ) : string
    abstract public unserialize ( string $serialized ) : void
}

メソッド

Serializable::serialize — オブジェクトの文字列表現を返します。

Serializable::unserialize — シリアライズされた文字列表現からオブジェクトを再構築します。

また、組み込み関数の serialize() は、値の保存可能な表現を生成します。

serialize ( mixed $value ) : string

unserialize() 関数は、保存された表現からPHPの値を復元します。

unserialize ( string $str [, array $options ] ) : mixed

Serializableの実装例

次の例では、文字列変数を myclass のプライベートプロパティとして定義しています。組み込みの serialize() 関数の引数にこのクラスのオブジェクトを渡すと、serialize() メソッドが自動的に呼び出されます。同様に、unserialize() 関数を実行すると、文字列のプライベートプロパティを持つオブジェクトが再構築されます。

コード例

<?php
class myclass implements Serializable {
    private $arr;
    public function __construct() {
        $this->arr = "TutorialsPoint India (p) Ltd";
    }
    public function serialize() {
        echo "Serializing object..\n";
        return serialize($this->arr);
    }
    public function unserialize($data) {
        echo "Unserializing object..\n";
        $this->arr = unserialize($data);
    }
    public function getdata() {
        return $this->arr;
    }
}
$obj = new myclass;
$serobj = serialize($obj);
var_dump ($serobj);
$obj1 = unserialize($serobj);
var_dump($obj1->getdata());
?>

実行結果

上記のプログラムを実行すると、以下の出力が得られます。

Serializing object..
string(55) "C:7:"myclass":36:{s:28:"TutorialsPoint India (p) Ltd";}"
Unserializing object..
string(28) "TutorialsPoint India (p) Ltd"

このように、Serializableインターフェースを実装することで、オブジェクトがシリアライズ・アンシリアライズされる際の動作を自由にカスタマイズできます。オブジェクトの状態を独自の形式で保存したい場合や、シリアライズ時に特定の処理を挟みたい場合に非常に便利な仕組みです。