将 PHP 对象序列化为 JSON

Question

因此，当我偶然发现新的 JsonSerialized 接口。不过它只有 PHP >= 5.4，而且我在 5.3.x 环境中运行。

PHP 是如何实现这种功能的？ 5.4？

我还没有太多使用 JSON，但我正在尝试支持应用程序中的 API 层，并将数据对象（否则会发送到视图）转储到 JSON 中完美的。

如果我尝试直接序列化对象，它会返回一个空的 JSON 字符串；这是因为我假设 json_encode() 不知道该对象到底要做什么。我应该递归地将对象减少到数组中，然后对其进行编码吗？

---

示例

$data = new Mf_Data();
$data->foo->bar['hello'] = 'world';

echo json_encode($data) 生成一个空对象：

{}

var_dump($data) 但是，按预期工作：

object(Mf_Data)#1 (5) {
  ["_values":"Mf_Data":private]=>
  array(0) {
  }
  ["_children":"Mf_Data":private]=>
  array(1) {
    [0]=>
    array(1) {
      ["foo"]=>
      object(Mf_Data)#2 (5) {
        ["_values":"Mf_Data":private]=>
        array(0) {
        }
        ["_children":"Mf_Data":private]=>
        array(1) {
          [0]=>
          array(1) {
            ["bar"]=>
            object(Mf_Data)#3 (5) {
              ["_values":"Mf_Data":private]=>
              array(1) {
                [0]=>
                array(1) {
                  ["hello"]=>
                  string(5) "world"
                }
              }
              ["_children":"Mf_Data":private]=>
              array(0) {
              }
              ["_parent":"Mf_Data":private]=>
              *RECURSION*
              ["_key":"Mf_Data":private]=>
              string(3) "bar"
              ["_index":"Mf_Data":private]=>
              int(0)
            }
          }
        }
        ["_parent":"Mf_Data":private]=>
        *RECURSION*
        ["_key":"Mf_Data":private]=>
        string(3) "foo"
        ["_index":"Mf_Data":private]=>
        int(0)
      }
    }
  }
  ["_parent":"Mf_Data":private]=>
  NULL
  ["_key":"Mf_Data":private]=>
  NULL
  ["_index":"Mf_Data":private]=>
  int(0)
}

---

附录

1)

这就是我为 Mf_Data 类设计的 toArray() 函数：

public function toArray()
{
    $array = (array) $this;
    array_walk_recursive($array, function (&$property) {
        if ($property instanceof Mf_Data) {
            $property = $property->toArray();
        }
    });
    return $array;
}

但是，由于 Mf_Data 对象也有一个参考他们的父母（包含）对象，这会因递归而失败。当我删除 _parent 引用时，它就像一个魅力。

2）

只是为了跟进，我使用的转换复杂树节点对象的最终函数是：

// class name - Mf_Data
// exlcuded properties - $_parent, $_index
public function toArray()
{
    $array = get_object_vars($this);
    unset($array['_parent'], $array['_index']);
    array_walk_recursive($array, function (&$property) {
        if (is_object($property) && method_exists($property, 'toArray')) {
            $property = $property->toArray();
        }
    });
    return $array;
}

3）

我再次跟进，实现更清晰一些。使用接口进行 instanceof 检查似乎比 method_exists() 干净得多（但是 method_exists() 会横切继承/实现< /em>）。

使用 unset() 似乎也有点混乱，似乎应该将逻辑重构为另一个方法。但是，此实现确实复制属性数组（由于array_diff_key），因此需要考虑一些事情。

interface ToMapInterface
{

    function toMap();

    function getToMapProperties();

}

class Node implements ToMapInterface
{

    private $index;
    private $parent;
    private $values = array();

    public function toMap()
    {
        $array = $this->getToMapProperties();
        array_walk_recursive($array, function (&$value) {
            if ($value instanceof ToMapInterface) {
                $value = $value->toMap();
            }
        });
        return $array;
    }

    public function getToMapProperties()
    {
        return array_diff_key(get_object_vars($this), array_flip(array(
            'index', 'parent'
        )));
    }

}

