当前位置:

首页 > 编程开发 > ThinkPHP如何配置JsonFormatter格式_JsonFormatter格式化输出【规范】

ThinkPHP如何配置JsonFormatter格式_JsonFormatter格式化输出【规范】

PhpStorm macOS版
PhpStorm macOS版

PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

立即下载
¥890
Mac 2026-10-13
数据库 编程开发

ThinkPHP配置JSON格式化输出可通过内置json()函数添加JSON_PRETTY_PRINT参数实现缩进与中文不转义;也可自定义JsonFormatter类注册为响应输出器,或通过中间件拦截重写响应体,还可利用调试模式Trace面板或服务器端过滤模块处理。

在实际开发中,我们常常遇到这样的场景:用ThinkPHP返回JSON数据,结果出来的是紧凑的一行,中文还被转义了。这多半是因为没有正确配置JSON格式化器。这篇文章就来梳理一下,如何让ThinkPHP输出带缩进、中文不转义的可读JSON。

ThinkPHP如何配置JsonFormatter格式_JsonFormatter格式化输出【规范】

下面给出几种常用方案,从最简单的内置函数到自定义类、中间件,再到服务端层面的处理,按需选用即可。

一、使用ThinkPHP内置json()函数并传入格式化参数

ThinkPHP 6 的 json() 助手函数默认已经开启了 JSON_UNESCAPED_UNICODE 和 JSON_UNESCAPED_SLASHES,但缩进格式不会自动加——你需要显式传入 JSON_PRETTY_PRINT。

具体操作很简单:

  • 先在控制器方法中准备好要输出的数据数组,比如 $data = ['code' => 0, 'message' => 'SUCCESS', 'data' => ['user_id' => 100, 'name' => '张三']];
  • 然后调用 return json($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);

这行代码会自动设置 Content-Type: application/json; charset=utf-8,并输出带缩进和换行的格式化JSON。不过需要留意:JSON_PRETTY_PRINT 只在 PHP 5.4+ 里有效,而且会增加响应体大小,生产环境建议关掉。

二、自定义JsonFormatter类并注册为响应输出器

如果全站API都要统一格式,可以写一个自定义的响应类,封装格式化逻辑。比如在 app/common/formatter/JsonFormatter.php 里创建一个类,继承 think\Response,然后重写 output() 方法,对原始数据调用 json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT)。

写好后在 config/app.php 中配置 'response' => \app\common\formatter\JsonFormatter::class; 即可。关键点在于必须保证该类继承自 think\Response 并正确复写 send() 流程,否则 header 设置可能被跳过。

三、在中间件中拦截JSON响应并重写内容

这个方法适合那些旧项目,控制器逻辑不方便修改。写一个中间件,在响应发出前捕获已生成的JSON字符串,然后重新格式化。

  1. 创建中间件 app/middleware/JsonPrettyMiddleware.php
  2. 在 handle() 方法里判断响应类型是否为 application/json
  3. 若是,获取原始内容,用 json_decode($content, true) 解析,再 json_encode(..., JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT)
  4. 更新响应体:$response->content($formattedJson)->header('Content-Length', strlen($formattedJson))

警告:此方式必须确保响应尚未发送(即还没触发 send()),否则会报 Cannot modify header information 错误。

四、使用调试模式下的Trace信息自动注入格式化JSON

如果只是开发阶段想看看美化后的JSON,又不想影响正式响应,可以利用ThinkPHP调试模式的Trace面板。在 config/trace.php 里添加自定义面板,写一个trace插件类,在 onEnd 钩子中检测当前请求是否为JSON接口,若是,就把原始响应数据解析后生成HTML格式化预览块(不替换原响应)。这样既不影响前端解析,又能方便调试。

五、通过Apache/Nginx响应过滤模块实现服务端格式化

最后一种思路是在Web服务器层面做美化,完全不需要改PHP代码。适合运维统一管控的场景,但一般只建议在低QPS调试环境用。

  • Apache:启用 mod_substitute 模块,配置基础缩进规则(如 Substitute "s/{/ {\n/g")
  • Nginx:用 ngx_http_sub_module 配合正则匹配JSON开头插入换行和缩进
  • 更可靠的方式是在OpenResty中写Lua脚本,用 cjson.pretty.encode() 进行标准格式化

