PHP序列化和反序列化深度剖析实例讲解

这篇文章主要介绍了PHP序列化和反序列化深度剖析实例讲解,实例讲解的非常详细,有对这方面不太懂的同学可以研究学习下。

目录

序列化

序列化格式

序列化对象

对象序列化自定义

序列化对象存储

反序列化

使用方法

未定义类的处理

PHP预定义序列化接口Serializable

序列化

序列化格式

在PHP中,序列化用于存储或传递 PHP 的值的过程中,同时不丢失其类型和结构。

序列化函数原型如下:

string serialize ( mixed $value )

先看下面的例子:

  1. class CC {
  2. public $data;
  3. private $pass;
  4. public function __construct($data, $pass) {
  5. $this->data = $data;
  6. $this->pass = $pass;
  7. }
  8. }
  9. $number = 34;
  10. $str = 'uusama';
  11. $bool = true;
  12. $null = NULL;
  13. $arr = array('a' => 1, 'b' => 2);
  14. $cc = new CC('uu', true);
  15. var_dump(serialize($number));
  16. var_dump(serialize($str));
  17. var_dump(serialize($bool));
  18. var_dump(serialize($null));
  19. var_dump(serialize($arr));
  20. var_dump(serialize($cc));

输出结果为:

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

所以序列化对于不同类型得到的字符串格式为:

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

序列化对象

从上面的例子中我们可以看出序列化对象的时候,只会保存属性值。

那么对象中的常量会不会保存呢?

如果是继承,父类的变量会不会保存呢

  1. class CB {
  2. public $CB_data = 'cb';
  3. }
  4. class CC extends CB {
  5. const SECOND = 60;
  6. public $data;
  7. private $pass;
  8. public function __construct($data, $pass) {
  9. $this->data = $data;
  10. $this->pass = $pass;
  11. }
  12. public function setPass($pass) {
  13. $this->pass = $pass;
  14. }
  15. }
  16. $cc = new CC('uu', true);
  17. 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接口来替代。

常用于保存那些大对象时的清理工作,避免保存过多冗余数据

看下面的例子:

  1. class User{
  2. const SITE = 'uusama';
  3. public $username;
  4. public $nickname;
  5. private $password;
  6. public function __construct($username, $nickname, $password)
  7. {
  8. $this->username = $username;
  9. $this->nickname = $nickname;
  10. $this->password = $password;
  11. }
  12. // 重载序列化调用的方法
  13. public function __sleep()
  14. {
  15. // 返回需要序列化的变量名,过滤掉password变量
  16. return array('username', 'nickname');
  17. }
  18. }
  19. $user = new User('uusama', 'uu', '123456');
  20. var_dump(serialize($user));

返回结果如下,显然序列化的时候忽略了 password 字段的值。

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

序列化对象存储

通过上面的介绍,我们可以把一个复制的对象或者数据序列化成一个序列字符串,保存值的同事还保存了他们的结构。

我们可以把序列化之后的值保存起来,存在文件或者缓存里面。不推荐存在数据库里面,可读性查,而且不便于迁移维护,不便于查询。

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

反序列化

使用方法

通过上面的讲解,我们可以将对象序列化为字符串并保存起来,那么如何把这些序列化后的字符串恢复成原样呢?PHP提供了反序列函数:

mixed unserialize ( string $str )

unserialize()反序列化函数用于将单一的已序列化的变量转换回 PHP 的值。

如果传递的字符串不可解序列化,则返回 FALSE,并产生一个E_NOTICE

返回的是转换之后的值,可为integer、 float、string、array或object

若被反序列化的变量是一个对象,在成功重新构造对象之后,PHP会自动地试图去调用__wakeup()成员函数(如果存在的话)

看下面的例子:

  1. class User{
  2. const SITE = 'uusama';
  3. public $username;
  4. public $nickname;
  5. private $password;
  6. private $order;
  7. public function __construct($username, $nickname, $password)
  8. {
  9. $this->username = $username;
  10. $this->nickname = $nickname;
  11. $this->password = $password;
  12. }
  13. // 定义反序列化后调用的方法
  14. public function __wakeup()
  15. {
  16. $this->password = $this->username;
  17. }
  18. }
  19. $user_ser = 'O:4:"User":2:{s:8:"username";s:6:"uusama";s:8:"nickname";s:2:"uu";}';
  20. var_dump(unserialize($user_ser));

