1. 程式人生 > >深度剖析PHP序列化和反序列化

深度剖析PHP序列化和反序列化

私有 class 文件 對象序列化 bpa php應用 OS 個人博客 def

序列化

序列化格式

在PHP中,序列化用於存儲或傳遞 PHP 的值的過程中,同時不丟失其類型和結構。

序列化函數原型如下:

string serialize ( mixed $value )

先看下面的例子:

class CC {
    public $data;
    private $pass;

    public function __construct($data, $pass)
    {
        $this->data = $data;
        $this->pass = $pass;
    }
}
$number = 34;
$str = 'uusama'
; $bool = true; $null = NULL; $arr = array('a' => 1, 'b' => 2); $cc = new CC('uu', true); var_dump(serialize($number)); var_dump(serialize($str)); var_dump(serialize($bool)); var_dump(serialize($null)); var_dump(serialize($arr)); var_dump(serialize($arr));

輸出結果為:

string(5) "i:34;"
string(13) "s:6:"uusama";"
string(4) "b:1;"
string(2) "N;"
string(30) "a:2:{s:1:"a";i:1;s:1:"b";i:2;}"
string(52) "O:2:"CC":2:{s:4:"data";s:2:"uu";s:8:" CC pass";b:1;}"

所以序列化對於不同類型得到的字符串格式為:

  • String : s:size:value;
  • Integer : i:value;
  • Boolean : b:value;(保存1或0)
  • Null : N;
  • Array : a:size:{key definition;value definition;(repeated per element)}
  • Object : O:strlen(object name):object name:object size:{s:strlen(property name):property name:property definition;(repeated per property)}

序列化對象

從上面的例子中我們可以看出序列化對象的時候,只會保存屬性值。

  • 那麽對象中的常量會不會保存呢?
  • 如果是繼承,父類的變量會不會保存呢
class CB {
    public $CB_data = 'cb';
}

class CC extends CB{
    const SECOND = 60;

    public $data;
    private $pass;

    public function __construct($data, $pass)
    {
        $this->data = $data;
        $this->pass = $pass;
    }

    public function setPass($pass)
    {
        $this->pass = $pass;
    }
}
$cc = new CC('uu', true);

var_dump(serialize($cc));

輸出結果為:

string(75) "O:2:"CC":3:{s:4:"data";s:2:"uu";s:8:" CC pass";b:1;s:7:"CB_data";s:2:"cb";}"

顯然,序列化對象時,不會保存常量的值。對於父類中的變量,則會保留。

對象序列化自定義

在序列化對象的時候,對於對象中的一些敏感屬性,我們不需要保存,這又該如何處理呢?

當調用serialize()函數序列化對象時,該函數會檢查類中是否存在一個魔術方法__sleep()。如果存在,該方法會先被調用,然後才執行序列化操作。可以通過重載這個方法,從而自定義序列化行為。該方法原型如下:

public array __sleep ( void )
  • 該方法返回一個包含對象中所有應被序列化的變量名稱的數組
  • 該方法未返回任何內容,則 NULL 被序列化,並產生一個E_NOTICE級別的錯誤
  • __sleep()不能返回父類的私有成員的名字。這樣做會產生一個E_NOTICE級別的錯誤。這時只能用Serializable接口來替代。
  • 常用於保存那些大對象時的清理工作,避免保存過多冗余數據

看下面的例子:

class User{
    const SITE = 'uusama';

    public $username;
    public $nickname;
    private $password;

    public function __construct($username, $nickname, $password)
    {
        $this->username = $username;
        $this->nickname = $nickname;
        $this->password = $password;
    }

    // 重載序列化調用的方法
    public function __sleep()
    {
        // 返回需要序列化的變量名,過濾掉password變量
        return array('username', 'nickname');
    }
}
$user = new User('uusama', 'uu', '123456');
var_dump(serialize($user));

返回結果如下,顯然序列化的時候忽略了 password 字段的值。

string(67) "O:4:"User":2:{s:8:"username";s:6:"uusama";s:8:"nickname";s:2:"uu";}"

序列化對象存儲

通過上面的介紹,我們可以把一個復制的對象或者數據序列化成一個序列字符串,保存值的同事還保存了他們的結構。

我們可以把序列化之後的值保存起來,存在文件或者緩存裏面。不推薦存在數據庫裏面,可讀性查,而且不便於遷移維護,不便於查詢。

$user = new User('uusama', 'uu', '123456');
$ser = serialize($user);
// 保存在本地
file_put_contents('user.ser', $ser);

反序列化

使用方法

通過上面的講解,我們可以將對象序列化為字符串並保存起來,那麽如何把這些序列化後的字符串恢復成原樣呢?PHP提供了反序列函數:

mixed unserialize ( string $str )

unserialize()反序列化函數用於將單一的已序列化的變量轉換回 PHP 的值。

  • 如果傳遞的字符串不可解序列化,則返回 FALSE,並產生一個E_NOTICE
  • 返回的是轉換之後的值,可為integer``floatstringarrayobject
  • 若被反序列化的變量是一個對象,在成功重新構造對象之後,PHP會自動地試圖去調用__wakeup()成員函數(如果存在的話)

看下面的例子:

class User{
    const SITE = 'uusama';

    public $username;
    public $nickname;
    private $password;
    private $order;

