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


相关推荐: 怎样使用JSON进行数据交换_它有什么限制  php在windows下怎么调试_phpwindows环境调试操作说明【操作】  Laravel如何实现URL美化Slug功能_Laravel使用eloquent-sluggable生成别名【方法】  ,南京靠谱的征婚网站?  深圳网站制作的公司有哪些,dido官方网站?  Java类加载基本过程详细介绍  laravel怎么配置和使用PHP-FPM来优化性能_laravel PHP-FPM配置与性能优化方法  网站页面设计需要考虑到这些问题  Zeus浏览器网页版官网入口 宙斯浏览器官网在线通道  C#如何调用原生C++ COM对象详解  Laravel怎么集成Vue.js_Laravel Mix配置Vue开发环境  微信小程序 input输入框控件详解及实例(多种示例)  Python文件流缓冲机制_IO性能解析【教程】  Laravel安装步骤详细教程_Laravel环境搭建指南  Laravel怎么使用Session存储数据_Laravel会话管理与自定义驱动配置【详解】  Firefox Developer Edition开发者版本入口  微信小程序 五星评分(包括半颗星评分)实例代码  html5如何实现懒加载图片_ intersectionobserver api用法【教程】  网站设计制作书签怎么做,怎样将网页添加到书签/主页书签/桌面?  Laravel如何配置Horizon来管理队列?(安装和使用)  胶州企业网站制作公司,青岛石头网络科技有限公司怎么样?  如何快速生成可下载的建站源码工具?  网站图片在线制作软件,怎么在图片上做链接?  Laravel如何创建自定义中间件?(Middleware代码示例)  国美网站制作流程,国美电器蒸汽鍋怎么用官方网站?  php打包exe后无法访问网络共享_共享权限设置方法【教程】  Laravel路由怎么定义_Laravel核心路由系统完全入门指南  Laravel Debugbar怎么安装_Laravel调试工具栏配置指南  JavaScript如何实现继承_有哪些常用方法  今日头条AI怎样推荐抢票工具_今日头条AI抢票工具推荐算法与筛选【技巧】  Laravel怎么进行数据库回滚_Laravel Migration数据库版本控制与回滚操作  如何用狗爹虚拟主机快速搭建网站?  网站制作软件有哪些,制图软件有哪些?  Laravel如何实现密码重置功能_Laravel密码找回与重置流程  html如何与html链接_实现多个HTML页面互相链接【互相】  如何在HTML表单中获取用户输入并结合JavaScript动态控制复利计算循环  Internet Explorer官网直接进入 IE浏览器在线体验版网址  如何在宝塔面板创建新站点?  如何在建站主机中优化服务器配置?  php结合redis实现高并发下的抢购、秒杀功能的实例  WEB开发之注册页面验证码倒计时代码的实现  Laravel如何部署到服务器_线上部署Laravel项目的完整流程与步骤  微信h5制作网站有哪些,免费微信H5页面制作工具?  Laravel全局作用域是什么_Laravel Eloquent Global Scopes应用指南  韩国服务器如何优化跨境访问实现高效连接?  如何快速上传建站程序避免常见错误?  php 三元运算符实例详细介绍  魔毅自助建站系统:模板定制与SEO优化一键生成指南  Laravel中的Facade(门面)到底是什么原理  如何快速搭建高效WAP手机网站?