Как кодировать сущности Doctrine в JSON в приложении Symfony 2.0 AJAX? - PullRequest
Новая
       33

Как кодировать сущности Doctrine в JSON в приложении Symfony 2.0 AJAX?

87 голосов
/ 15 июля 2011

Я занимаюсь разработкой игрового приложения и использую Symfony 2.0. У меня много AJAX-запросов к бэкэнду. И больше ответов - это преобразование сущности в JSON. Например: 

class DefaultController extends Controller
{           
    public function launchAction()
    {   
        $user = $this->getDoctrine()
                     ->getRepository('UserBundle:User')                
                     ->find($id);

        // encode user to json format
        $userDataAsJson = $this->encodeUserDataToJson($user);
        return array(
            'userDataAsJson' => $userDataAsJson
        );            
    }

    private function encodeUserDataToJson(User $user)
    {
        $userData = array(
            'id' => $user->getId(),
            'profile' => array(
                'nickname' => $user->getProfile()->getNickname()
            )
        );

        $jsonEncoder = new JsonEncoder();        
        return $jsonEncoder->encode($userData, $format = 'json');
    }
}

И все мои контроллеры делают одно и то же: получают сущность и кодируют некоторые из ее полей в JSON. Я знаю, что могу использовать нормализаторы и кодировать все права. Но что, если у сущности есть циклические ссылки на другую сущность? Или граф сущностей очень большой? У вас есть какие-нибудь предложения?

Я думаю о некоторой схеме кодирования для сущностей ... или использовании NormalizableInterface, чтобы избежать зацикливания ..,

Ответы [ 12 ]

146 голосов
/ 04 июля 2012

С php5.4 теперь вы можете делать: 

use JsonSerializable;

/**
* @Entity(repositoryClass="App\Entity\User")
* @Table(name="user")
*/
class MyUserEntity implements JsonSerializable
{
    /** @Column(length=50) */
    private $name;

    /** @Column(length=50) */
    private $login;

    public function jsonSerialize()
    {
        return array(
            'name' => $this->name,
            'login'=> $this->login,
        );
    }
}

А затем позвоните 

json_encode(MyUserEntity);
80 голосов
/ 13 декабря 2011

Другой вариант - использовать JMSSerializerBundle . В вашем контроллере вы затем делаете 

$serializer = $this->container->get('serializer');
$reports = $serializer->serialize($doctrineobject, 'json');
return new Response($reports); // should be $reports as $doctrineobject is not serialized

Вы можете настроить способ сериализации, используя аннотации в классе сущностей. Смотрите документацию по ссылке выше. Например, вот как вы бы исключили связанные объекты: 

 /**
* Iddp\RorBundle\Entity\Report
*
* @ORM\Table()
* @ORM\Entity(repositoryClass="Iddp\RorBundle\Entity\ReportRepository")
* @ExclusionPolicy("None")
*/
....
/**
* @ORM\ManyToOne(targetEntity="Client", inversedBy="reports")
* @ORM\JoinColumn(name="client_id", referencedColumnName="id")
* @Exclude
*/
protected $client;
39 голосов
/ 15 июля 2011

Вы можете автоматически кодировать в Json, ваш сложный объект, с помощью: 

use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer;
use Symfony\Component\Serializer\Encoder\JsonEncoder;

$serializer = new Serializer(array(new GetSetMethodNormalizer()), array('json' => new 
JsonEncoder()));
$json = $serializer->serialize($entity, 'json');
11 голосов
/ 09 июля 2013

Чтобы завершить ответ: Symfony2 поставляется с оберткой вокруг json_encode: Symfony / Компонент / HttpFoundation / JsonResponse

Типичное использование в ваших контроллерах: 

...
use Symfony\Component\HttpFoundation\JsonResponse;
...
public function acmeAction() {
...
return new JsonResponse($array);
}

Надеюсь, это поможет

J

10 голосов
/ 21 декабря 2011

Я нашел решение проблемы сериализации сущностей следующим образом: 

#config/config.yml

