ThinkPHP怎么使用模型字段别名映射_ThinkPHP兼容旧字段命名方式【说明】

夏杰同学_2786

夏杰同学_2786

2026-04-27

892人浏览

原创

ThinkPHP 6.0+ 通过设置 protected $convertName = true 可自动将下划线字段(如 user_name)映射为驼峰属性(userName),读写双向转换,但需配合 $type 或 $schema 使用,且查询条件、排序等 SQL 相关操作仍须用原始字段名。

thinkphp怎么使用模型字段别名映射_thinkphp兼容旧字段命名方式【说明】

模型里怎么写字段别名映射

ThinkPHP 的模型默认按数据库字段原名映射,但旧表常用 user_name、create_time 这类下划线命名,而 PHP 属性习惯 userName、createTime。要让查询结果自动转成驼峰,不是靠手动 ->toArray() 后遍历改键,而是靠模型配置。

在模型类里加 protected $convertName = true; 就行——这是 ThinkPHP 6.0+ 的开关,默认是 false。它会把下划线字段(如 user_name)自动映射为驼峰属性(userName),同时写入时也能反向转换。

  • 必须配合 protected $type = []; 或字段定义使用,否则只影响读取不保证写入转换
  • 如果字段名本身含数字或大写字母(如 user_ID),$convertName = true 会转成 userId,不是 userI d,这点容易误判
  • 开启后,Db::name('user')->field('user_name')->find() 返回的数组键仍是 user_name,只有模型实例的属性才是 userName

字段别名冲突时谁优先

当数据库字段名和你自定义的属性名撞车,比如字段叫 status,你又在模型里写了 public $status = 1;,ThinkPHP 会以字段映射为准,你的属性会被覆盖。更常见的是用 protected $schema = []; 显式声明字段时,和 $convertName 逻辑打架。

  • $schema 里写的字段名(如 'user_name' => 'string')必须是数据库真实字段名,不能写 'userName' => 'string'
  • 如果同时开了 $convertName 又在 $schema 里漏写某个字段,该字段不会被自动转换,读出来还是 user_name 键
  • 用 __set() 或 setAttribute() 手动设值时,传 userName 能生效,但传 user_name 也会被接受——底层做了双路兼容,但不建议混用

关联查询中别名映射还生效吗

关联查出来的子模型字段,一样走各自模型的 $convertName 配置。但主模型查关联数据时,with(['profile']) 返回的 profile 子对象属性是驼峰的,前提是 ProfileModel 自己开了 $convertName = true。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • 主模型没开 $convertName,子模型开了:主模型字段仍是下划线,子模型字段是驼峰——不会错乱,但风格不统一
  • 用 join 手写关联时,字段别名得自己写清楚,比如 user.user_name AS userName,否则数据库返回的键还是 user_name,模型不识别这个别名
  • 聚合字段(如 COUNT(*) AS count)不会被 $convertName 处理,返回键就是你写的 count,不是 countNum 之类

兼容旧代码时最常踩的坑

老项目从 TP5 升到 TP6,或者字段命名混乱(部分驼峰、部分下划线),最容易出问题的地方不在映射本身,而在「哪里用了原始字段名」。

  • 查询条件里写 where('userName', ...) 会报错,必须写 where('user_name', ...) —— 条件字段名不走别名映射
  • order('userName') 同样无效,数据库不认识这个字段,得写 order('user_name')
  • 用 save(['userName' => 'xxx']) 是可以的,但 save(['user_name' => 'xxx']) 也行;两者都接受,但混着用容易在调试时漏看实际执行的 SQL 字段
  • 导出 Excel 或 API 返回时,如果直接 json($model->toArray()),得到的是下划线键;要用 json($model->toExpressArray()) 或手动 getAttr() 才能确保驼峰

字段映射看着是自动的,其实只管“模型属性访问”这一层,SQL 构建、条件拼接、原始数组输出全都不受控——这点最容易被忽略。

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

相关文章

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

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

下载

相关标签:

php thinkphp

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

相关专题

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

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

2023.09.01

11524

6

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

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

2023.10.11

6661

5

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

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

2023.10.11

2175

5

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

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

2023.10.23

4208

4

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

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

2023.10.23

4934

6

html怎么上传
html怎么上传

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

2023.11.03

3871

9

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

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

2023.11.09

5577

8

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

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

2023.11.13

4362

8

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

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

2023.11.27

12302

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习