Как использовать интерфейс JsonSerializable

За последние несколько лет JSON стал королем форматов обмена данными. До JSON XML правил рутом. Он был великолепен при моделировании сложных данных, но его трудно анализировать и он очень многословен JSON действительно вырос с распространением богатых сайтов, управляемых AJAX, так как это очень удобный для восприятия формат, быстрый анализ, а его простое представление ключ / значение исключает всю многословность XML.

Я думаю, что мы все могли бы согласиться с тем, что написание меньшего количества кода, которое в свою очередь требует меньшего количества обслуживания и вносит меньше ошибок, является целью, которую мы все хотели бы достичь В этой статье я хотел бы познакомить вас с малоизвестным интерфейсом, который был представлен в PHP 5.4.0 и называется JsonSerializable .

До того, как интерфейс JsonSerializable был доступен, возвращение JSON-закодированного представления объекта для потребляющего сервиса означало одно из двух.

Гадкий

Первый подход заключался в создании структуры данных вне объекта, которая содержала все данные, которые мы хотели представить

 <? php class   Customer 
 { 

     private  $email =   null ; 
     private  $name =   null ; 

     public   function  __construct ( $email ,  $name ) 
     { $this -> email =  $email ; $this -> name =  $name ; 
     } 

     public   function  getName () 
     { 
         return  $this -> name ; 
     } 

     public   function  getEmail () 
     { 
         return  $this -> email ; 
     } 
 } $customer =   new   Customer ( '[email protected]' ,   'Joe' ); $data =   [ 
     'customer'   =>   [ 
         'email'   =>  $customer -> getEmail (), 
         'name'   =>  $customer -> getName () 
     ] 
 ]; echo json_encode ( $data ); 

Мы использовали здесь массив для хранения данных из объекта Customer который мы хотели закодировать, но это также мог быть StdClass .

Этот подход был гибким и служил своей цели в очень простых ситуациях, когда мы знали, что объект Customer не изменится, и нам нужны только данные Customer в этом формате, в одном месте. У нас также была возможность добавлять данные в этот массив из других источников, если это было необходимо.

Однако, поскольку мы все пережили то или иное время, сделанные нами предположения могут быть подтверждены ложно в любой момент. Возможно, мы получим требование добавить больше данных в класс Customer . Эти новые данные необходимо будет вернуть потребителю, и мы хотим сделать это во многих местах.

Как вы можете себе представить, такой подход быстро становится проблематичным. Мы не только должны дублировать этот код массива по всему нашему приложению, мы также должны помнить, что нужно обновлять все эти случаи, когда неизбежно появляются дополнительные изменения. Однако есть и другой способ, который поможет нам устранить некоторые из этих проблем.

 <? php class   Customer 
 { 

     public  $email =   null ; 
     public  $name =   null ; 

     public   function  __construct ( $email ,  $name ) 
     { $this -> email =  $email ; $this -> name =  $name ; 
     } 

     public   function  getName () 
     { 
         return  $this -> name ; 
     } 

     public   function  getEmail () 
     { 
         return  $this -> email ; 
     } 

     public   function  toJson () 
     { 
         return  json_encode ([ 
             'customer'   =>   [ 
                 'email'   =>  $this -> getEmail (), 
                 'name'   =>  $this -> getName () 
             ] 
         ]); 
     } 
 } $customer =   new   Customer ( '[email protected]' ,   'Joe' ); echo $customer -> toJson (); 

 <? php class   Customer   implements   JsonSerializable 
 { 

     private  $name ; 
     private  $email ; 

     public   function  __construct ( $name ,  $email ) 
     { $this -> name =  $name ; $this -> email =  $email ; 
     } 

     public   function  getName () 
     { 
         return  $this -> name ; 
     } 

     public   function  getEmail () 
     { 
         return  $this -> email ; 
     } 

     public   function  jsonSerialize () 
     { 
         return   [ 
             'customer'   =>   [ 
                 'name'   =>  $this -> name , 
                 'email'   =>  $this -> email ] 
         ]; 
     } 
 } $customer =   new   Customer ( '[email protected]' ,   'Joe' ); echo json_encode ( $customer );