讲师中心 微信公众号
AI工具推荐 视频效率加速

ThinkPHP处理API响应字段驼峰与下划线_自动映射兼容方案

梦芳同学_7139

梦芳同学_7139

发布时间:2026-04-07 08:18:04

|

236人浏览过

|

来源于php中文网

原创

ThinkPHP 6 的 json() 默认不转换字段名,需手动用 Str::camel 转换键名或自定义 Response 类统一处理;反向需在 input() 中用 Str::snake 解析请求体,验证器仍用下划线。

thinkphp处理api响应字段驼峰与下划线_自动映射兼容方案

ThinkPHP 6 的 json 输出默认不转换字段名

默认情况下,return json($data) 会原样输出数组键名,不会把 user_name 变成 userName,也不会反向处理。这不是 Bug,是设计如此——框架不干涉数据结构,由开发者显式控制。

常见错误现象:axios.get('/api/user').then(res => console.log(res.data.user_name)) 报错,因为前端期望的是 userName,但后端返回了 user_name。

  • 只在 API 场景需要映射;模板渲染、写入数据库等场景不该介入
  • json() 是快捷封装,底层仍是 Response 对象,可干预序列化前的数据
  • 不要改全局 think\facade\Config 的 app.json_encode,它影响所有 JSON 输出(包括错误页),容易误伤

用 think\helper\Str::camel 手动转换数组键

最轻量、最可控的方式:在返回前遍历并重命名键名。适用于单次响应或少量接口。

示例:

立即学习“PHP免费学习笔记(深入)”;

$data = ['user_id' => 123, 'last_login_time' => '2024-05-01'];
$converted = array_map(function ($item) {
    if (is_array($item)) {
        return array_combine(
            array_map([think\helper\Str::class, 'camel'], array_keys($item)),
            array_values($item)
        );
    }
    return $item;
}, $data);

return json($converted);
  • think\helper\Str::camel 支持带数字的下划线(如 order_no_2 → orderNo2),比正则更稳
  • 不能递归处理嵌套数组,需自己加 is_array() 判断,否则报 array_keys() expects parameter 1 to be array
  • 性能影响极小,但别在高频接口里反复调用 array_map + array_combine,可封装成复用函数

通过 think\Response 自定义 JSON 序列化逻辑

适合中大型项目,统一处理所有 API 响应。核心是替换默认的 toJson 行为,而不是改 json_encode 配置。

做法:在 app/common/Response.php 中继承 think\Response,重写 output 方法:

protected function output($data): string
{
    if (is_array($data) && request()->isAjax()) {
        $data = $this->convertKeysToCamel($data);
    }
    return parent::output($data);
}
  • 必须加 request()->isAjax() 或检查 Accept: application/json,否则 HTML 模板也会被转换,导致模板变量找不到(如 $user_name 变成 $userName)
  • convertKeysToCamel 要支持多层嵌套,建议用递归 + think\helper\Str::camel,别用 json_encode + preg_replace,后者无法保证键值对应
  • 注册该类需在 app/middleware/Response.php 或控制器基类中手动 new,不走容器自动绑定时,return response()->json(...) 不会生效

反向兼容:前端传 userName,后端要能识别为 user_name

POST/PUT 请求体里的字段也要映射,否则 $this->request->post('userName') 拿不到值。ThinkPHP 不提供自动反向转换,得自己接住原始输入。

推荐在基控制器里统一处理:

protected function input(): array
{
    $raw = $this->request->param();
    return $this->convertKeysToSnake($raw);
}
  • convertKeysToSnake 是 camel 的逆操作,可用 think\helper\Str::snake,注意它默认转为小写下划线,符合 Laravel 风格
  • 别覆盖 $this->request->post(),它内部有类型转换和过滤逻辑,直接改原始 param() 更安全
  • 如果用了验证器(Validate),字段名仍需保持下划线,否则规则失效(如 'user_name.require' => '用户名必填')

字段映射这事没有银弹。驼峰和下划线混用时,最容易被忽略的是「请求体解析」和「验证器字段名」的不一致,这两处一旦漏掉,前端看着正常,后端查不到参数或验证总失败。

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

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

下载

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

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

857

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

835

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2488

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

4261

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

6150

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

4056

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

7629

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1476

2026.03.04

剧云故事大纲与分场规划教程
剧云故事大纲与分场规划教程

本专题讲解剧云梗概与多级大纲功能,覆盖全局、分集、分场结构生成,以及主线冲突、剧情节点和场次顺序调整。

0

2026.10.22

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn