如何使用序列化器吗

编辑该页面

如何使用序列化器吗

ob娱乐下载Symfony提供了一个序列化器来序列化/反序列化的对象和不同的格式(例如JSON或XML)。在使用它之前,阅读序列化器组件文档熟悉其哲学和标准化者和编码器的术语。

安装

在应用程序中使用ob娱乐下载Symfony Flex运行这个命令安装序列化器ob娱乐下载Symfony包使用前:

1
美元作曲家需要symfony / seob娱乐下载rializer-pack

使用序列化器服务

一旦启用,序列化器服务可以被注入在你需要的任何服务或它可以用在一个控制器:

1 2 3 4 5 6 7 8 9 10 11 12 13 14
/ / src /控制器/ DefaultController.php名称空间应用程序\控制器;使用ob娱乐下载\包\FrameworkBundle\控制器\AbstractController;使用ob娱乐下载\组件\HttpFoundation\响应;使用ob娱乐下载\组件\序列化器\SerializerInterface;类DefaultController扩展AbstractController{公共函数指数(SerializerInterface美元序列化器):响应{/ /保持阅读用法示例}}

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

1
{{|对象序列化(格式= json)}}

看到树枝参考为更多的信息。

添加标准化者和编码器

一旦启用,序列化器服务将在容器中。它附带了一组有用的编码器和标准化者。

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

以及以下标准化者:

其他内置的标准化者和自定义标准化者和/或编码器可以通过标记他们serializer.normalizer和serializer.encoder。还可以设置的优先级标记为了决定匹配的顺序。

谨慎

总是确保加载DateTimeNormalizer当序列化DateTime或DateTimeImmutable类,以避免过度的内存使用和公开内部细节。

序列化器上下文

序列化器可以定义一个上下文来控制资源的(反)序列化。这种情况下传递给所有标准化者。例如:

您可以通过上下文如下:

1 2 3 4 5 6 7
美元序列化器- >序列化(美元的东西,json的,(DateTimeNormalizer::FORMAT_KEY = >Y-m-d H:我:年代”]);美元序列化器- >反序列化(美元someJson的东西,::类,json的,(DateTimeNormalizer::FORMAT_KEY = >Y-m-d H:我:年代”]);

您还可以配置默认上下文通过框架配置:

1 2 3 4 5 6 7
#配置/包/ framework.yaml框架:#……序列化器:default_context:enable_max_depth:真正的yaml_indentation:2

6.2

选择配置YAML压痕是在Symfony 6.2中引入的。ob娱乐下载

您还可以指定上下文的每处房产基础上:

1 2 3 4 5 6 7 8 9 10 11 12 13 14
名称空间应用程序\模型;使用ob娱乐下载\组件\序列化器\注释\上下文;使用ob娱乐下载\组件\序列化器\标准化者\DateTimeNormalizer;类人{/ * * *@Context({DateTimeNormalizer: FORMAT_KEY = ' Y-m-d '}) * /公共\ DateTimeInterface美元createdAt;/ /……}