Answer 1

在最简单的情况下，类型提示应该起作用：

$json = json_encode( (array)$object );

Answer 2

---

编辑：目前是2016年9月24日，PHP 5.4已于2012年3月1日发布，支持已于2015年9月1日结束。尽管如此，这个答案似乎还是获得了支持。如果您仍在使用 PHP < 5.4，您正在造成安全风险并危及您的项目。如果您没有令人信服的理由保持在 <5.4，或者甚至已经使用版本 >= 5.4，不要使用此答案，而只使用 PHP>= 5.4（或者，您知道，最近的一个）并实现 JsonSerialized 接口

---

您可以定义一个函数，例如名为 getJsonData();，它将返回一个数组、stdClass 对象或其他具有可见属性的对象。参数而不是私有/受保护的参数，并执行 json_encode($data->getJsonData());。本质上，实现 5.4 中的函数，但手动调用它。

像这样的事情是可行的，因为从类内部调用 get_object_vars() ，可以访问私有/受保护的变量：

function getJsonData(){
    $var = get_object_vars($this);
    foreach ($var as &$value) {
        if (is_object($value) && method_exists($value,'getJsonData')) {
            $value = $value->getJsonData();
        }
    }
    return $var;
}

Answer 3

json_encode() 只会对公共成员变量进行编码。所以如果你想包括私人一旦你必须自己做（正如其他人建议的那样）

Answer 4

以下代码使用反射来完成这项工作。它假设您有要序列化的属性的 getter

    <?php

    /**
     * Serialize a simple PHP object into json
     * Should be used for POPO that has getter methods for the relevant properties to serialize
     * A property can be simple or by itself another POPO object
     *
     * Class CleanJsonSerializer
     */
    class CleanJsonSerializer {

    /**
     * Local cache of a property getters per class - optimize reflection code if the same object appears several times
     * @var array
     */
    private $classPropertyGetters = array();

    /**
     * @param mixed $object
     * @return string|false
     */
    public function serialize($object)
    {
        return json_encode($this->serializeInternal($object));
    }

    /**
     * @param $object
     * @return array
     */
    private function serializeInternal($object)
    {
        if (is_array($object)) {
            $result = $this->serializeArray($object);
        } elseif (is_object($object)) {
            $result = $this->serializeObject($object);
        } else {
            $result = $object;
        }
        return $result;
    }

    /**
     * @param $object
     * @return \ReflectionClass
     */
    private function getClassPropertyGetters($object)
    {
        $className = get_class($object);
        if (!isset($this->classPropertyGetters[$className])) {
            $reflector = new \ReflectionClass($className);
            $properties = $reflector->getProperties();
            $getters = array();
            foreach ($properties as $property)
            {
                $name = $property->getName();
                $getter = "get" . ucfirst($name);
                try {
                    $reflector->getMethod($getter);
                    $getters[$name] = $getter;
                } catch (\Exception $e) {
                    // if no getter for a specific property - ignore it
                }
            }
            $this->classPropertyGetters[$className] = $getters;
        }
        return $this->classPropertyGetters[$className];
    }

    /**
     * @param $object
     * @return array
     */
    private function serializeObject($object) {
        $properties = $this->getClassPropertyGetters($object);
        $data = array();
        foreach ($properties as $name => $property)
        {
            $data[$name] = $this->serializeInternal($object->$property());
        }
        return $data;
    }

    /**
     * @param $array
     * @return array
     */
    private function serializeArray($array)
    {
        $result = array();
        foreach ($array as $key => $value) {
            $result[$key] = $this->serializeInternal($value);
        }
        return $result;
    }  
} 

Answer 5

只需实现 PHP JsonSerialized 给出的接口即可。

Answer 6

尝试使用这个，这对我来说效果很好。

json_encode(unserialize(serialize($array)));

Answer 7

由于您的对象类型是自定义的，我倾向于同意您的解决方案 - 使用编码方法（例如 JSON 或序列化内容）将其分解为更小的片段，并在另一端有相应的代码来重新构造对象。

Answer 8

我的版本：

json_encode(self::toArray($ob))

