当前位置:首页 > PHP教程 > php高级应用 > 列表

详解PHP序列化和反序列化

发布:smiling 来源: PHP粉丝网  添加日期:2022-07-16 09:19:27 浏览: 评论:0 

本篇文章带大家深度剖析一下PHP序列化和反序列化。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。

序列化

序列化格式

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

序列化函数原型如下:

string serialize ( mixed $value )

先看下面的例子:

  1. class CC { 
  2.  
  3.     public $data
  4.  
  5.     private $pass
  6.  
  7.  
  8.  
  9.     public function __construct($data$pass
  10.  
  11.     { 
  12.  
  13.         $this->data = $data
  14.  
  15.         $this->pass = $pass
  16.  
  17.     } 
  18.  
  19.  
  20. $number = 34; 
  21.  
  22. $str = 'uusama'
  23.  
  24. $bool = true; 
  25.  
  26. $null = NULL; 
  27.  
  28. $arr = array('a' => 1, 'b' => 2); 
  29.  
  30. $cc = new CC('uu', true); 
  31.  
  32. var_dump(serialize($number)); 
  33.  
  34. var_dump(serialize($str)); 
  35.  
  36. var_dump(serialize($bool)); 
  37.  
  38. var_dump(serialize($null)); 
  39.  
  40. var_dump(serialize($arr)); 
  41.  
  42. var_dump(serialize($cc)); 

输出结果为:

  1. string(5) "i:34;" 
  2.  
  3. string(13) "s:6:"uusama";" 
  4.  
  5. string(4) "b:1;" 
  6.  
  7. string(2) "N;" 
  8.  
  9. string(30) "a:2:{s:1:"a";i:1;s:1:"b";i:2;}" 
  10.  
  11. 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)}

