ThinkPHP怎么处理模型JSON序列化_ThinkPHP隐藏或追加字段输出【说明】

雨枫酱_6805

雨枫酱_6805

2026-03-24

989人浏览

原创

ThinkPHP模型中JSON字段需手动声明type类型才能自动解码,hidden/visible仅在toArray()等序列化方法生效,field()查询会绕过隐藏逻辑,append支持运行时追加但需预定义获取器,JSON更新需force()或data()确保变更检测。

thinkphp怎么处理模型json序列化_thinkphp隐藏或追加字段输出【说明】

模型里用 json 类型字段,查出来却是字符串不是数组?

ThinkPHP 的模型默认不会自动解码 JSON 字段,哪怕数据库字段类型是 JSON 或 TEXT 存的 JSON 字符串,select() 或 find() 拿到的仍是原始字符串。这不是 Bug,是设计上留出控制权——避免误解析非标准 JSON 或性能损耗。

实操建议:

  • 在模型类中给该字段加 type 声明:protected $type = ['extra_info' => 'json'];
  • 确保字段值是合法 JSON(双引号、无尾逗号),否则解码失败会返回 null,且不报错
  • 如果字段名带下划线(如 user_config),也要严格按实际字段名写进 $type 数组,大小写敏感
  • 5.1+ 支持嵌套 JSON 解析(如 'settings.info' => 'json'),但仅限关联字段或使用 withAttr 时生效

hidden 和 visible 不起作用?字段还在输出里

这两个属性只对模型的 toArray()、toJson()、__toString() 以及控制器中直接 echo $model 生效;如果手动调用 getAttr()、遍历 $model->data 或用了 field() 查询,就完全绕过了隐藏逻辑。

常见错误现象:

  • API 返回里依然看到 password 字段,但模型已设 protected $hidden = ['password']
  • 用 User::where(...)->field('id,name')->select(),结果 toArray() 后字段没被隐藏——因为 field() 是查询层控制,$hidden 是序列化层控制,两者不叠加

正确做法:

  • 优先用 hidden 控制输出,但确认你调用的是模型实例的 toArray()(比如 $user->toArray()),而不是 $user->data
  • 需要动态控制时,改用 append() + visible 组合,例如:$user->visible(['id', 'name'])->append(['full_name'])->toArray()
  • 若走 Db 查询(非模型),hidden/visible 完全无效,得靠 PHP 层 unset() 或 array_intersect_key()

想追加字段但只在某些接口用,append 写死在模型里太死板

append 支持运行时追加,不用改模型定义。但要注意:追加的字段必须已在模型中定义过获取器(getXXXAttr)或通过 withAttr 注册,否则追加无效。

使用场景:

  • 用户列表接口不需要头像 URL,但详情页需要——避免所有请求都拼一次
  • 后台导出 Excel 时要加「部门名称」,但 API 列表不加

实操建议:

  • 先在模型里写好获取器:public function getAvatarUrlAttr($value, $data) { return $data['avatar'] ? '/upload/' . $data['avatar'] : ''; }
  • 运行时追加:$user->append(['avatar_url'])->toArray(),注意这里是下划线命名,和获取器名对应
  • 如果获取器参数依赖外部数据(如当前域名),建议把逻辑抽到服务类,模型里只做简单封装,否则测试和复用困难

JSON 字段更新后,save() 没触发变更检测,数据库没更新

ThinkPHP 的模型变更检测基于原始数据快照($origin),而 JSON 字段解码后是数组,PHP 数组比较用的是引用或 ===,深层结构变化可能被忽略。

典型表现:

  • 修改了 $user->extra_info['theme'] = 'dark',再调 $user->save(),SQL 里没出现 extra_info 字段
  • 用 json_encode() 手动转回字符串再赋值,反而能触发更新

根本原因:模型认为 $user->extra_info 是个数组,而原始快照里存的是字符串,类型不同导致无法比对差异。

解决办法:

  • 强制标记为变动:$user->force()->save(),跳过变更检测(适合确定要更新的场景)
  • 更新前重载字段:$user->extra_info = json_encode($user->extra_info);,保持类型一致
  • 更稳妥的方式:用 data() 批量赋值,绕过属性访问器:$user->data(['extra_info' => json_encode([...])])->save()

复杂点在于,JSON 字段既是数据载体又是结构容器,模型层很难兼顾语义与性能;一旦业务里频繁读写子字段,不如拆成独立关系表——别硬扛。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

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

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

下载

相关标签:

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

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

2023.10.12

4623

8

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.27

951

4

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

2024.02.23

1209

5

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

6601

10

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

3363

4

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

2024.04.07

6580

11

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

2024.04.29

9061

6

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1230

5

sql中删除一列的命令是什么
sql中删除一列的命令是什么

在sql中,使用alter table语句可以删除一列,语法为:alter table table_name drop column column_name。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1072

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习