    public function __construct($username, $nickname, $password)
    {
        $this->username = $username;
        $this->nickname = $nickname;
        $this->password = $password;
    }

    // 定義反序列化後調用的方法
    public function __wakeup()
    {
        $this->password = $this->username;
    }
}
$user_ser = 'O:4:"User":2:{s:8:"username";s:6:"uusama";s:8:"nickname";s:2:"uu";}';
var_dump(unserialize($user_ser));

輸出結果為:

object(User)#1 (4) {
  ["username"]=>
  string(6) "uusama"
  ["nickname"]=>
  string(2) "uu"
  ["password":"User":private]=>
  string(6) "uusama"
  ["order":"User":private]=>
  NULL
}

可以得出以下結論:

  • __wakeup()函數在對象被構建以後執行,所以$this->username的值不為空
  • 反序列化時,會盡量將變量值進行匹配並復制給序列化後的對象

未定義類的處理

在上面的例子中,我們在調用反序列化函數unserialize()之前,提前定義了User類,如果我們沒有定義會怎麽樣呢?

$user_ser = 'O:4:"User":2:{s:8:"username";s:6:"uusama";s:8:"nickname";s:2:"uu";}';
var_dump(unserialize($user_ser));

這個例子中,我們沒有定義任何的User類,反序列化正常執行,並沒有報錯,得到的結果如下:

object(__PHP_Incomplete_Class)#1 (3) {
  ["__PHP_Incomplete_Class_Name"]=>
  string(4) "User"
  ["username"]=>
  string(6) "uusama"
  ["nickname"]=>
  string(2) "uu"
}

註意對比之前定義了User類的結果,這兒反序列化得到的對象是__PHP_Incomplete_Class,並指定了未定義類的類名。

如果這個時候我們去使用這個反序列化後的不明對象,則會拋出E_NOTICE。這麽看著不能用也不是辦法,那麽如何處理呢?有兩種方案。

  • 定義__autoload()等函數,指定發現未定義類時加載類的定義文件
  • 可通過 php.ini、ini_set() 或 .htaccess 定義unserialize_callback_func。每次實例化一個未定義類時它都會被調用

以上兩種方案的實現如下:

// unserialize_callback_func 從 PHP 4.2.0 起可用
ini_set('unserialize_callback_func', 'mycallback'); // 設置您的回調函數
function mycallback($classname) 
{
   // 只需包含含有類定義的文件
   // $classname 指出需要的是哪一個類
}


// 建議使用下面的函數,代替__autoload()
spl_autoload_register(function ($class_name) {
    // 動態加載未定義類的定義文件
    require_once $class_name . '.php';
});

PHP預定義序列化接口Serializable

還記得上面在將序列化過程中遇到的:無法在__sleep()方法中返回父類對象的問題嗎,方法就是實現序列化接口Serializable

該接口的原型如下:

Serializable {
    abstract public string serialize ( void )
    abstract public mixed unserialize ( string $serialized )
}

需要註意的是,如果定義的類實現了Serializable接口,那麽序列化和反序列化的時候,PHP就不會再去調用__sleep()方法和__wakeup()方法。

class CB implements Serializable{
    public $CB_data = '';
    private $CB_password = 'ttt';

    public function setCBPassword($password)
    {
        $this->CB_password = $password;
    }

    public function serialize()
    {
        echo __METHOD__ . "\n";
        return serialize($this->CB_password);
    }

    public function unserialize($serialized)
    {
        echo __METHOD__ . "\n";
    }
}

class CC extends CB {
    const SECOND = 60;

    public $data;
    private $pass;

    public function __construct($data, $pass)
    {
        $this->data = $data;
        $this->pass = $pass;
    }

    public function __sleep()
    {
        // 輸出調用了該方法名
        echo __METHOD__ . "\n";
    }

    public function __wakeup()
    {
        // 輸出調用了該方法名
        echo __METHOD__ . "\n";
    }
}
$cc = new CC('uu', true);
$ser = serialize($cc);
var_dump($ser);
$un_cc = unserialize($ser);
var_dump($un_cc);

運行結果為:

CB::serialize
string(24) "C:2:"CC":10:{s:3:"ttt";}"
CB::unserialize
object(CC)#2 (4) {
  ["data"]=>
  NULL
  ["pass":"CC":private]=>
  NULL
  ["CB_data"]=>
  string(0) ""
  ["CB_password":"CB":private]=>
  string(3) "ttt"
}

可以完全定義serialize()方法,該方法返回的值就是序列化後大括號內的值,只要保證自定義序列化和反序列化的規則一致即可。

題外話

在PHP應用中,序列化和反序列化一般用做緩存,比如session緩存,cookie等。

序列化和反序列化在PHP中用得不算多,在Java語言中用得比較多。其實你有沒有發現,這種把一個對象或者數組的變量轉化成字符串的方式,json也可以做到。

使用json來實現對象和字符串之間的轉換,在PHP中顯得更加直觀和輕便。而且經過測試,使用json_encode()serialize()方法更加快速,大概快2~3倍。

在我看來,序列化和反序列化是一種傳輸抽象數據的思想。通過定義序列化和反序列化的規則,我們可以實現將PHP中的對象序列化成字節流,然後傳輸給別的語言或者系統使用,這在遠程調用裏面非常的方便。

本文已同步到個人博客

深度剖析PHP序列化和反序列化