序列化对象

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

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

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

  1. class CB { 
  2.  
  3.     public $CB_data = 'cb'
  4.  
  5.   
  6. class CC extends CB{ 
  7.  
  8.     const SECOND = 60; 
  9.   
  10.     public $data
  11.  
  12.     private $pass
  13.   
  14.     public function __construct($data$pass
  15.  
  16.     { 
  17.  
  18.         $this->data = $data
  19.  
  20.         $this->pass = $pass
  21.  
  22.     }  
  23.  
  24.     public function setPass($pass
  25.  
  26.     { 
  27.  
  28.         $this->pass = $pass
  29.  
  30.     } 
  31.  
  32.  
  33. $cc = new CC('uu', true); 
  34.  
  35. 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.  
  3.     const SITE = 'uusama'
  4.  
  5.  
  6.  
  7.     public $username
  8.  
  9.     public $nickname
  10.  
  11.     private $password
  12.  
  13.  
  14.  
  15.     public function __construct($username$nickname$password
  16.  
  17.     { 
  18.  
  19.         $this->username = $username
  20.  
  21.         $this->nickname = $nickname
  22.  
  23.         $this->password = $password
  24.  
  25.     } 
  26.  
  27.  
  28.  
  29.     // 重载序列化调用的方法 
  30.  
  31.     public function __sleep() 
  32.  
  33.     { 
  34.  
  35.         // 返回需要序列化的变量名,过滤掉password变量 
  36.  
  37.         return array('username''nickname'); 
  38.  
  39.     } 
  40.  
  41.  
  42. $user = new User('uusama''uu''123456'); 
  43.  
  44. 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.  
  3. $ser = serialize($user); 
  4.  
  5. // 保存在本地 
  6.  
  7. 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.  
  3.     const SITE = 'uusama'
  4.  
  5.  
  6.  
  7.     public $username
  8.  
  9.     public $nickname
  10.  
  11.     private $password
  12.  
  13.     private $order
  14.  
  15.  
  16.  
  17.     public function __construct($username$nickname$password
  18.  
  19.     { 
  20.  
  21.         $this->username = $username
  22.  
  23.         $this->nickname = $nickname
  24.  
  25.         $this->password = $password
  26.  
  27.     } 
  28.  
  29.  
  30.  
  31.     // 定义反序列化后调用的方法 
  32.  
  33.     public function __wakeup() 
  34.  
  35.     { 
  36.  
  37.         $this->password = $this->username; 
  38.  
  39.     } 
  40.  
  41.  
  42. $user_ser = 'O:4:"User":2:{s:8:"username";s:6:"uusama";s:8:"nickname";s:2:"uu";}'
  43.  
  44. var_dump(unserialize($user_ser)); 

输出结果为:

  1. object(User)#1 (4) { 
  2.  
  3.   ["username"]=> 
  4.  
  5.   string(6) "uusama" 
  6.  
  7.   ["nickname"]=> 
  8.  
  9.   string(2) "uu" 
  10.  
  11.   ["password":"User":private]=> 
  12.  
  13.   string(6) "uusama" 
  14.  
  15.   ["order":"User":private]=> 
  16.  
  17.   NULL 
  18.  

可以得出以下结论:

__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.  
  3. var_dump(unserialize($user_ser)); 

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

  1. object(__PHP_Incomplete_Class)#1 (3) { 
  2.  
  3.   ["__PHP_Incomplete_Class_Name"]=> 
  4.  
  5.   string(4) "User" 
  6.  
  7.   ["username"]=> 
  8.  
  9.   string(6) "uusama" 
  10.  
  11.   ["nickname"]=> 
  12.  
  13.   string(2) "uu" 
  14.  

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

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

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

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

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

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

PHP预定义序列化接口Serializable

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

该接口的原型如下:

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

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

  1. class CB implements Serializable{ 
  2.  
  3.     public $CB_data = ''
  4.  
  5.     private $CB_password = 'ttt'
  6.  
  7.  
  8.  
  9.     public function setCBPassword($password
  10.  
  11.     { 
  12.  
  13.         $this->CB_password = $password
  14.  
  15.     } 
  16.  
  17.  
  18.  
  19.     public function serialize() 
  20.  
  21.     { 
  22.  
  23.         echo __METHOD__ . "\n"
  24.  
  25.         return serialize($this->CB_password); 
  26.  
  27.     } 
  28.  
  29.  
  30.  
  31.     public function unserialize($serialized
  32.  
  33.     { 
  34.  
  35.         echo __METHOD__ . "\n"
  36.  
  37.     } 
  38.  
  39.  
  40.  
  41.  
  42. class CC extends CB { 
  43.  
  44.     const SECOND = 60; 
  45.  
  46.  
  47.  
  48.     public $data
  49.  
  50.     private $pass
  51.  
  52.  
  53.  
  54.     public function __construct($data$pass
  55.  
  56.     { 
  57.  
  58.         $this->data = $data
  59.  
  60.         $this->pass = $pass
  61.  
  62.     } 
  63.  
  64.  
  65.  
  66.     public function __sleep() 
  67.  
  68.     { 
  69.  
  70.         // 输出调用了该方法名 
  71.  
  72.         echo __METHOD__ . "\n"
  73.  
  74.     } 
  75.  
  76.  
  77.  
  78.     public function __wakeup() 
  79.  
  80.     { 
  81.  
  82.         // 输出调用了该方法名 
  83.  
  84.         echo __METHOD__ . "\n"
  85.  
  86.     } 
  87.  
  88.  
  89. $cc = new CC('uu', true); 
  90.  
  91. $ser = serialize($cc); 
  92.  
  93. var_dump($ser); 
  94.  
  95. $un_cc = unserialize($ser); 
  96.  
  97. var_dump($un_cc); 

运行结果为:

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

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

题外话

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

序列化和反序列化在PHP中用得不算多,在Java语言中用得比较多。其实你有没有发现,这种把一个对象或者数组的变量转化成字符串的方式,json也可以做到。

使用json来实现对象和字符串之间的转换,在PHP中显得更加直观和轻便。而且经过测试,使用json_encode()比serialize()方法更加快速,大概快2~3倍。

在我看来,序列化和反序列化是一种传输抽象数据的思想。通过定义序列化和反序列化的规则,我们可以实现将PHP中的对象序列化成字节流,然后传输给别的语言或者系统使用,这在远程调用里面非常的方便。

Tags: PHP序列化 PHP反序列化

分享到: