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

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










