0

0

Laravel如何操作JSON类型的数据库字段?(Eloquent示例)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-13 14:33:07

|

328人浏览过

|

来源于php中文网

原创

Laravel通过$casts自动处理JSON字段的序列化与反序列化,支持array/object/collection类型;需用数据库原生JSON函数(如JSON_SET)实现局部更新;提供whereJsonContains、whereJsonLength等查询方法适配多数据库;可配合访问器/修改器定制逻辑。

laravel如何操作json类型的数据库字段?(eloquent示例)

在 Laravel 中操作 JSON 类型字段(如 MySQL 5.7+ 的 JSON 类型、PostgreSQL 的 jsonb 或 SQLite 的文本模拟),Eloquent 提供了原生支持,无需手动序列化/反序列化。关键在于正确设置模型属性和使用访问器、修改器或直接查询语法。

1. 模型中声明 JSON 字段为数组/对象类型

Laravel 会自动将 JSON 字段转为 PHP 数组(或 StdClass 对象),前提是该字段被标记为 $casts 中的 'array''object''collection'

class User extends Model
{
    protected $casts = [
        'preferences' => 'array', // 存储为 JSON,读取为关联数组
        'settings'    => 'object', // 读取为 StdClass 实例
        'tags'        => 'collection', // 自动转为 Illuminate\Support\Collection
    ];
}

这样写入时传数组,Laravel 自动 json_encode;读取时自动 json_decode,无需手动处理。

2. 写入和更新 JSON 字段(整体或局部)

整体更新直接赋值即可:

  • 整字段替换:$user->preferences = ['theme' => 'dark', 'notifications' => true]; $user->save();
  • 局部更新(MySQL 5.7+):DB::raw() 或 Eloquent 的 whereJsonContains/whereJsonLength 等方法,但「局部更新」需用原生 JSON 函数:
// 更新 preferences.theme 而不覆盖整个字段(MySQL)
DB::table('users')
    ->where('id', 1)
    ->update([
        'preferences' => DB::raw("JSON_SET(preferences, '$.theme', 'light')")
    ]);

// 或用模型:$user->update(['preferences' => DB::raw("JSON_SET(...)")]);

注意:Eloquent 默认不支持「只改 JSON 内某个键」的语法糖,必须借助数据库原生 JSON 函数。

3. 查询 JSON 字段(条件检索)

Laravel 支持多种 JSON 查询语法,适配不同数据库:

FreeTTS
FreeTTS

FreeTTS是一个免费开源的在线文本到语音生成解决方案,可以将文本转换成MP3,

下载
  • 包含某个值(MySQL/PG):User::whereJsonContains('preferences', ['notifications' => true])->get();
  • 指定路径匹配(MySQL):User::where('preferences->theme', 'dark')->get();(等价于 JSON_EXTRACT(preferences, '$.theme')
  • 数组长度判断(MySQL):User::whereJsonLength('tags', '>', 2)->get();
  • PostgreSQL 特有(推荐用 ->> 获取文本):User::where('settings->language', 'en')->get();

这些方法底层调用对应数据库的 JSON 函数,Laravel 自动适配方言。

4. 使用访问器/修改器做自定义处理

若需对 JSON 字段做转换逻辑(比如统一添加默认键、过滤敏感字段),可配合 getFooAttributesetFooAttribute

class User extends Model
{
    protected $casts = ['metadata' => 'array'];

    // 读取时补充默认值
    public function getMetadataAttribute($value)
    {
        return array_merge(['version' => '1.0'], $value);
    }

    // 写入时过滤掉非法键
    public function setMetadataAttribute($value)
    {
        $allowed = ['theme', 'locale', 'timezone'];
        $this->attributes['metadata'] = array_intersect_key($value, array_flip($allowed));
    }
}

注意:修改器中不要调用 $this->metadata = ...,否则会触发无限递归;应直接操作 $this->attributes

基本上就这些。核心是善用 $casts 做自动转换,结合数据库原生 JSON 函数做高级查询和局部更新,再按需用访问器/修改器增强逻辑。不复杂但容易忽略细节,比如忘记声明 cast 导致存成字符串,或误以为 -> 语法能直接更新子字段。

相关专题

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

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

2788

2023.09.01

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

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

1686

2023.10.11

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

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

1547

2023.10.11

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

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

1016

2023.10.23

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

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

1485

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1569

2023.11.09

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

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

1307

2023.11.13

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.9万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 805人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号