展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

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

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

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

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

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

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

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

ThinkPHP 6 的 json() 助手函数默认已经开启了 JSON_UNESCAPED_UNICODEJSON_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容易超内存限制,生产环境慎用。

本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发 PHP
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

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

Windows

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

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

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

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。