การทำให้ออบเจ็กต์ PHP ต่อเนื่องเป็น JSON


101

ดังนั้นผมก็เดินไปรอบ ๆphp.netสำหรับข้อมูลเกี่ยวกับ serializing วัตถุ PHP เพื่อ JSON เมื่อฉันเจอใหม่JsonSerializable อินเตอร์เฟซ เป็นเพียง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 - Yeop วันที่แก้ไขในหน้าเอกสารคือ 4 วันที่ผ่านมา ฉันดีใจที่ได้เห็น!
Dan Lugg

2
สำหรับการอ้างอิงถึงผู้อื่นที่ดูสิ่งนี้ json_encode สามารถจัดการกับวัตถุได้ดี อย่างไรก็ตามจะเข้ารหัสเฉพาะสมาชิกสาธารณะของวัตถุนั้น ดังนั้นหากคุณมีตัวแปรคลาสป้องกันหรือไพรเวตคุณต้องใช้วิธีการโพสต์อย่างใดอย่างหนึ่งหรือ JsonSerializable
Matthew Herbst

@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


คุณจะกำหนดฟังก์ชันเช่นตั้งชื่อgetJsonData();ซึ่งจะส่งคืนอาร์เรย์stdClassอ็อบเจ็กต์หรืออ็อบเจ็กต์อื่น ๆ ที่มีพารามิเตอร์ที่มองเห็นได้แทนที่จะเป็นไพรเวต / ป้องกันและทำ a 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? ฉันกำลังคิดไปในทิศทางของการสะท้อนกลับ แต่ถ้าไม่ฉันจะหาอะไรบางอย่างที่จะทำซ้ำ
Dan Lugg

การสะท้อนจะเป็นหนทางที่ยาวไกล ในขณะที่คุณอยู่ในคลาสในgetJsonData()ฟังก์ชันของคุณคุณสามารถโทรget_object_vars()และวนซ้ำผลลัพธ์นั้นเพื่อค้นหาวัตถุเพิ่มเติม
Wrikken

ฉันเกือบจะได้รับมันแล้ว ตอนนี้ปัญหาคือการเรียกซ้ำ แต่ละวัตถุมี_parentคุณสมบัติเพื่อให้ต้นไม้สามารถข้ามไปยังรากได้ ดูการแก้ไขของฉันสำหรับการอัปเดต บางทีฉันควรจะถามคำถามอื่นเพราะตอนนี้ปัญหานี้ถูกตัดทอนจากต้นฉบับของฉันแล้ว
Dan Lugg

ง่ายๆunset($array['_parent']);ก่อนการเดินควรทำเคล็ดลับ
Wrikken

น่ากลัวขอบคุณ @Wrikken - ฉันก็เริ่มที่จะลองทดสอบความเสมอภาคความซับซ้อนผ่านวัตถุบริบทเป็นผู้ใช้ข้อมูลเพื่อ$parent array_walk_recursive()เรียบง่ายสวยงาม! นอกจากนี้ยังเป็น$array["\0class\0property"]เพราะมลภาวะที่เป็นโมลไบต์เนื่องจากฉันใช้การหล่อ ฉันคิดว่าฉันจะเปลี่ยนไปget_object_vars()ใช้
Dan Lugg

91

ในกรณีที่ง่ายที่สุดควรใช้คำใบ้ประเภท:

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

7
สิ่งนี้ให้ชื่อคุณสมบัติที่ยาวและน่าเกลียดหากคุณทำงานกับเนมสเปซและตัวโหลดอัตโนมัติ
BetaRide

นี่คือทางออกที่ดีที่สุดแม่นยำและรัดกุม!
Sujal Mandal

4
มีวิธีในการรับชื่อทรัพย์สินที่สะอาดกว่านี้หรือไม่?
Christoffer

5
ทำไมจึงเพิ่ม \ u0000 * \ u0000 ในส่วนเริ่มต้นของชื่อเสา
Elia Weiss

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
ตอนนี้ฉันรักคุณมาก! ฉันจะส่งเบคอนหรือเบียร์หรือคัพเค้กให้คุณแล้วคัพเค้กล่ะ?
Jonathan dos Santos

นี่คือคลาสที่ยอดเยี่ยม! นอกจากนี้ยังใช้งานได้กับรายการวัตถุที่มีการป้องกัน
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)
   }
}

มันแปลกมาก แต่มันถูก.
Abilogos

0

ฉันสร้างคลาสตัวช่วยที่ดีซึ่งจะแปลงวัตถุด้วยวิธีการรับเป็นอาร์เรย์ มันไม่ได้อาศัยคุณสมบัติเพียงวิธีการ

ดังนั้นฉันจึงมีวัตถุตรวจสอบต่อไปนี้ซึ่งมีสองวิธี:

ทบทวน

  • 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

5
เป็นเวลาประมาณ 6 เดือน ฉันกลับมาที่นี่เป็นระยะเนื่องจากการโหวตเพิ่มขึ้นและเพื่อทำการแก้ไขบางอย่างสำหรับผู้เยี่ยมชมในอนาคต ฉันยังไม่รู้ว่ามันควรจะทำอะไร
Dan Lugg

unlink($thisAnswer);
Dan Lugg

1
inline php strings, eval, shell_exec(php)... CC-คำสั่งผสม
vp_arth
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.