实现：

private static function toArray($object) {
    $reflectionClass = new \ReflectionClass($object);

    $properties = $reflectionClass->getProperties();

    $array = [];
    foreach ($properties as $property) {
        $property->setAccessible(true);
        $value = $property->getValue($object);
        if (is_object($value)) {
            $array[$property->getName()] = self::toArray($value);
        } else {
            $array[$property->getName()] = $value;
        }
    }
    return $array;
}

JsonUtils： GitHub

Answer 9

将变量类型 private 更改为 public

这很简单且更具可读性。

例如

不工作；

class A{
   private $var1="valuevar1";
   private $var2="valuevar2";
   public function tojson(){
    return json_encode($this)
   }
}

正在工作；

class A{
   public $var1="valuevar1";
   public $var2="valuevar2";
   public function tojson(){
    return json_encode($this)
   }
}

Answer 10

我制作了一个很好的帮助器类，它将带有 get 方法的对象转换为数组。
它不依赖属性，只依赖方法。

所以我有一个以下评论对象，其中包含两个方法：

Review

• getAmountReviews : int
• getReviews : array of comments

Comment

• getSubject
• getDescription

我编写的脚本会将其转换为一个数组属性看起来像这样：

    {
      amount_reviews: 21,
      reviews: [
        {
          subject: "In een woord top 1!",
          description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque laoreet lacus quis eros venenatis, sed tincidunt mi rhoncus. Aliquam ut pharetra diam, nec lobortis dolor."
        },
        {
          subject: "En een zwembad 2!",
          description: "Maecenas et aliquet mi, a interdum mauris. Donec in egestas sem. Sed feugiat commodo maximus. Pellentesque porta consectetur commodo. Duis at finibus urna."
        },
        {
          subject: "In een woord top 3!",
          description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque laoreet lacus quis eros venenatis, sed tincidunt mi rhoncus. Aliquam ut pharetra diam, nec lobortis dolor."
        },
        {
          subject: "En een zwembad 4!",
          description: "Maecenas et aliquet mi, a interdum mauris. Donec in egestas sem. Sed feugiat commodo maximus. Pellentesque porta consectetur commodo. Duis at finibus urna."
       },
       {
          subject: "In een woord top 5!",
          description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque laoreet lacus quis eros venenatis, sed tincidunt mi rhoncus. Aliquam ut pharetra diam, nec lobortis dolor."
    }
]}

来源： PHP 序列化器，它将对象转换为可以编码为 JSON 的数组。

您所要做的就是将 json_encode 包装在输出周围。

有关脚本的一些信息：

• 仅添加以 get 开头的方法
• 私有方法将被忽略 构造
• 函数将被忽略
• 方法名称中的大写字符将替换为下划线和小写字符

Answer 11

我花了几个小时来解决同样的问题。
我要转换的对象包含许多其他我不应该触及的定义（API），因此我想出了一个解决方案，我想这可能会很慢，但我将其用于开发目的。

这将任何对象转换为数组

function objToArr($o) {
$s = '<?php
class base {
    public static function __set_state($array) {
        return $array;
    }
}
function __autoload($class) {
    eval("class $class extends base {}");
}
$a = '.var_export($o,true).';
var_export($a);
';
$f = './tmp_'.uniqid().'.php';
file_put_contents($f,$s);
chmod($f,0755);
$r = eval('return '.shell_exec('php -f '.$f).';');
unlink($f);
return $r;
}

这将任何对象转换为 stdClass

class base {
    public static function __set_state($array) {
        return (object)$array;
    }
}
function objToStd($o) {
$s = '<?php
class base {
    public static function __set_state($array) {
        $o = new self;
        foreach($array as $k => $v) $o->$k = $v;
        return $o;
    }
}
function __autoload($class) {
    eval("class $class extends base {}");
}
$a = '.var_export($o,true).';
var_export($a);
';
$f = './tmp_'.uniqid().'.php';
file_put_contents($f,$s);
chmod($f,0755);
$r = eval('return '.shell_exec('php -f '.$f).';');
unlink($f);
return $r;
}