如何使用Jsonserializable界面

在過去的幾年中，JSON接管了數據互換格式的國王。在JSON之前，XML統治了棲息地。它擅長建模複雜的數據，但是很難解析，而且非常詳細。 JSON確實隨著Ajax驅動的站點的擴散而脫穎而出，因為它是一種非常可讀的格式，快速解析，其簡單的密鑰/價值表示削減了XML的所有冗長。

>我認為我們都可以同意，編寫較少的代碼又需要更少的維護，而較少的錯誤是我們都希望實現的目標。在這篇文章中，我想向您介紹一個鮮為人知的界面，該界面是在PHP 5.4.0中引入的，稱為Jsonserializable。 在可用jsonserializable接口之前，

返回json編碼對象的json代表以進行消費服務。

鑰匙要點

PHP 5.4.0中的JsonSerializable接口

提供了一種更有效的方法來返回對象的JSON編碼表示形式，從而消除了對像外部構造數據結構或將對象內的編碼功能內化的需求。

jsonserializable接口允許在類中實現jsonserialize方法，當該類的實例編碼JSON時，該方法會自動觸發。此方法返回對像數據的數組，簡化瞭如果需要更改，則更新數據的過程。

實現JsonSerializable接口可增強代碼可維護性並降低引入錯誤的機會，因為它可以消除重複，並使其他人更容易通過檢查對象進行編碼的能力，以檢查該對像是否是JSonSerializable的實例。
醜陋
>第一種方法是在對像外構建一個數據結構，其中包含我們要公開的所有數據。
• >

>我們在這裡使用一個數組來保存我們要編碼的客戶對象的數據，但它很容易成為stdclass。

這種方法很靈活，並且在非常簡單的情況下達到了目的，我們知道客戶對像不會改變，我們只需要以這種格式的客戶數據，在這個地方。如果需要的話，我們還可以選擇從其他來源添加數據。

> 但是，由於我們一次或一次經歷過，我們做出的假設可以在一會兒通知中被證明是錯誤的。我們可能需要要求我們在客戶類中添加更多數據。這些新數據將需要返回到消費服務，我們希望在許多地方進行此操作。您可以想像，這種方法很快變得麻煩。我們不僅必須在我們的應用程序上複製此數組代碼，而且還必須記住要更新所有這些實例時，當更多更改不可避免地進來時。但是，這有另一種方法，這將有助於我們無效這些問題。

不良

幸運的是，當第一個更改請求進來時，我們很聰明，我們意識到復制陣列將是一場噩夢，因此我們決定要做的是內部化對像中的編碼功能，從而消除了維護問題並減少了維護問題引入錯誤的可能性。

現在，如果還有更多更改請求，希望將更多數據添加到客戶對像中並返回，我們可以更新tojson方法。

<span><span><?php </span></span><span>
</span><span><span>class Customer
</span></span><span><span>{
</span></span><span>
</span><span>    <span>private $email = null;
</span></span><span>    <span>private $name = null;
</span></span><span>
</span><span>    <span>public function __construct($email, $name)
</span></span><span>    <span>{
</span></span><span>        <span>$this->email = $email;
</span></span><span>        <span>$this->name = $name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getName()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getEmail()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->email;
</span></span><span>    <span>}
</span></span><span><span>}
</span></span><span>
</span><span><span>$customer = new Customer('customer@sitepoint.com', 'Joe');
</span></span><span>
</span><span><span>$data = [
</span></span><span>    <span>'customer' => [
</span></span><span>        <span>'email' => $customer->getEmail(),
</span></span><span>        <span>'name' => $customer->getName()
</span></span><span>    <span>]
</span></span><span><span>];
</span></span><span>
</span><span><span>echo json_encode($data);</span></span></span>

這種方法具有自己的缺點。隨之而來的其他人想要使用我們的客戶的人都需要意識到這一方法，因為這不是很容易檢查的東西，因此我們需要準確的文檔。我們還必須記住，現在此方法

現在返回

JSON（儘管我們可以將序列化移到方法之外）。這使得將客戶數據與其他數據源組合起來更加尷尬，因為我們必須小心不要再次編碼此方法的結果，因為這會導致一些討厭的錯誤。 好

最後，輸入Jsonserializable界面。這為我們提供了醜陋場景的所有靈活性，並具有不良情況的可維護性優勢。儘管要使用此界面，您仍需要運行PHP 5.4.0，無論如何您都應該這樣做，因為對較舊版本有很多改進。

>

>，從事業務。

如您所見，我們通過將界面添加到我們的類中，然後將JsonSerialize方法添加到同類的正文中以滿足接口合同。 在JSonSerialize方法中，我們構建並返回對像數據的數組，就像對其他示例一樣。如果有任何變化，我們可以再次更新此方法。您會注意到jsonserialize方法只是返回一個數組。

魔術是在您要觸發此方法時出現的，我們現在要做的就是JSON編碼此類實例，此方法將自動稱為“返回的數據數組”，然後編碼！現在，該類實現接口，我們可以從能夠檢查此類是否是JsonSerializable的實例中受益。如果您想要的話，您還可以在方法中鍵入提示，以確保傳遞Jsonserializable接口。

