如何使用序列化器

编辑本页

警告:您正在浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 5.3,现已不再维护。

本页的更新版本用于Sy欧宝娱乐app下载地址mfony 6.2(当前稳定版本)。

如何使用序列化器

欧宝娱乐app下载地址Symfony提供了一个序列化器,用于对对象和不同格式(例如JSON或XML)进行序列化/反序列化。在使用之前,请阅读序列化组件文档熟悉它的原理和标准化器和编码器术语。

安装

在使用欧宝娱乐app下载地址Symfony Flex,执行此命令安装序列化器欧宝娱乐app下载地址Symfony包使用前:

1
Composer需要symfony欧宝娱乐app下载地址/serializer-pack

使用序列化器服务

一旦启用,序列化器服务可以被注入到任何需要它的服务中,也可以在控制器中使用:

12 3 4 5 6 7 8 9 10 11 12 13
/ / src /控制器/ DefaultController.php名称空间应用程序控制器使用欧宝娱乐app下载地址FrameworkBundle控制器AbstractController使用欧宝娱乐app下载地址组件序列化器SerializerInterfaceDefaultController扩展AbstractController公共函数指数(SerializerInterface序列化器//请继续阅读使用示例}}

或者你可以用序列化模板中的树枝过滤器:

1
{{object|serialize(format = 'json')}}

看到树枝参考获取更多信息。

5.3

一个序列化过滤器是在使用Serializer组件的Symfo欧宝娱乐app下载地址ny 5.3中引入的。

添加标准化器和编码器

启用后,序列化器服务将在容器中可用。它自带一套有用的编码器而且标准化者

支持以下格式的编码器已启用:

以及以下归一化器:

其他内置的标准化者自定义归一化器和/或编码器也可以通过标记为来加载serializer.normalizer而且serializer.encoder.还可以设置标记的优先级以决定匹配顺序。

谨慎

总是要确保加载DateTimeNormalizer当序列化DateTimeDateTimeImmutable类,以避免过多的内存使用和暴露内部细节。

使用序列化组注释

要使用注释,首先要通过sensioframeworkextrabundance添加对它们的支持:

1
Composer需要sensio/framework-extra-bundle

接下来,添加@Groups注释致您的班级:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
/ / src /实体/ Product.php名称空间应用程序实体使用学说ORM映射作为ORM使用欧宝娱乐app下载地址组件序列化器注释/ * * *@ORM() * / \实体产品/ * * *@ORM\ Id *@ORM\ GeneratedValue *@ORM\列(type =“整数”)*@Groups({"show_product", "list_product"}) */私人id/ * * *@ORM\列(type="string", length=255) *@Groups({"show_product", "list_product"}) */私人的名字/ * * *@ORM\列(type =“整数”)*@Groups({}“show_product”)* /私人描述;}

你现在可以选择在序列化时使用哪些组:

1 2 3 4 5
json序列化器->序列化(产品json的, (“组织”= >“show_product”]);

提示

的值Key可以是单个字符串,也可以是字符串数组。

除了@Groups注释,Serializer组件也支持YAML或XML文件。当这些文件被存储在以下位置之一时,会自动加载:

  • 所有* .yaml而且* . xml文件配置/序列化器/目录中。
  • serialization.yamlserialization.xml资源/ config /包的目录;
  • 所有* .yaml而且* . xml文件资源/ config /序列化/包的目录。

配置元数据缓存

序列化器的元数据被自动缓存以增强应用程序性能。默认情况下,序列化器使用cache.system缓存池cache.system选择。

启用名称转换器

使用名字转换器服务可以在配置中使用name_converter选择。

内置的CamelCase到snake_case名称转换器可以通过使用serializer.name_converter.camel_case_to_snake_case值:

  • YAML
  • XML
  • PHP
1 2 3 4 5
#配置/包/ framework.yaml框架:#……序列化器:name_converter:“serializer.name_converter.camel_case_to_snake_case”

进一步使用序列化器

API的平台提供一个API系统,支持以下格式:

它构建在Symfony Framework及其Ser欧宝娱乐app下载地址ializer组件之上。它提供了自定义规范化器、自定义编码器、自定义元数据和缓存系统。

如果您想充分利用Symfony Serializer组件的全部功能,请看看这个包是如何工作的欧宝娱乐app下载地址。

此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。
欧宝娱乐app下载地址Symfony 5.3支持通过JoliCode