将PHP对象序列化为JSON


101

因此,当我偶然发现新的JsonSerializable Interface时,我在php.net上四处徘徊,以获取有关将PHP对象序列化为JSON的信息。它只是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)

所以这是toArray()我为Mf_Data课程设计的功能:

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()不横切继承/实现)。

使用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'
        )));
    }

}

4
+1好的问题,尚不知道此功能。
Takehin 2011年

@takeshin-是的,文档页面上的编辑日期是4天前。我很高兴看到它!
Dan Lugg

2
为了供其他参考,json_encode可以很好地处理对象。但是,它仅编码该对象的公共成员。因此,如果您具有保护类或私有类变量,则需要一种发布的方法或JsonSerializable。
马修·赫伯斯特

@MatthewHerbst当然。现在,旧的问题已经很老了,<5.4绝对不是(或者至少不应该)的选择了JsonSerializable
Dan Lugg 2014年

Answers:


45

编辑:目前是2016年9月24日,PHP 5.4已于2012-03-01发布,支持终止于 2015-09-01。不过,这个答案似乎获得了好评。如果您仍在使用PHP <5.4,则可能会带来安全隐患,并破坏您的项目。如果您没有令人信服的理由停留在<5.4或什至已经使用版本> = 5.4,请不要使用此答案,而只需使用PHP> = 5.4(或者您知道是最近的版本)并实现JsonSerializable接口


您将定义一个函数(例如named)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;
}

2
感谢@Wrikken-是否有任何捷径可用于将对象,包含在其中的对象(无论可见性或类型如何,所有成员)简化为关联数组,或将其类型转换为stdClass?我正在思考着Reflection的方向,但如果没有,我将找出一些可以递归执行的东西。
丹·拉格

反思将是漫长的道路。当您在函数的类内部时getJsonData(),可以调用get_object_vars(),然后遍历该结果以查找更多对象。
2011年

我差点理清了。现在的问题是递归。每个对象都有一个_parent属性,因此树可以遍历到根。查看我的编辑以获取更新;也许我应该问另一个问题,因为这个问题现在已经从我的原著中提取出来了。
丹·拉格

一个简单unset($array['_parent']);的步行应该可以解决问题。
2011年

太棒了,谢谢@Wrikken-我开始尝试进行复杂的相等性测试,将上下文对象$parent作为用户数据传递给array_walk_recursive()。简单即美!另外,$array["\0class\0property"]这是因为使用我的演员是因为空字节污染。我想我会切换到get_object_vars()
丹·拉格

91

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

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

7
如果您使用名称空间和自动加载器,这将提供冗长/难看的属性名称。
BetaRide 2014年

这是最好的解决方案,精确而简明!
Sujal Mandal

4
有没有办法获得更清洁的财产名称?
Christoffer

5
为什么在道具名称的开头添加\ u0000 * \ u0000?
埃里亚·魏斯

1
对私有财产没用。大家都应该了解en.wikipedia.org/wiki/Open/closed_principle
Fabian Picone

19

json_encode()将仅编码公共成员变量。因此,如果您要自己包含私有文件(如其他人所建议的那样)


8

以下代码使用反射来完成这项工作。假定您有要序列化的属性的吸气剂

    <?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;
    }  
} 

1
我现在爱上你了!我送培根,啤酒或纸杯蛋糕给您,纸杯蛋糕怎么办?
乔纳森·多斯·桑托斯

这是一个伟大的阶级!它也适用于受保护的对象项。
Roelof Berkepeis '17


2

由于您的对象类型是自定义的,因此我倾向于同意您的解决方案-使用编码方法(例如JSON或序列化内容)将其分解为较小的段,另一方面,具有相应的代码来重新构造对象。


2

我的版本:

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


正是我想要的。解决私人问题。简单而小巧。
Fabian Picone


1

改变你的变量类型privatepublic

这很简单并且更易读。

例如

不起作用;

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)
   }
}

这很奇怪。但它是真的。
Abilogos

0

我做了一个很好的帮助程序类,它将带有get方法的对象转换为数组。它不依赖于属性,仅依赖于方法。

所以我有一个包含两个方法的以下审阅对象:

评论

  • getAmountReviews:int
  • getReviews:评论数组

评论

  • 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 Serializer,它将对象转换为可以编码为JSON的数组。

您要做的就是将json_encode包装在输出中。

有关脚本的一些信息:

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

-7

我在同一个问题上花了几个小时。我要转换的对象包含许多其他我不应该涉及的定义(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;
}

还有一个很好且准确的答案已经被接受。您的答案是否添加了根本不同,更有效或更紧凑的内容?我猜不是
Yaroslav

我要说实话;我认为这根本无法回答问题。
Dan Lugg 2013年

5
大约六个月了;由于投票的缘故,我定期回到这里,并为以后的访问者做一些编辑。我仍然不知道这该怎么办。
Dan Lugg 2014年

unlink($thisAnswer);
丹·拉格

人们倾向于低估他们不了解的东西。也许并不是说确切的解决方案,但值得研究。在这种情况下,您需要在降级投票之前进行澄清。
Gimali
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.