Symfony 2.0 DoctrineアプリケーションでAJAXエンティティをJSONにエンコードする方法は？
ゲームアプリを開発し、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. で配列をデシリアライズするように設定することもできます
同じ問題を解決する必要がありました。別のエンティティ（「場所」）への1対多の双方向の関連付けを持つエンティティ（「ユーザー」）をjsonエンコードしました。
私はいくつかのことを試してみましたが、今では最善の解決策を見つけたと思います。アイデアは、Davidによって書かれたのと同じコードを使用することでしたが、ノーマライザーにある時点で停止するように指示することで、無限再帰を何らかの方法でインターセプトしました。
私の意見では、このGetSetMethodNormalizerはニースのアプローチであるため、カスタムノーマライザーを実装したくありませんでした（リフレクションなどに基づく）。そのため、プロパティを含めるかどうかを判断するメソッド（isGetMethod）はプライベートであるため、サブクラス化することにしました。
しかし、normalizeメソッドをオーバーライドできるため、「Location」を参照するプロパティの設定を解除するだけでこの時点でインターセプトしました。そのため、無限ループが中断されます。
コードでは次のようになります。
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 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\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);
これは更新です（Symfony v：2.7+およびJmsSerializer v：0.13。* @ devの場合）関係..）
型：
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以上を使用していて、シリアライズのために追加のバンドルを含めたくない場合は、この方法に従ってseialize doctrine 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');
できた！
ただし、微調整が必要な場合があります。例えば -
- エンティティに循環参照がある場合、 処理方法を確認してください 。
- 一部のプロパティを無視する場合は、 それを行うことができます
- さらに良いことに、 選択的な属性のみ をシリアル化できます。
Symfony上で多くのREST APIエンドポイントを作成する必要がある場合、次のバンドルのスタックを使用するのが最良の方法です。
- 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コードなしで、ブラウザーから直接エンドポイントをテストできます。
また、 Doctrine ORM Transformations を使用して、エンティティをスカラーのネストされた配列に変換し、その逆に戻すこともできます