从 Symfony 中的控制器返回 JSON 数组

Question

我正在尝试从 Symfony 2 中的控制器返回 JSON 响应。例如，在 Spring MVC 中，我可以使用 @ResponseBody 注释获得 JSON 响应。我想得到一个 JSON 响应，不管它是 JSON 数组还是 Json 对象，然后在视图中使用 javascript 操作它。

我尝试下一个代码：

/**
     * @Route(
     *      "/drop/getCategory/",
     *      name="getCategory"
     * )
     * @Method("GET")
     */
    public function getAllCategoryAction() {
        $categorias = $this->getDoctrine()
                           ->getRepository('AppBundle:Categoria')
                           ->findAll();

        $response = new JsonResponse();
        $response->setData($categorias);

        $response->headers->set('Content-Type', 'application/json');
        return $response;
    }

但我在浏览器中得到[{},{}] 作为响应。我也尝试使用$response = new Response(json_encode($categorias));，但我得到了相同的结果。

Answer 1

我认为@darkangelo 的答案需要解释。

findAll() 方法返回一个对象集合。

$categorias = $this->getDoctrine()
                   ->getRepository('AppBundle:Categoria')
                   ->findAll();

要构建响应，您必须将实体的所有 getter 添加到响应中，例如：

$arrayCollection = array();

foreach($categorias as $item) {
     $arrayCollection[] = array(
         'id' => $item->getId(),
         // ... Same for each property you want
     );
}

return new JsonResponse($arrayCollection);

使用QueryBuilder 允许您将结果作为包含所有属性的数组返回：

$em = $this->getDoctrine()->getManager();
$query = $em->createQuery(
    'SELECT c
    FROM AppBundle:Categoria c'
);
$categorias = $query->getArrayResult();

return new JsonResponse($categorias);

getArrayResult() 避免了对 getter 的需要。

Answer 2

您需要这样做（基于之前的答案）：

public function getAllCategoryAction() {
    $em = $this->getDoctrine()->getManager();
    $query = $em->createQuery(
        'SELECT c
        FROM AppBundle:Categoria c'
    );
    $categorias = $query->getArrayResult();

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

    return $response;
}

它适用于 Doctrine 作为数组返回的任何查询。

Answer 3

/**
 * @Route("/api/list", name="list")
 */
public function getList(SerializerInterface $serializer, SomeRepository $repo): JsonResponse
{
    $models = $repo->findAll();
    $data = $serializer->serialize($models, JsonEncoder::FORMAT);
    return new JsonResponse($data, Response::HTTP_OK, [], true);
}

Answer 4

您需要以这种方式更改您的代码：

/**
 * @Route(
 *      "/drop/getCategory/",
 *      name="getCategory"
 * )
 * @Method("GET")
 */
public function getAllCategoryAction() {
    $categorias = $this->getDoctrine()
                       ->getRepository('AppBundle:Categoria')
                       ->findAll();

    $categorias = $this->get('serializer')->serialize($categorias, 'json');

    $response = new Response($categorias);

    $response->headers->set('Content-Type', 'application/json');
    return $response;
}

如果serializer服务没有开启，你必须在app/config/config.yml开启：

    framework:
        # ...
        serializer:
            enabled: true

更高级的序列化选项，可以安装JMSSerializerBundle

Answer 5

看起来您正试图响应一个集合。为此，您需要设置序列化程序（或将数据作为数组检索）。

查看此文档页面：http://symfony.com/doc/current/components/http_foundation/introduction.html#creating-a-json-response

和

http://symfony.com/doc/current/cookbook/serializer.html.

Answer 6

按照最佳实践，我设法做到了以下方式：

public function index(CityRepository $cityRepository,
                      SerializerInterface $serializer): Response 

注入存储库和序列化程序。

$cities = $cityRepository->findAll();

检索对象数组。

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

将数据序列化为 JSON 字符串。

return new JsonResponse($data, 200, [], true);

将 JSON 字符串传递给 JsonResponse。

Answer 7

我建议以下解决方案：

/**
     * @Route(
     *      "/drop/getCategory/",
     *      name="getCategory"
     * )
     * @Method("GET")
     */
    public function getAllCategoryAction() {
        $em = $this->getDoctrine()->getManager();
        $query = $em->createQuery(
            'SELECT c
            FROM AppBundle:Categoria c'
        );
        $categorias = $query->getArrayResult();


        return new Response(json_encode($categorias), 200);
}