Symfony 框架内置序列化工具教程(一)

Symfony 框架内置序列化工具教程(一)

Chris Yue No Comment
Posts

不知道是从哪个版本开始(我目前用的是2.8)开始自带了序列化工具(可以不用装 JMSSerializer 啦),但除了 config.yml 文件里 framework 下的一个选项以外,再也看不到任何的信息来说明怎么去使用它。Symfony 文挡撰写的速度赶不上功能添加的速度一直是个问题,没办法只能自己从代码里去研究到底是个什么样的用法。这里将得到的一些结论分享给大家。

在 config.yml 当中:

framework:
    serializer: ~

这时将会开启一个叫做 serializer 的服务,用法:

// 假如在某个controller action里,有一个 $user 对象:
$json = $this->get('serializer')->serialize($user, 'json');
// 或者可以只normalize成一个数组
$userData = $this->get('serializer')->normalize($user);

一般来说,json 数据的 key 都是 snake_case 的风格,而默认 serialize 出来的是 camelCase 的,当然框架的开发者们早就做好了准备,我们需要做的只是再修改一下配置:

framework:
    serializer:
        name_converter: serializer.name_converter.camel_case_to_snake_case

Symfony 甚至提供了缓存的选项,并且在 config_prod.yml 里已经有相关的配置了,只不过默认被注释掉了而已:

framework:
   serializer:
       cache: serializer.mapping.cache.apc

如果看过 Symfony Serializer Component 的文档,应该知道序列化组件支持定义 group,什么意思呢?比如如下的代码:

use Symfony\Component\Serializer\Annotation\Groups;

class User
{
    /**
     * @Groups({"group1"})
     */
    public $name;

    ...
}

如果序列化的时候使用 $serializer->normalize($user, 'json', ['groups' => ['group1']]) 指定只获取 group1 的属性,那么只有 name 属性会被暴露在接口的结果里。

指定 group 可以使用 yaml 和 xml 以及 annotation,然而 annotation 默认是关闭的,但我们可以通过以下配置打开:

framework:
    serializer:
        enable_annotations: true

这一篇文章只是简单介绍 Symfony 框架序列化工具的正确打开方式,但序列化的工作远不止如此。框架默认使用 ObjectNormalizer 来获取对象的属性值(ObjectNormalizer 使用的是 Symfony PropertyAccess Component),在没有特殊要求的情况下已经可以很好的工作,下一章将告诉大家,如何使用 GetSetMethodNormalizer ,也就是只通过对象的 getter/hasser/isser 来暴露对象属性值的方式,以及添加更多的自定义 Normalizer 的方式。

Symfony 框架内置序列化工具教程(一) by Chris Yue is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

微信赞赏码

写作累,服务器还越来越贵
求分担,祝愿好人一生平安
天使打赏人

发表评论

1 + 9 =