Как кодировать объекты 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, чтобы избежать циклирования..,

ОТВЕТЫ

Ответ 1

Другой вариант - использовать 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;

Ответ 2

Теперь с помощью 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);

Ответ 3

Вы можете автоматически закодировать 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');

Ответ 4

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

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

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

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

J

Ответ 5

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

#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

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

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

Я не хотел реализовывать пользовательский нормализатор, так как этот 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);
    }

}

Ответ 7

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

Я создал классы, которые реализуют 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

Ответ 8

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

Ответ 9

в 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 останутся.

Ответ 10

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

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

    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()]);
}

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

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

Готово!

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

Ответ 11

Когда вам нужно создать много конечных точек API REST на Symfony, лучший способ - использовать следующий пакет пакетов:

  • JMSSerializerBundle для сериализации сущностей Doctrine
  • FOSRestBundle пакет для прослушивания прослушивания. Также он может генерировать определение маршрутов на основе имени контроллера/действия.
  • 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.

Ответ 12

Теперь вы можете также использовать Doctrine ORM Transformations для преобразования объектов в скалярные массивы и обратно