需要提醒的是:服务端过滤会增加CPU开销,而且大体积JSON容易超内存限制,生产环境慎用。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
作者最新文章
编程开发 PHP
相关文章 更多
PHP递归遍历目录文件:RecursiveDirectoryIterator与自定义实现
PHP递归遍历目录文件:RecursiveDirectoryIterator与自定义实现

深入解析在PHP中递归遍历多级目录文件的两种核心方案:基于SPL标准库的RecursiveDirectoryIterator高效流式迭代,与基于scandir/opendir的自定义递归函数实现,剖析执行机制、内存表现与实战避坑指南。

解决PHP递归报错:max_nesting_level限制与内存溢出处理
解决PHP递归报错:max_nesting_level限制与内存溢出处理

遇到PHP递归报错时,不要盲目调大max_nesting_level。本文教你区分Xdebug限制、内存耗尽和正则递归错误,提供代码级的终止条件优化与迭代替代方案,彻底解决栈溢出问题。

PHP递归中static变量与引用传递的常见陷阱及调试
PHP递归中static变量与引用传递的常见陷阱及调试

本文分析PHP递归中static变量导致的状态污染及引用传递引发的共享数据修改问题。提供具体的代码复现、缓存键设计建议及调试打印技巧,帮助开发者避免隐蔽的逻辑错误。

PHP递归性能优化技巧与迭代替代方案
PHP递归性能优化技巧与迭代替代方案

解析PHP递归函数在树形数据处理中的性能瓶颈,提供预加载数据消除I/O、使用显式栈替代深层递归的实战方案,帮助开发者在代码可读性与执行效率间做出合理取舍。

thinkphp项目部署指南详解服务器部署步骤
thinkphp项目部署指南详解服务器部署步骤

详细解析ThinkPHP项目在Linux服务器上的部署步骤,包括环境搭建、文件权限、Nginx配置及常见陷阱,提供可复制的代码示例与例外场景分析。

PHP发送HTTP请求的方法及完整代码教程
PHP发送HTTP请求的方法及完整代码教程

详解PHP中发送HTTP请求的常用方法,包括原生cURL配置、file_get_contents流操作及Guzzle库的使用,提供GET/POST请求的完整代码示例与注意事项。

php解析json内嵌json数据教程及取值方法
php解析json内嵌json数据教程及取值方法

本文详解PHP中json_decode处理嵌套JSON数据的机制,对比对象与数组模式的取值差异,提供防止空指针错误的健壮代码示例,帮助开发者快速定位解析失败原因。

PHP 在 2026 年还适用吗?
PHP 在 2026 年还适用吗?

PHP在2026年仍适用于现代网站构建,在常规Web服务和内容密集型站点中较Python、Java等保持优势。其JIT编译优化性能,安全补丁及时,全面支持云原生,拥有成熟框架生态,整体成本较低。

DebianPHP如何SSL加密
DebianPHP如何SSL加密

在Debian系统上为PHP配置SSL加密,通常涉及以下几个步骤:安装SSL证书:首先,你需要一个SSL证书。你可以从Let’s Encrypt免费获取,或者购买一个商业证书。使用Let’s Encrypt:sudo apt updatesudo apt install certbotsudo ce

Linux服务器上ThinkPHP如何进行备份
Linux服务器上ThinkPHP如何进行备份

在Linux服务器上,若要使用ThinkPHP框架进行备份,一般会涉及到以下这些方面:数据库备份:使用mysqldump或mysql命令行工具来备份数据库。示例命令:mysqldump -u username -p database_name > backup_database.sql这将生成一个S

查看更多
精品专题 更多
装机必备
装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows
Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

PDF教程
PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
Postman macOS版
Postman macOS版
Mac

Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

Docker Desktop macOS版
Docker Desktop macOS版
Mac

Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

Android Studio macOS版
Android Studio macOS版
Mac

Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

WINDOWS 更多
PixPix 网页版
PixPix 网页版
Windows

PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台,提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。

Postman Windows版
Postman Windows版
Windows

Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

Docker Desktop Windows版
Docker Desktop Windows版
Windows

Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

即将离开本站
您即将前往第三方网站,请确认是否继续?