symfony-rest-edition序列化教程：JMS Serializer实现JSON与XML双格式输出的完整原理

symfony-rest-edition序列化教程JMS Serializer实现JSON与XML双格式输出的完整原理【免费下载链接】symfony-rest-editionFork from symfony-standard edition with additional rest features.项目地址: https://gitcode.com/gh_mirrors/sy/symfony-rest-editionsymfony-rest-edition 是一个基于 Symfony 2.7 的 REST API 脚手架项目它通过引入JMS Serializer与 FOSRestBundle让同一个接口能够同时返回JSON 与 XML 双格式响应——客户端只需修改请求头的Accept参数即可切换。本教程将拆解这套一套代码、双格式输出机制的完整原理从依赖引入、格式配置到逐字段的元数据映射再到分组与 API 版本控制的实现细节。一、JMS Serializer 是什么双格式输出的核心引擎普通 PHP 代码里控制器返回的往往是一个 PHP 对象但 HTTP 响应体只能是文本。symfony-rest-edition 的解决方案就是 JMS Serializer控制器只负责返回对象如 NoteController.php 中的getNotesAction直接return new NoteCollection(...)JMS Serializer 负责按照预先声明的元数据把对象转换成 JSON 或 XML 文本项目依赖在 composer.json 中声明关键包为jms/serializer-bundle它与friendsofsymfony/rest-bundle协作完成格式协商 序列化。对新手来说理解顺序可以概括为一句话FOSRest 决定输出什么格式JMS Serializer 决定输出什么内容。二、双格式输出的第一步开启 JSON 与 XML 格式格式能力由 app/config/config.yml 中的fos_rest配置段开启核心有 4 项配置项作用view.formats: { xml: true, json: true }同时启用 XML 与 JSON 两种输出格式format_listener.rules按Accept头或 URL 扩展名.json/.xml协商格式优先级html json xmlversioning.resolvers.media_type开启媒体类型版本控制如application/json;version1.1view.mime_types.json支持version1.0 / 1.1 / 1.2三个版本化 JSON 媒体类型也就是说请求notes.json与notes.xml、或携带不同Accept头拿到的是同一段业务数据的两种编码控制器代码完全不需要写两套逻辑。三、元数据映射用 YAML 文件精确控制序列化字段真正决定输出哪些字段、字段长什么样的是 3 个元数据文件src/AppBundle/Resources/config/serializer/Model.Note.ymlsrc/AppBundle/Resources/config/serializer/Model.NoteCollection.ymlsrc/AppBundle/Resources/config/serializer/Model.Event.yml以 Note 为例对应模型src/AppBundle/Model/Note.php几个关键机制值得掌握exclusion_policy: ALL—— 默认排除所有属性只有显式expose: true的字段才会输出。这是最安全的序列化策略避免把内部字段泄露到 API 中xml_root_name: note—— XML 输出的根节点名称可控xml_attribute: true—— NoteCollection 中的offset、limit在 XML 里被输出为属性而非子节点xml_list: { inline: true, entry_name: note }—— 列表在 XML 中内联展开为note元素结构更扁平易读HATEOASrelations—— 通过route: get_note等路由声明序列化时自动附加self资源链接让响应自带导航能力。四、分组与版本控制同一接口返回不同的数据 这是元数据映射最进阶的部分全部在Model.Note.yml中完成分组groupsmessage属于[standard, restapi]两个分组而敏感字段secret只属于restapi分组。控制器getNoteAction中会判断用户是否拥有ROLE_API角色动态追加restapi分组——普通用户拿不到secret字段API 用户可以版本控制since_version / until_version老版本接口输出version字段until_version: 1.1从 1.1 版本起内部属性new_version以serialized_name: version对外序列化——对外字段名不变数据来源已切换。配合第二步的媒体类型版本化实现了平滑的 API 演进。五、一次请求背后的完整序列化流程把前面的内容串起来一个GET notes.json请求在 symfony-rest-edition 中的旅程是格式协商format_listener依据 URL 扩展名或Accept头确定本次输出 JSON 还是 XML业务处理NoteController通过app.note_manager服务注册于src/AppBundle/Resources/config/services.xml取出数据返回Note或NoteCollection对象上下文组装View对象根据角色设置序列化分组Defaultstandard/restapi序列化输出FOSRest 的 View 监听器调用 JMS Serializer按元数据 YAML 完成对象 → JSON/XML 转换并注入 HATEOAS 链接响应返回客户端收到带Content-Type: application/json或 XML的响应缓存策略由fos_http_cache配置自动附加。小结 symfony-rest-edition 用配置驱动的方式展示了 REST API 序列化的标准套路用fos_rest配置声明支持哪些格式JSON / XML用 JMS Serializer 元数据 YAML 声明输出哪些字段、如何命名、归属哪个分组与版本控制器只写业务逻辑格式与内容完全解耦。想动手验证的话可直接浏览web/app_dev.php/notes页面HTML 格式或请求notes.json/notes.xml对比同一数据在两种格式下的差异这是理解本教程最快的方式。【免费下载链接】symfony-rest-editionFork from symfony-standard edition with additional rest features.项目地址: https://gitcode.com/gh_mirrors/sy/symfony-rest-edition创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考