PHPオブジェクトをJSONにシリアライズする


101

そのため、新しいJsonSerializable Interfaceを見つけたときに、phpオブジェクトをJSONにシリアル化する方法についてphp.net探していました。それだけだ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いい質問です。この機能はまだ知りませんでした。
takeshin

@takeshin-はい、ドキュメントページの編集日は4日前です。見てよかった!
Dan Lugg、2011

2
これを見る他の人への参照として、json_encodeはオブジェクトをうまく処理できます。ただし、そのオブジェクトのパブリックメンバーのみがエンコードされます。したがって、保護されたクラス変数またはプライベートクラス変数がある場合は、ポストされたメソッドの1つ、またはJsonSerializableのいずれかが必要です。
マシュー

@MatthewHerbst確かに。古い質問は今では古く、5.4未満はとにかくもうオプションではありません(または少なくともそうするべきではありません)間違いなくJsonSerializable
Dan Lugg

回答:


45

編集:それは現在2016-09-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の方向で考えていますが、そうでない場合は、それを再帰的に実行するための何かを見つけます。
Dan Lugg、2007

リフレクションは長い道のりでしょう。あなたがそうであるように内部のあなたには、クラスgetJsonData()の機能は、あなただけ呼び出すことができget_object_vars()、その結果をループは、複数のオブジェクトを探しています。
Wrikken

私はそれをほぼ整理しました。現在の問題は再帰です。各オブジェクトには_parentプロパティがあり、ツリーをルートまでたどることができます。更新については私の編集を参照してください。この問題は私のオリジナルから抽象化されているので、おそらく別の質問をする必要があります。
Dan Lugg、2007

unset($array['_parent']);散歩の前の簡単な方法でうまくいくはずです。
ヴリケン

素晴らしい、@ Wrikkenに感謝-コンテキストオブジェクト$parentをユーザーデータとしてに渡して、複雑な等価テストを試し始めましたarray_walk_recursive()。シンプルは美しい!また、$array["\0class\0property"]キャスティングを使用していたため、ヌルバイト汚染のためです。に切り替えると思いますget_object_vars()
Dan Lugg、2007

91

最も単純なケースでは、タイプヒントが機能するはずです。

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

7
これにより、名前空間とオートローダーを使用する場合、プロパティ名が曲がりくねったり醜くなります。
BetaRide

これは、正確で簡潔な最良のソリューションです!
Sujal Mandal 2015

4
よりクリーンなプロパティ名を取得する方法はありますか?
Christoffer

5
プロップ名の先頭に\ u0000 * \ u0000が追加されるのはなぜですか?
Elia Weiss

1
プライベートプロパティでは役に立たない。あなたはすべてen.wikipedia.org/wiki/Open/closed_principleについて学ぶ必要があります。
Fabian Picone 2017年

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


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

変数の型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)
   }
}

非常に奇妙です。しかし、それは本当です。
アビロゴス

0

getメソッドを使用してオブジェクトを配列に変換する素晴らしいヘルパークラスを作成しました。プロパティに依存するのではなく、メソッドに依存します。

したがって、2つのメソッドを含む次のreviewオブジェクトがあります。

レビュー

  • 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."
    }
]}

ソース: オブジェクトをJSONにエンコードできる配列に変換するPHPシリアライザー。

必要なのは、出力を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、

5
約6か月になります。私は賛成投票のため、そして将来の訪問者のためにいくつかの編集を行うために、定期的にここに戻ってきました。私はまだこれが一体何をすることになっているのか分かりません。
Dan Lugg、2014

unlink($thisAnswer);
Dan Lugg、2015年

人々は自分が理解していないことを反対する傾向があります。正確な解決策とは言えないかもしれませんが、調査する必要があります。そのような場合、反対票を投じる前に説明を求めます。
Gimali
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.