Як кодувати сутності Doctrine до JSON у додатку Symfony 2.0 AJAX?

Я розробляю ігровий додаток і використовую 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щоб уникнути циклізму ..,

Інший варіант - використовувати 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;

За допомогою 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);

Ви можете автоматично кодувати в 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');

Щоб завершити відповідь: Symfony2 поставляється з обгорткою навколо json_encode: Symfony / Component / HttpFoundation / JsonResponse

Типове використання у ваших контролерах:

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

Сподіваюся, це допомагає

J

Я знайшов рішення проблеми серіалізації сутностей таким:

#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

Мені просто довелося вирішити ту саму проблему: 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);
    }

} 

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

Я створив класи, які реалізують 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

у Symfony 2.3

/app/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 залишаться.

Це більше оновлення (для 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);

Якщо ви використовуєте 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');
   

Готово!

Але вам може знадобитися тонка настройка. Наприклад -

• Якщо у ваших організацій є кругові посилання, перевірте, як з ними працювати .
• Якщо ви хочете проігнорувати деякі властивості, можете це зробити
• Ще краще, ви можете серіалізувати лише вибіркові атрибути .

Коли вам потрібно створити багато кінцевих точок REST API на Symfony, найкращий спосіб - використовувати наступний стек пакетів:

1. JMSSerializerBundle для серіалізації доктрин
2. Набір FOSRestBundle для прослуховувача перегляду відповідей. Також він може генерувати визначення маршрутів на основі назви контролера / дії.
3. NelmioApiDocBundle для автоматичного генерування онлайн-документації та пісочниці (що дозволяє перевіряти кінцеву точку без будь-якого зовнішнього інструменту).

Коли ви все налаштуєте належним чином, код сутності буде виглядати так:

use Doctrine\ORM\Mapping as ORM;
use JMS\Serializer\Annotation as JMS;

/**
 * @ORM\Table(name="company")
 */
class Company
{

    /**
     * @var string
     *
     * @ORM\Column(name="name", type="string", length=255)
     *
     * @JMS\Expose()
     * @JMS\SerializedName("name")
     * @JMS\Groups({"company_overview"})
     */
    private $name;

    /**
     * @var Campaign[]
     *
     * @ORM\OneToMany(targetEntity="Campaign", mappedBy="company")
     * 
     * @JMS\Expose()
     * @JMS\SerializedName("campaigns")
     * @JMS\Groups({"campaign_overview"})
     */
    private $campaigns;
}

Потім, код в контролері:

use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use FOS\RestBundle\Controller\Annotations\View;

class CompanyController extends Controller
{

    /**
     * Retrieve all companies
     *
     * @View(serializerGroups={"company_overview"})
     * @ApiDoc()
     *
     * @return Company[]
     */
    public function cgetAction()
    {
        return $this->getDoctrine()->getRepository(Company::class)->findAll();
    }
}

Переваги такої організації:

• Анотації @JMS \ Expose () в сутності можуть бути додані до простих полів та до будь-яких типів відносин. Також є можливість виставити результат виконання якогось методу (для цього використовуйте анотацію @JMS \ VirtualProperty ())
• За допомогою груп серіалізації ми можемо контролювати відкриті поля в різних ситуаціях.
• Контролери дуже прості. Метод дії може безпосередньо повернути сутність або масив сутностей, і вони будуть автоматично серіалізовані.
• А @ApiDoc () дозволяє протестувати кінцеву точку безпосередньо з браузера, без будь-якого клієнта REST або коду JavaScript

Тепер ви також можете використовувати Doctrine ORM Transformations для перетворення сутностей у вкладені масиви скалярів та назад