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


相关推荐: Win11怎么设置虚拟桌面 Win11新建多桌面切换操作【技巧】  Laravel如何实现邮件验证激活账户_Laravel内置MustVerifyEmail接口配置【步骤】  Laravel的辅助函数有哪些_Laravel常用Helpers函数提高开发效率  Laravel中间件如何使用_Laravel自定义中间件实现权限控制  如何用JavaScript实现文本编辑器_光标和选区怎么处理  Laravel如何使用Scope本地作用域_Laravel模型常用查询逻辑封装技巧【手册】  如何在万网主机上快速搭建网站?  Java Adapter 适配器模式(类适配器,对象适配器)优缺点对比  佐糖AI抠图怎样调整抠图精度_佐糖AI精度调整与放大细化操作【攻略】  Laravel中DTO是什么概念_在Laravel项目中使用数据传输对象(DTO)  LinuxShell函数封装方法_脚本复用设计思路【教程】  如何快速生成可下载的建站源码工具?  Bootstrap CSS布局之列表  Python进程池调度策略_任务分发说明【指导】  Laravel的.env文件有什么用_Laravel环境变量配置与管理详解  Laravel如何升级到最新版本?(升级指南和步骤)  iOS中将个别页面强制横屏其他页面竖屏  网页设计与网站制作内容,怎样注册网站?  Thinkphp 中 distinct 的用法解析  如何为不同团队 ID 动态生成多个非值班状态按钮  个人网站制作流程图片大全,个人网站如何注销?  Laravel Facade的原理是什么_深入理解Laravel门面及其工作机制  WEB开发之注册页面验证码倒计时代码的实现  如何确认建站备案号应放置的具体位置?  如何快速搭建高效服务器建站系统?  Laravel数据库迁移怎么用_Laravel Migration管理数据库结构的正确姿势  JavaScript模板引擎Template.js使用详解  Laravel如何集成第三方登录_Laravel Socialite实现微信QQ微博登录  网站制作公司哪里好做,成都网站制作公司哪家做得比较好,更正规?  Android中AutoCompleteTextView自动提示  最好的网站制作公司,网购哪个网站口碑最好,推荐几个?谢谢?  Laravel如何使用Collections进行数据处理?(实用方法示例)  C++时间戳转换成日期时间的步骤和示例代码  如何用搬瓦工VPS快速搭建个人网站?  PHP怎么接收前端传的文件路径_处理文件路径参数接收方法【汇总】  如何在阿里云虚拟主机上快速搭建个人网站?  Android GridView 滑动条设置一直显示状态(推荐)  如何在宝塔面板中创建新站点?  Win11怎么开启自动HDR画质_Windows11显示设置HDR选项  Linux虚拟化技术教程_KVMQEMU虚拟机安装与调优  如何快速搭建FTP站点实现文件共享?  Laravel中间件起什么作用_Laravel Middleware请求生命周期与自定义详解  Microsoft Edge如何解决网页加载问题 Edge浏览器加载问题修复  南京网站制作费用,南京远驱官方网站?  edge浏览器无法安装扩展 edge浏览器插件安装失败【解决方法】  香港服务器如何优化才能显著提升网站加载速度?  Google浏览器为什么这么卡 Google浏览器提速优化设置步骤【方法】  Laravel中的Facade(门面)到底是什么原理  EditPlus中的正则表达式 实战(4)  Laravel用户密码怎么加密_Laravel Hash门面使用教程