<span><span><?php </span></span><span>
</span><span><span>class Customer
</span></span><span><span>{
</span></span><span>
</span><span>    <span>public $email = null;
</span></span><span>    <span>public $name = null;
</span></span><span>
</span><span>    <span>public function __construct($email, $name)
</span></span><span>    <span>{
</span></span><span>        <span>$this->email = $email;
</span></span><span>        <span>$this->name = $name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getName()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getEmail()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->email;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function toJson()
</span></span><span>    <span>{
</span></span><span>        <span>return json_encode([
</span></span><span>            <span>'customer' => [
</span></span><span>                <span>'email' => $this->getEmail(),
</span></span><span>                <span>'name' => $this->getName()
</span></span><span>            <span>]
</span></span><span>        <span>]);
</span></span><span>    <span>}
</span></span><span><span>}
</span></span><span>
</span><span><span>$customer = new Customer('customer@sitepoint.com', 'Joe');
</span></span><span>
</span><span><span>echo $customer->toJson();</span></span></span>

摘要

通過這種簡單的實現，我們刪除了重複，減少了維護量並減少了引入錯誤的機會。我們還使使用我們的代碼來測試對象的能力來編碼是否是JSonserializable的實例來測試對象的能力。

>上面的示例當然是人為的，但是，我希望我設法證明了使用此界面的好處，並激發了您自己繼續使用。

經常詢問有關JSonserializable接口的問題（常見問題解答）

> php？

中JsonSerializable接口的主要目的是什麼，PHP中的Jsonserializable接口主要用於自定義對象的JSON表示。當對像傳遞到JSON_ENCODE（）函數時，如果它實現了JsonSerializable接口，則將調用JsonSerialize（）方法，從而允許對象決定如何序列化。這提供了對JSON輸出的高度控制，使得在編碼數據之前更容易管理複雜的數據結構或對數據進行轉換。 jsonserialize（）方法是jsonserializable接口的一部分。當實現此接口的對像傳遞給JSON_ENCODE（）時，jSonserialize（）方法會自動調用。此方法應返回準備序列化為JSON的數據結構。這可能是一個數組，一個字符串，一個數字，甚至是另一個對象。然後，返回的數據將由JSON_ENCODE（）編碼為JSON字符串。

>我可以使用jsonserializable界面與私有屬性嗎？

是的，您可以將jsonserializizizizizable接口與私人屬性一起使用。 jsonserialize（）方法可以訪問對象的私有和受保護的屬性，從而使您可以將這些屬性包含在返回的序列化數據中。當您想將對象的內部狀態編碼為JSON時，這可能很有用，但仍將屬性保留在類中。 >如果在jsonserialize（）方法中拋出異常，則不會被json_encode（）捕獲。相反，JSON_ENCODE（）將返回false，並且需要單獨捕獲和處理例外。要處理jsonserialize（）中的異常，您可以在方法本身中使用一個try-catch塊，從而使您可以管理異常並返回有效的數據結構以序列化。 我可以使用jsonserializizable界面來解碼JSON ？

不，jsonserializable接口僅用於將對象編碼為JSON。要解碼JSON，您將使用JSON_DECODE（）函數。但是，您可以在類中創建一種方法來處理JSON字符串的對象的解碼和重建。

>如何使用嵌套對象使用jsonserializable接口？

>如果您有一個包含其他對象的對象，並且要將整個結構編碼到JSON中，則每個嵌套對像還必須實現jsonserialializizizizizizizizizizizizizizizizizizizizizizizizizizizizi面接口。當在父對像上調用JSON_ENCODE（）時，它還將在每個嵌套對像上調用jsonserialize（），允許每個對象指定應如何序列化。

>

>我可以使用jsonserializable interface帶有陣列嗎？ >

是的，您可以使用數組使用JsonSerializable接口。如果數組包含對象，則每個對像都應實現jsonserializable接口。當在數組上調用json_encode（）時，它將在數組中的每個對像上調用jsonserialize（），允許每個對像都可以決定如何序列化。

>

>我如何使用JSON OUTPUTS自定義JSON OUTPUT ？

您可以通過從jsonserialize（）方法返回自定義數據結構來自定義JSON輸出。這可能是帶有自定義鍵，字符串，數字或其他對象的數組。您從jsonserialize（）返回的數據結構將是編碼為json的數據。

我可以使用多維陣列使用jsonserializable界面嗎？

是的，您可以使用jsonserializable界面的接口多維陣列。如果數組包含對象，則每個對像都應實現JsonSerializable接口。當在多維陣列上調用JSON_ENCODE（）時，它將在數組中的每個對像上調用JsonSerialize（），允許每個對像都可以決定如何序列化。

>

我可以使用jsonserializable interface and jsonserializable界面陣列？

是的，您可以使用具有非締合數組的Jsonserializizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizizable界面。如果數組包含對象，則每個對像都應實現jsonserializable接口。當json_encode（）在非求和數組上調用時，它將在數組中的每個對像上調用jsonserialize（），允許每個對像都決定如何序列化。

>

以上是如何使用Jsonserializable界面的詳細內容。更多資訊請關注PHP中文網其他相關文章！