services:
    serializer.method:
        class: Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer
    serializer.encoder.json:
        class: Symfony\Component\Serializer\Encoder\JsonEncoder
    serializer:
        class: Symfony\Component\Serializer\Serializer
        arguments:
            - [@serializer.method]
            - {json: @serializer.encoder.json }

в моем контроллере: 

$serializer = $this->get('serializer');

$entity = $this->get('doctrine')
               ->getRepository('myBundle:Entity')
               ->findOneBy($params);


$collection = $this->get('doctrine')
               ->getRepository('myBundle:Entity')
               ->findBy($params);

$toEncode = array(
    'response' => array(
        'entity' => $serializer->normalize($entity),
        'entities' => $serializer->normalize($collection)
    ),
);

return new Response(json_encode($toEncode));

другой пример: 

$serializer = $this->get('serializer');

$collection = $this->get('doctrine')
               ->getRepository('myBundle:Entity')
               ->findBy($params);

$json = $serializer->serialize($collection, 'json');

return new Response($json);

вы даже можете настроить его для десериализации массивов в http://api.symfony.com/2.0

6 голосов
/ 07 сентября 2014

Это скорее обновление (для Symfony v: 2.7+ и JmsSerializer v: 0.13. * @ Dev) , чтобы Jms не пытался загрузить и сериализовать весь граф объектов (или в случае циклического отношения ..)

Модель: 

use Doctrine\ORM\Mapping as ORM;
use JMS\Serializer\Annotation\ExclusionPolicy;  
use JMS\Serializer\Annotation\Exclude;  
use JMS\Serializer\Annotation\MaxDepth; /* <=== Required */
/**
 * User
 *
 * @ORM\Table(name="user_table")
///////////////// OTHER Doctrine proprieties //////////////
 */
 public class User
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected   $id;

    /**
     * @ORM\ManyToOne(targetEntity="FooBundle\Entity\Game")
     * @ORM\JoinColumn(nullable=false)
     * @MaxDepth(1)
     */
    protected $game;
   /*
      Other proprieties ....and Getters ans setters
      ......................
      ......................
   */

Внутри действия: 

use JMS\Serializer\SerializationContext;
  /* Necessary include to enbale max depth */

  $users = $this
              ->getDoctrine()
              ->getManager()
              ->getRepository("FooBundle:User")
              ->findAll();

  $serializer = $this->container->get('jms_serializer');
  $jsonContent = $serializer
                   ->serialize(
                        $users, 
                        'json', 
                        SerializationContext::create()
                                 ->enableMaxDepthChecks()
                  );

  return new Response($jsonContent);
6 голосов
/ 11 августа 2012

У меня была такая же проблема, и я решил создать свой собственный кодер, который сам справится с рекурсией.

Я создал классы, которые реализуют Symfony\Component\Serializer\Normalizer\NormalizerInterface, и сервис, который содержит каждый NormalizerInterface. 

#This is the NormalizerService

class NormalizerService 
{

   //normalizer are stored in private properties
   private $entityOneNormalizer;
   private $entityTwoNormalizer;

   public function getEntityOneNormalizer()
   {
    //Normalizer are created only if needed
    if ($this->entityOneNormalizer == null)
        $this->entityOneNormalizer = new EntityOneNormalizer($this); //every normalizer keep a reference to this service

    return $this->entityOneNormalizer;
   }

   //create a function for each normalizer