使用选项来指定上下文特定的归一化或反规范化:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
名称空间应用程序\模型;使用ob娱乐下载\组件\序列化器\注释\上下文;使用ob娱乐下载\组件\序列化器\标准化者\DateTimeNormalizer;类人{#(上下文(normalizationContext:(DateTimeNormalizer::FORMAT_KEY = >“Y-m-d”),denormalizationContext: [DateTimeNormalizer::FORMAT_KEY = > \ DateTime::RFC3339))公共\ DateTimeInterface美元createdAt;/ /……}

你也可以限制一个上下文的使用一些组:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
名称空间应用程序\模型;使用ob娱乐下载\组件\序列化器\注释\上下文;使用ob娱乐下载\组件\序列化器\注释\组;使用ob娱乐下载\组件\序列化器\标准化者\DateTimeNormalizer;类人{#(团体((“扩展”)))#(上下文([DateTimeNormalizer:: FORMAT_KEY = > \ DateTime:: RFC3339)))#(上下文(背景:[DateTimeNormalizer::FORMAT_KEY = > \ DateTime::RFC3339_EXTENDED],组:[“扩展”),)公共\ DateTimeInterface美元createdAt;/ /……}

属性/注释可以重复一样需要一个属性。上下文不组总是首先应用。然后上下文匹配组中合并提供了秩序。

使用上下文建筑商

6.1

上下文建筑商在Symfony 6.1中引入的。ob娱乐下载

定义(反)序列化上下文,您可以使用“上下文建造者”,这是帮助你创建的对象上下文通过提供自动完成,验证,和文档:欧宝官网下载app

1 2 3 4
使用ob娱乐下载\组件\序列化器\上下文\标准化者\DateTimeNormalizerContextBuilder;美元contextBuilder= (新DateTimeNormalizerContextBuilder ())- >withFormat (Y-m-d H:我:年代”);美元序列化器- >序列化(美元的东西,json的,美元contextBuilder- >toArray ());

每个标准化者/编码器有其相关的上下文建设者。创建一个更复杂的(反)序列化的背景下,你可以使用链它们withContext ()方法:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
使用ob娱乐下载\组件\序列化器\上下文\编码器\CsvEncoderContextBuilder;使用ob娱乐下载\组件\序列化器\上下文\标准化者\ObjectNormalizerContextBuilder;美元initialContext= (“custom_key”= >“custom_value”,);美元contextBuilder= (新ObjectNormalizerContextBuilder ())- >withContext (美元initialContext)- >withGroups ([“group1”,“group2”]);美元contextBuilder= (新CsvEncoderContextBuilder ())- >withContext (美元contextBuilder)- >withDelimiter (“;”);美元序列化器- >序列化(美元的东西,“csv”,美元contextBuilder- >toArray ());

你也可以创建您的上下文建筑商自动完成,为您的自定义验证和文档上下文值。欧宝官网下载app

使用串行化组属性

您可以添加#(组)的属性您的类:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日
/ / src /实体/ Product.php名称空间应用程序\实体;使用学说\ORM\映射作为ORM;使用ob娱乐下载\组件\序列化器\注释\组;# (ORM \实体)类产品{# (ORM \ Id)# (ORM \ GeneratedValue)# (ORM \列(类型:“整数”))#(组([' show_product ', ' list_product ']))私人int美元id;# (ORM \列(类型:字符串,长度:255)]#(组([' show_product ', ' list_product ']))私人字符串美元的名字;# (ORM \列(类型:'文本'))#(团体([' show_product ']))私人字符串美元描述;}

现在您可以选择使用哪个团体当序列化:

1 2 3 4 5 6 7
使用ob娱乐下载\组件\序列化器\上下文\标准化者\ObjectNormalizerContextBuilder;美元上下文= (新ObjectNormalizerContextBuilder ())- >withGroups (“show_product”)- >toArray ();美元json=美元序列化器- >序列化(美元产品,json的,美元上下文);

提示

的值组键可以是一个字符串,或一个字符串数组。

除了#(集团)属性,序列化器组件还支持YAML或XML文件。这些文件被存储在一个时自动加载以下位置:

  • 所有* .yaml和* . xml文件配置/序列化器/目录中。
  • 的serialization.yaml或serialization.xml文件资源/ config /包的目录;
  • 所有* .yaml和* . xml文件资源/ config /序列化/目录的一个包。

使用嵌套的属性

嵌套映射属性,使用SerializedPath使用配置来定义他们的路径有效的PropertyAccess语法:

1 2 3 4 5 6 7 8 9 10 11 12 13
名称空间应用程序\模型;使用ob娱乐下载\组件\序列化器\注释\SerializedPath;类人{/ * * *@SerializedPath(“[简介][信息][生日]”)* /私人字符串美元生日;/ /……}

6.2

配置的选项SerializedPath是在Symfony 6.2中引入的。ob娱乐下载

使用上面的配置,denormalizing metadata-aware标准化者会写生日字段元数据到人对象:

1 2 3 4 5 6 7 8 9
美元数据= (“配置文件”= > [“信息”= > [“生日”= >“01-01-1970”,]]];美元人=美元标准化者- >denormalize (美元数据,人::类,“任何”);美元人- >getBirthday ();/ / 01-01-1970

使用注释或属性时,SerializedPath可以设置的属性或相关_getter_方法。的SerializedPath不能结合使用SerializedName同样的属性。

配置元数据缓存

元数据的序列化器自动缓存来提高应用程序的性能。默认情况下,序列化器使用cache.system缓存池配置使用cache.system选择。

使一个名字转换器

的使用名字转换器服务可以被定义在配置使用name_converter选择。

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

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

调试序列化器

使用调试:序列化器命令来转储给定类的序列化器元数据:

1 2 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
美元php bin /控制台调试:序列化器“应用\ \实体书”应用\ \实体书- - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | + |属性选项| + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | + |名称(| | |“组织”= > [| | |“书:阅读”,| | |“书:写”(| | |)| | |“maxDepth”= > 1,| | |“serializedName”= >“book_name”| | |“忽略”= >假| | |“normalizationContexts”= > [],| | |“denormalizationContexts”= > []| | |)| | isbn | (| | |“组织”= > [| | |“书:阅读”(| | |)| | |“maxDepth”= > null, | | |“serializedName”= >零| | |“忽略”= >假| | |“normalizationContexts”= > [],| | |“denormalizationContexts”= > []| | | |)+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

6.3

的调试:序列化器“命令是在Symfony 6.3中引入的。ob娱乐下载

更进一步的序列化器

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

它是建立在Symfony框架及其序列化器组件。ob娱乐下载它提供了定制的标准化者和一个定制的编码器,定制的元数据和缓存系统。

如果你想利用Symfony序列化器组件的全部威力,看看这个包是如何工作的。ob娱乐下载

这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。
TOC
    版本
    版本:

    ob娱乐下载Symfony 6.3是支持通过

    ob娱乐下载Symfony 6.3是支持通过

    ob娱乐下载Symfony 6.3是支持通过

    ob娱乐下载Symfony 6.3是支持通过

    检查代码的性能在开发、测试、分期和生产

    检查代码的性能在开发、测试、分期和生产

    被训练SensioLabs专家(2到6天会议——法语或英语)。

    被训练SensioLabs专家(2到6天会议——法语或英语)。