输出结果为:

  1. object(User)#1 (4) {
  2. ["username"]=>
  3. string(6) "uusama"
  4. ["nickname"]=>
  5. string(2) "uu"
  6. ["password":"User":private]=>
  7. string(6) "uusama"
  8. ["order":"User":private]=>
  9. NULL
  10. }

可以得出以下结论:

__wakeup()函数在对象被构建以后执行,所以$this->username的值不为空

反序列化时,会尽量将变量值进行匹配并复制给序列化后的对象

未定义类的处理

在上面的例子中,我们在调用反序列化函数unserialize()之前,提前定义了User类,如果我们没有定义会怎么样呢?

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

这个例子中,我们没有定义任何的User类,反序列化正常执行,并没有报错,得到的结果如下:

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

注意对比之前定义了User类的结果,这儿反序列化得到的对象是__PHP_Incomplete_Class,并指定了未定义类的类名。

如果这个时候我们去使用这个反序列化后的不明对象,则会抛出E_NOTICE。这么看着不能用也不是办法,那么如何处理呢?有两种方案。

定义__autoload()等函数,指定发现未定义类时加载类的定义文件

可通过 php.ini、ini_set() 或 .htaccess 定义unserialize_callback_func,每次实例化一个未定义类时它都会被调用

以上两种方案的实现如下:

  1. // unserialize_callback_func 从 PHP 4.2.0 起可用
  2. ini_set('unserialize_callback_func', 'mycallback'); // 设置您的回调函数
  3. function mycallback($classname)
  4. {
  5. // 只需包含含有类定义的文件
  6. // $classname 指出需要的是哪一个类
  7. }
  8. // 建议使用下面的函数,代替__autoload()
  9. spl_autoload_register(function ($class_name) {
  10. // 动态加载未定义类的定义文件
  11. require_once $class_name . '.php';
  12. });

PHP预定义序列化接口Serializable

还记得上面在将序列化过程中遇到的:无法在__sleep()方法中返回父类对象的问题吗,方法就是实现序列化接口Serializable。

该接口的原型如下:

  1. Serializable {
  2. abstract public string serialize ( void )
  3. abstract public mixed unserialize ( string $serialized )
  4. }

需要注意的是,如果定义的类实现了Serializable接口,那么序列化和反序列化的时候,PHP就不会再去调用__sleep()方法和__wakeup()方法。

  1. class CB implements Serializable{
  2. public $CB_data = '';
  3. private $CB_password = 'ttt';
  4. public function setCBPassword($password)
  5. {
  6. $this->CB_password = $password;
  7. }
  8. public function serialize()
  9. {
  10. echo __METHOD__ . "\n";
  11. return serialize($this->CB_password);
  12. }
  13. public function unserialize($serialized)
  14. {
  15. echo __METHOD__ . "\n";
  16. }
  17. }
  18. class CC extends CB {
  19. const SECOND = 60;
  20. public $data;
  21. private $pass;
  22. public function __construct($data, $pass)
  23. {
  24. $this->data = $data;
  25. $this->pass = $pass;
  26. }
  27. public function __sleep()
  28. {
  29. // 输出调用了该方法名
  30. echo __METHOD__ . "\n";
  31. }
  32. public function __wakeup()
  33. {
  34. // 输出调用了该方法名
  35. echo __METHOD__ . "\n";
  36. }
  37. }
  38. $cc = new CC('uu', true);
  39. $ser = serialize($cc);
  40. var_dump($ser);
  41. $un_cc = unserialize($ser);
  42. var_dump($un_cc);

运行结果为:

  1. CB::serialize
  2. string(24) "C:2:"CC":10:{s:3:"ttt";}"
  3. CB::unserialize
  4. object(CC)#2 (4) {
  5. ["data"]=>
  6. NULL
  7. ["pass":"CC":private]=>
  8. NULL
  9. ["CB_data"]=>
  10. string(0) ""
  11. ["CB_password":"CB":private]=>
  12. string(3) "ttt"
  13. }

可以完全定义serialize()方法,该方法返回的值就是序列化后大括号内的值,只要保证自定义序列化和反序列化的规则一致即可。