Symfony2接口请求404返回标准JSON结构实现

陌芳吖_8044

陌芳吖_8044

2026-08-16

766人浏览

原创

symfony2中api返回404时需统一输出json格式,通过启用accept头识别、自定义apiexceptionlistener监听kernel.exception事件并拦截notfoundhttpexception,同时禁用twig.exception_listener以避免html渲染冲突。

symfony2接口请求404返回标准json结构实现

在 Symfony2 中,当接口请求返回 404 时,默认会渲染 HTML 错误页面,这对 API 场景不友好。要统一返回标准 JSON 结构(如 {"code": 404, "message": "Not Found"}),需绕过默认异常渲染流程,接管 404 异常处理,并确保仅对 API 请求生效。

配置格式感知:启用 Accept 头识别 JSON 请求

Symfony2 默认根据请求路径后缀(如 .json)或 Accept 请求头决定响应格式。API 接口应优先依赖 Accept: application/json。需确认 framework.format_listener 已启用(默认开启),并在 config.yml 中明确声明 JSON 格式支持:

  • 确保 framework.formats.json 存在且值为 ['application/json', 'application/json;version=1.0']
  • 避免在路由中硬编码 .json 后缀,改用 Accept 头驱动格式切换
  • 测试时用 curl -H "Accept: application/json" http://localhost/api/missing 触发 JSON 响应

自定义异常监听器:捕获 NotFoundHttpException 并转为 JSON

创建服务监听 kernel.exception 事件,在请求格式为 json 时拦截 NotFoundHttpException,手动构造 JSON 响应:

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
  • 新建类 src/AppBundle/EventListener/ApiExceptionListener.php
  • 在 onKernelException 方法中检查 $event->getRequest()->getRequestFormat() === 'json'
  • 判断 $event->getException() instanceof NotFoundHttpException
  • 调用 $event->setResponse(new JsonResponse(['code' => 404, 'message' => 'Not Found'], 404))
  • 注册为服务并绑定到 kernel.exception 事件,优先级设为 higher than 0(如 10),确保早于默认异常处理器执行

避免与 Twig 渲染冲突:禁用模板自动解析

若项目启用了 twig.exception_listener(如开发环境),它可能抢先渲染 HTML 错误页。需在 API 环境或全局禁用该监听器对 JSON 请求的干预:

  • 在 config_prod.yml 中设置 twig.exception_listener.enabled: false
  • 或在监听器中增加前置判断:if ($event->getRequest()->isXmlHttpRequest() || $requestFormat === 'json'),跳过 Twig 渲染逻辑
  • 确保 templating 引擎未被意外调用(如未在控制器中显式 render() 模板)

验证与调试:确认行为符合预期

完成配置后需验证是否真正生效:

  • 访问一个不存在的 API 路由(如 /api/v1/users/9999),带 Accept: application/json 头,应返回纯 JSON 响应,状态码 404
  • 同一 URL 不带 Accept 头或设为 text/html,应仍返回正常 404 HTML 页面(保持前后端分离)
  • 查看日志,确认无 Twig_Error_Runtime 或模板找不到警告
  • 使用 Postman 或 curl 的 -v 参数检查响应头:Content-Type: application/json

不复杂但容易忽略细节,关键是格式识别、异常拦截时机和渲染链路隔离三者配合。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json symfony

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

2025.09.11

5477

17

PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

544

16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2115

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3222

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1096

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

3679

7

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

20

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

0

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

0

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习