Hyperf 模型 casts 属性:JSON 与布尔值自动转换【代码规范】

秋瑶同学_7009

秋瑶同学_7009

2026-08-06

176人浏览

原创

结论:在 hyperf 模型中,布尔字段误用 'json' cast 会导致 0/1 被 json_decode 为 null;应改用 'boolean' cast,仅对真正存储 json 字符串的字段使用 'json'。

hyperf 模型 casts 属性:json 与布尔值自动转换【代码规范】

Hyperf 模型 casts 中 'json' 会导致布尔值变成 null

直接说结论:在 Hyperf 的 Model 中,把字段声明为 'json' 类型(如 protected $casts = ['is_active' => 'json'];),当数据库存的是 TINYINT(1) 或 BOOLEAN 字段时,Hyperf 会尝试 json_decode() 原始值 —— 而 MySQL 返回的 0 或 1 不是合法 JSON 字符串,解码失败后返回 null,最终模型属性变成 null 而非 false/true。

这不是 bug,是设计使然:'json' cast 仅适用于已存储为 JSON 字符串(如 '{"a":1}')的字段。对原生布尔/整型字段强行套用,等于让 json_decode('1') 执行 —— PHP 7.4+ 才支持,且 Hyperf 默认使用的 json_decode 不带 JSON_THROW_ON_ERROR,静默失败。

  • MySQL 的 BOOLEAN 实际是 TINYINT(1),PDO fetch 后是整数 0 或 1
  • 'json' cast 会无条件调用 json_decode($value, true),传入整数会返回 null
  • Hyperf 不会对非字符串类型做预处理(比如转成 '1' 再 decode),这点和 Laravel 不同

布尔字段该用什么 cast?优先选 'boolean',不是 'json'

Hyperf 支持标准 Eloquent 风格的 cast 类型,'boolean' 是专为布尔语义设计的:它会把 0/1、'0'/'1'、'false'/'true'、''、null 等常见变体统一转成 true/false,且不依赖 JSON 解析。

示例:

protected $casts = [
    'is_published' => 'boolean',
    'is_deleted'   => 'boolean',
];
  • 数据库字段类型建议用 TINYINT(1) 或 BOOLEAN(二者等价)
  • 避免用 VARCHAR 存 'true'/'false' —— 这种场景才考虑 'bool' 或自定义 accessor
  • 'boolean' 和 'bool' 在 Hyperf 中等效,但推荐写全 'boolean' 提高可读性

什么时候才该用 'json'?只用于真正存 JSON 字符串的字段

典型场景:字段在数据库里是 TEXT 或 JSON 类型,内容是序列化后的数组或对象,比如 config、metadata、tags。

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载

示例:

protected $casts = [
    'config' => 'json',      // ✅ 对应 MySQL JSON 或 TEXT,值为 '{"timeout":30,"retry":2}'
    'options' => 'json',    // ✅ 同上
    'status' => 'json',     // ❌ 错误:如果 status 是 TINYINT,这里必须删掉或改用 'integer'
];
  • 确保迁移中该字段类型是 $table->json('config') 或 $table->text('config')
  • 写入时用数组/对象,Hyperf 会自动 json_encode;读取时自动 json_decode
  • 如果字段偶尔存的是纯字符串(如 'pending'),不要用 'json' —— 会 decode 失败变 null

复杂类型混用时,用 get*/set* 访问器更可控

当一个字段既要支持布尔逻辑,又可能扩展为结构化数据(比如后期要存 { "enabled": true, "reason": "manual" }),casts 就不够用了。这时放弃自动 cast,改用访问器手动控制转换逻辑。

示例:

public function getEnabledAttribute($value)
{
    if (is_string($value) && !empty($value)) {
        $decoded = json_decode($value, true);
        return is_array($decoded) ? ($decoded['enabled'] ?? false) : (bool) $decoded;
    }
    return (bool) $value;
}

public function setEnabledAttribute($value)
{
    if (is_bool($value)) {
        $this->attributes['enabled'] = $value ? 1 : 0;
    } elseif (is_array($value)) {
        $this->attributes['enabled'] = json_encode($value);
    }
}
  • 访问器能兼容多种输入形态,比单一 cast 更灵活
  • 注意:Hyperf 模型中访问器命名规则和 Laravel 一致,getFooAttribute 对应字段 foo
  • 如果字段同时被 casts 和访问器处理,访问器优先级更高,但容易引发隐式覆盖,建议禁用对应 cast

真正在意类型安全和后期演进的字段,别图省事硬套 'json' —— 它不是万能转换器,而是明确的序列化协议声明。字段语义变了,cast 就得跟着变,或者干脆交给访问器。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

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

相关专题

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

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

2023.09.01

9684

6

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

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

2023.10.11

5801

5

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

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

2023.10.11

2055

5

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

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

2023.10.23

3628

4

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

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

2023.10.23

4314

6

html怎么上传
html怎么上传

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

2023.11.03

3391

9

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

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

2023.11.09

4817

8

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

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

2023.11.13

3762

8

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

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

2023.11.27

11762

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.7万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.7万人学习