JMS Serializer覆盖FOSRestBundle中的组

时间:2017-09-22 14:35:32

标签: php symfony fosrestbundle jmsserializerbundle

我阅读this article有关覆盖子属性组的信息:

use JMS\Serializer\SerializationContext;

$context = SerializationContext::create()->setGroups(array(
    'Default', // Serialize John's name
    'manager_group', // Serialize John's manager
    'friends_group', // Serialize John's friends

    'manager' => array( // Override the groups for the manager of John
        'Default', // Serialize John manager's name
        'friends_group', // Serialize John manager's friends. If you do not override the groups for the friends, it will default to Default.
    ),

    'friends' => array( // Override the groups for the friends of John
        'manager_group' // Serialize John friends' managers.

        'manager' => array( // Override the groups for the John friends' manager
            'Default', // This would be the default if you did not override the groups of the manager property.
        ),
    ),
));
$serializer->serialize($john, 'json', $context);

在FOSRestBundle中,我使用带有@View属性的serializerGroups注释:

/**
 * @Rest\Get("/api/users/{id}", name="api_get_user")
 * @Rest\View(serializerGroups={"Default", "detail", "friends":{"Default"})
 */
public function getAction(Request $request, User $user = null)
{
    return $user;
}

如何使用该注释覆盖子属性?

感谢。

2 个答案:

答案 0 :(得分:5)

我终于找到了答案!如果有人找到更好更短的方式带注释,我可以奖励赏金(因为我无法取回)。

覆盖嵌套属性的唯一方法' groups是从视图中获取序列化程序上下文并从那里设置组。这是:

/**
 * @Rest\Get("/api/users/profile", name="api_get_profile")
 */
public function profileAction(Request $request)
{
    $user = $this->getUser();

    // sets different groups for nested properties
    $view = $this->view($user);
    $view->getContext()->setGroups(array(
        'Default',
        'user_detail',
        'user_profile',
        'friends' => array(
            'Default',
        )
    ));

    return $this->handleView($view);
}

这样我的profileAction将返回包含所有user_detailuser_profile组的用户,但friends属性中的项目包含一个User数组,将只包含Default组中定义的属性。

结果如下:

{
    "id": 532,
    "username": "someuser",
    "email": "someuser@example.com",
    "enabled": true,
    "last_login": "2017-11-10T09:45:51+01:00",
    "notification_id": "ABC",
    "avatar_id": 3,
    "friends": [
        {
            "id": 530,
            "username": "anotheruser",
            "avatar_id": 5
        },
        {
            "id": 554,
            "username": "johndoe",
            "avatar_id": 7
        }
    ]
}

问候。

答案 1 :(得分:3)

我们将Symfony 3.4与FOSRestBundle 2.3.1一起使用,并且嵌套的属性正在为我们注释:

class FooController extends FOSRestController
{
    /**
     * @Route("/{id}")
     * @Method({"GET"})
     * @View(serializerGroups={"Default", "api:foo:details", "subfoos"={"Default", "api:foo:summary"}})
     */
    public function fooAction(Foo $foo){
        return $foo;
    }
}

$foo->subfoos字段已与组"Default", "api:foo:summary"序列化。