Symfony2ExceptionListener重写404响应返回值

陌瑶大大_7671

陌瑶大大_7671

2026-08-16

883人浏览

原创

在 symfony 中,应通过自定义 notfoundlistener 监听 kernel.exception 事件,优先级设为 10,在 onkernelexception 中捕获 notfoundhttpexception 并返回 jsonresponse,同时根据请求格式或路由前缀区分 api/网页请求,并记录日志。

symfony2exceptionlistener重写404响应返回值

在 Symfony 中,重写 404 响应的返回值(比如返回 JSON 而非 HTML)通常不是靠修改 ExceptionListener 类本身,而是通过自定义异常监听器并针对 NotFoundHttpException 做专门处理来实现。

监听 NotFoundHttpException 并返回 JSON

默认情况下,Symfony 的错误页面由 Twig 模板渲染,但你可以创建一个专用的异常监听器,在捕获到 404 异常时主动构造 JSON 响应。

  • 创建监听器类(如 App\EventListener\NotFoundListener),注入 RequestStack 和 JsonResponse 相关服务
  • 在 onKernelException 方法中判断 $event->getThrowable() 是否为 NotFoundHttpException
  • 调用 $event->setResponse(new JsonResponse(...)) 替换默认响应
  • 确保该监听器优先级高于默认异常处理(例如设为 0 或更高,负数优先级更低)

配置监听器并设置优先级

在 services.yaml 中注册监听器,并指定事件和优先级:

App\EventListener\NotFoundListener:
    tags:
        - { name: 'kernel.event_listener', event: 'kernel.exception', method: 'onKernelException', priority: 10 }

优先级设为正数(如 10)可确保它早于 Symfony 默认的 ExceptionListener(优先级为 0)执行,从而拦截并覆盖 404 响应。

Symfony Linux版
Symfony Linux版

Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。

下载

区分环境与请求格式

实际项目中往往只对 API 请求返回 JSON,而网页请求仍走 HTML 页面。可通过以下方式判断:

  • 检查 $request->getRequestFormat() 是否为 'json' 或 'api'
  • 检查 $request->headers->get('Accept') 是否包含 application/json
  • 或根据路由前缀(如以 /api/ 开头)做条件判断

这样能避免全局替换导致普通页面也变成 JSON,破坏用户体验。

保持原有日志与调试信息

重写响应时不要跳过异常日志记录。建议保留原始异常堆栈(尤其在 dev 环境):

  • 使用 $this->logger->warning('Resource not found', ['exception' => $e]) 记录日志
  • 开发环境下可将 debug 信息加入 JSON(如 'debug' => $e->getMessage()),生产环境则隐藏
  • 避免直接抛出新异常或静默吞掉错误,否则难以排查问题

相关文章

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

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

下载

相关标签:

symfony

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11004

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6401

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4048

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4754

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3731

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5357

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4202

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12122

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15.7万人学习