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

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

在 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 查询语法,适配不同数据库:

  • 包含某个值(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 导致存成字符串,或误以为 -> 语法能直接更新子字段。


# mysql  # php  # laravel  # js  # json  # ai  # 修改器  # Array  # Object  # 字符串  # 递归  # 访问器  # Collection  # 对象  # this  # sqlite  # postgresql  # 数据库  # 需用  # 序列化  # 而不  # 自定义  # 不支持  # 则会  # 关键在于  # 或用 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel如何使用Telescope进行调试?(安装和使用教程)  高性能网站服务器配置指南:安全稳定与高效建站核心方案  canvas 画布在主流浏览器中的尺寸限制详细介绍  Mybatis 中的insertOrUpdate操作  javascript中对象的定义、使用以及对象和原型链操作小结  智能起名网站制作软件有哪些,制作logo的软件?  深入理解Android中的xmlns:tools属性  php嵌入式断网后怎么恢复_php检测网络重连并恢复硬件控制【操作】  IOS倒计时设置UIButton标题title的抖动问题  如何用西部建站助手快速创建专业网站?  Win11怎么恢复误删照片_Win11数据恢复工具使用【推荐】  Python自然语言搜索引擎项目教程_倒排索引查询优化案例  Laravel怎么实现验证码功能_Laravel集成验证码库防止机器人注册  零基础网站服务器架设实战:轻量应用与域名解析配置指南  Laravel如何配置中间件Middleware_Laravel自定义中间件拦截请求与权限校验【步骤】  北京网站制作费用多少,建立一个公司网站的费用.有哪些部分,分别要多少钱?  JS经典正则表达式笔试题汇总  Android仿QQ列表左滑删除操作  实例解析Array和String方法  Laravel如何从数据库删除数据_Laravel destroy和delete方法区别  如何在宝塔面板中修改默认建站目录?  购物网站制作费用多少,开办网上购物网站,需要办理哪些手续?  如何彻底删除建站之星生成的Banner?  Laravel如何使用Spatie Media Library_Laravel图片上传管理与缩略图生成【步骤】  html如何与html链接_实现多个HTML页面互相链接【互相】  如何用AWS免费套餐快速搭建高效网站?  Laravel怎么进行数据库回滚_Laravel Migration数据库版本控制与回滚操作  如何彻底卸载建站之星软件?  如何用PHP快速搭建CMS系统?  详解jQuery停止动画——stop()方法的使用  Bootstrap CSS布局之列表  jimdo怎样用html5做选项卡_jimdo选项卡html5实现与切换效果【指南】  5种Android数据存储方式汇总  Java遍历集合的三种方式  JavaScript如何实现错误处理_try...catch如何捕获异常?  佛山企业网站制作公司有哪些,沟通100网上服务官网?  作用域操作符会触发自动加载吗_php类自动加载机制与::调用【教程】  昵图网官网入口 昵图网素材平台官方入口  html5如何实现懒加载图片_ intersectionobserver api用法【教程】  Laravel怎么使用Collection集合方法_Laravel数组操作高级函数pluck与map【手册】  Laravel Debugbar怎么安装_Laravel调试工具栏配置指南  Laravel的契約(Contracts)是什么_深入理解Laravel Contracts与依赖倒置  如何在腾讯云服务器快速搭建个人网站?  邀请函制作网站有哪些,有没有做年会邀请函的网站啊?在线制作,模板很多的那种?  如何快速选择适合个人网站的云服务器配置?  高防服务器租用如何选择配置与防御等级?  如何在阿里云ECS服务器部署织梦CMS网站?  深圳网站制作设计招聘,关于服装设计的流行趋势,哪里的资料比较全面?  高端建站三要素:定制模板、企业官网与响应式设计优化  Python3.6正式版新特性预览