Как я могу отправить ответ JSON в контроллере Symfony2

80

Я использую jQuery для редактирования моей формы, которая встроена в Symfony.

Я показываю форму в диалоговом окне jQuery и затем отправляю ее.

Данные поступают правильно в базу данных.

Но я не знаю, нужно ли мне отправить JSON обратно в jQuery. На самом деле я немного смущен JSON.

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

Я смущен, как вернуть данные назад

Это мой текущий код

$editForm = $this->createForm(new StepsType(), $entity);

$request = $this->getRequest();

$editForm->bindRequest($request);

if ($editForm->isValid()) {
    $em->persist($entity);
    $em->flush();

    return $this->render('::success.html.twig');               
}

Это только шаблон с успешным сообщением

5 ответов

166
Лучший ответ

Symfony 2.1

$response = new Response(json_encode(array('name' => $name)));
$response->headers->set('Content-Type', 'application/json');

return $response;

Symfony 2.2 и выше

У вас есть специальный класс JsonResponse, который сериализует массив в JSON:

return new JsonResponse(array('name' => $name));

Но если ваша проблема Как сериализовать сущность, тогда вы должны взглянуть на JMSSerializerBundle p >

Предполагая, что вы его установили, вам просто нужно сделать

$serializedEntity = $this->container->get('serializer')->serialize($entity, 'json');

return new Response($serializedEntity);

Вы также должны проверить аналогичные проблемы в StackOverflow:

  • 1
    Итак, как нам сериализовать сущность и отправить ее в виде ответа JSON? Я искал это в течение недели .. stackoverflow.com/questions/14798532/…
  • 0
    Вы также можете использовать Symfony JsonResponse (Symfony \ Component \ HttpFoundation \ JsonResponse)
Показать ещё 3 комментария
53

Symfony 2.1 имеет класс JsonResponse.

return new JsonResponse(array('name' => $name));

Прошедший в массиве код JSON будет закодирован, код состояния будет по умолчанию равным 200, а тип содержимого будет установлен в application/json.

Существует также удобная функция setCallback для JSONP.

12

С Symfony 3.1 вы можете использовать JSON Helper http://symfony.com/doc/current/book/controller.html#json-helper

public function indexAction()
{
// returns '{"username":"jane.doe"}' and sets the proper Content-Type header
return $this->json(array('username' => 'jane.doe'));

// the shortcut defines three optional arguments
// return $this->json($data, $status = 200, $headers = array(), $context = array());
}
9

Чтобы закончить ответ @thecatontheflat, я бы рекомендовал также обернуть ваше действие внутри блока try ... catch. Это предотвратит прерывание конечной точки JSON для исключений. Здесь используется скелет:

public function someAction()
{
    try {

        // Your logic here...

        return new JsonResponse([
            'success' => true,
            'data'    => [] // Your data here
        ]);

    } catch (\Exception $exception) {

        return new JsonResponse([
            'success' => false,
            'code'    => $exception->getCode(),
            'message' => $exception->getMessage(),
        ]);

    }
}

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

7

Если ваши данные уже сериализованы:

a) отправить ответ JSON

public function someAction()
{
    $response = new Response();
    $response->setContent(file_get_contents('path/to/file'));
    $response->headers->set('Content-Type', 'application/json');
    return $response;
}

b) отправить ответ JSONP (с обратным вызовом)

public function someAction()
{
    $response = new Response();
    $response->setContent('/**/FUNCTION_CALLBACK_NAME(' . file_get_contents('path/to/file') . ');');
    $response->headers->set('Content-Type', 'text/javascript');
    return $response;
}

Если ваши данные должны быть сериализованы:

c) отправить ответ JSON

public function someAction()
{
    $response = new JsonResponse();
    $response->setData([some array]);
    return $response;
}

d) отправить ответ JSONP (с обратным вызовом)

public function someAction()
{
    $response = new JsonResponse();
    $response->setData([some array]);
    $response->setCallback('FUNCTION_CALLBACK_NAME');
    return $response;
}

e) использовать группы в Symfony 3.x.x

Создание групп внутри ваших объектов

<?php

namespace Mindlahus;

use Symfony\Component\Serializer\Annotation\Groups;

/**
 * Some Super Class Name
 *
 * @ORM    able("table_name")
 * @ORM\Entity(repositoryClass="SomeSuperClassNameRepository")
 * @UniqueEntity(
 *  fields={"foo", "boo"},
 *  ignoreNull=false
 * )
 */
class SomeSuperClassName
{
    /**
     * @Groups({"group1", "group2"})
     */
    public $foo;
    /**
     * @Groups({"group1"})
     */
    public $date;

    /**
     * @Groups({"group3"})
     */
    public function getBar() // is* methods are also supported
    {
        return $this->bar;
    }

    // ...
}

Нормализовать объект Doctrine внутри логики вашего приложения

<?php

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
// For annotations
use Doctrine\Common\Annotations\AnnotationReader;
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Encoder\JsonEncoder;

...

$repository = $this->getDoctrine()->getRepository('Mindlahus:SomeSuperClassName');
$SomeSuperObject = $repository->findOneById($id);

$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$encoder = new JsonEncoder();
$normalizer = new ObjectNormalizer($classMetadataFactory);
$callback = function ($dateTime) {
    return $dateTime instanceof \DateTime
        ? $dateTime->format('m-d-Y')
        : '';
};
$normalizer->setCallbacks(array('date' => $callback));
$serializer = new Serializer(array($normalizer), array($encoder));
$data = $serializer->normalize($SomeSuperObject, null, array('groups' => array('group1')));

$response = new Response();
$response->setContent($serializer->serialize($data, 'json'));
$response->headers->set('Content-Type', 'application/json');
return $response;

Ещё вопросы

Сообщество Overcoder
Наверх
Меню