  //the serializer service will also serialize the entities 
  //(i found it easier, but you don't really need it)
   public function serialize($objects, $format)
   {
     $serializer = new Serializer(
            array(
                $this->getEntityOneNormalizer(),
                $this->getEntityTwoNormalizer()
            ),
            array($format => $encoder) );

     return $serializer->serialize($response, $format);
}

Пример нормализатора: 

use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

class PlaceNormalizer implements NormalizerInterface {

private $normalizerService;

public function __construct($normalizerService)
{
    $this->service = normalizerService;

}

public function normalize($object, $format = null) {
    $entityTwo = $object->getEntityTwo();
    $entityTwoNormalizer = $this->service->getEntityTwoNormalizer();

    return array(
        'param' => object->getParam(),
        //repeat for every parameter
        //!!!! this is where the entityOneNormalizer dealt with recursivity
        'entityTwo' => $entityTwoNormalizer->normalize($entityTwo, $format.'_without_any_entity_one') //the 'format' parameter is adapted for ignoring entity one - this may be done with different ways (a specific method, etc.)
    );
}

}

В контроллере: 

$normalizerService = $this->get('normalizer.service'); //you will have to configure services.yml
$json = $normalizerService->serialize($myobject, 'json');
return new Response($json);

Полный код здесь: https://github.com/progracqteur/WikiPedale/tree/master/src/Progracqteur/WikipedaleBundle/Resources/Normalizer

6 голосов
/ 27 июля 2011

Мне просто нужно было решить ту же проблему: json-кодирование объекта («Пользователь»), имеющего двунаправленную ассоциацию «один ко многим» с другим объектом («Местоположение»).

Я перепробовал несколько вещей и теперь думаю, что нашел лучшее приемлемое решение. Идея заключалась в том, чтобы использовать тот же код, который был написан Дэвидом, но каким-то образом перехватить бесконечную рекурсию, сказав нормализатору остановиться в какой-то момент.

Я не хотел реализовывать пользовательский нормализатор, так как этот GetSetMethodNormalizer, на мой взгляд, является хорошим подходом (основанным на рефлексии и т. Д.). Поэтому я решил создать его подкласс, что на первый взгляд не тривиально, поскольку метод, позволяющий указать, следует ли включать свойство (isGetMethod), является закрытым.

Но можно переопределить метод нормализации, поэтому я перехватил на этом этапе, просто сбросив свойство, которое ссылается на «Местоположение» - так что бесконечный цикл прерывается.

В коде это выглядит так: 

class GetSetMethodNormalizer extends \Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer {

    public function normalize($object, $format = null)
    {
        // if the object is a User, unset location for normalization, without touching the original object
        if($object instanceof \Leonex\MoveBundle\Entity\User) {
            $object = clone $object;
            $object->setLocations(new \Doctrine\Common\Collections\ArrayCollection());
        }

        return parent::normalize($object, $format);
    }

}
5 голосов
/ 28 ноября 2013

в Symfony 2.3

/ приложение / Config / config.yml 

framework:
    # сервис конвертирования объектов в массивы, json, xml и обратно
    serializer:
        enabled: true

services:
    object_normalizer:
        class: Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer
        tags:
        # помечаем к чему относится этот сервис, это оч. важно, т.к. иначе работать не будет
          - { name: serializer.normalizer }

и пример для вашего контроллера: 

/**
 * Поиск сущности по ИД объекта и ИД языка
 * @Route("/search/", name="orgunitSearch")
 */
public function orgunitSearchAction()
{
    $array = $this->get('request')->query->all();

    $entity = $this->getDoctrine()
        ->getRepository('IntranetOrgunitBundle:Orgunit')
        ->findOneBy($array);

    $serializer = $this->get('serializer');
    //$json = $serializer->serialize($entity, 'json');
    $array = $serializer->normalize($entity);

    return new JsonResponse( $array );
}

но проблемы с типом поля \ DateTime останутся.

4 голосов
/ 06 января 2016

Если вы используете Symfony 2.7 или выше и не хотите включать какие-либо дополнительные пакеты для сериализации, возможно, вы можете воспользоваться этим способом для локализации сущностей доктрины в json -

  1. В моем контроллере (обычном, родительском) есть функция, которая подготавливает сериализатор 

    use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;

// -----------------------------

/**
 * @return Serializer
 */
protected function _getSerializer()
{  
    $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
    $normalizer           = new ObjectNormalizer($classMetadataFactory);

    return new Serializer([$normalizer], [new JsonEncoder()]);
}

  2. Затем используйте его для сериализации сущностей в JSON 

    $this->_getSerializer()->normalize($anEntity, 'json');
$this->_getSerializer()->normalize($arrayOfEntities, 'json');

Готово!

Но вам может потребоваться какая-то подстройка. Например -

Страница:
...