讲师中心 微信公众号
AI工具推荐 视频效率加速

Laravel怎么实现模型查询结果转JSON格式_LaraveltoJson方法配置选项【教程】

千强小哥_8457

千强小哥_8457

发布时间:2026-03-31 01:27:19

|

551人浏览过

|

来源于php中文网

原创

toJson() 默认调用 json_encode($this->toArray()),输出完全取决于 toArray() 结果,受 $hidden、$visible、$casts、$appends 及关联加载状态影响,日期默认转 ISO8601 格式。

laravel怎么实现模型查询结果转json格式_laraveltojson方法配置选项【教程】

toJson() 方法默认行为是什么

toJson() 不是 Laravel 模型的独立配置项,而是 Eloquent 模型继承自 JsonSerializable 接口后自动提供的方法。它本质是调用 json_encode($this->toArray()),所以输出结构完全取决于模型当前的 toArray() 结果。

常见错误现象:字段没出现、时间格式不对、关联数据丢失——这些问题不是 toJson() 本身的问题,而是 toArray() 阶段就已确定了内容。

  • 模型未加载关联关系时,toJson() 不会自动包含它们(需显式调用 load() 或使用 with())
  • 受 $hidden、$visible、$casts、append 属性影响
  • 日期字段默认转为 ISO8601 字符串(如 "2024-05-20T14:30:00.000000Z"),由 $dateFormat 和序列化逻辑共同控制

怎么控制 toJson() 输出的字段和格式

核心在模型层干预 toArray() 的产出,而不是改 toJson() 本身。

  • 用 $appends 添加访问器字段(记得在访问器里加 return $this->attribute; 这类明确返回值)
  • 用 $casts 控制字段类型转换(例如 'is_active' => 'boolean' 会让 JSON 中输出 true/false 而非 "1")
  • 避免在 toArray() 里手动拼数组——Laravel 7+ 已不推荐重写该方法;优先用 makeHidden() / makeVisible() 动态控制
  • 若需彻底定制 JSON 结构,直接用 json_encode() + 手动构造数组,绕过 toJson()

示例:只暴露 id 和 name,且把 created_at 格式化为短日期

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载
json
$user->makeVisible(['id', 'name'])
     ->makeHidden(['password', 'remember_token'])
     ->toArray();
// 再调用 toJson() 就只含指定字段

toJson() 的参数会影响什么

toJson() 支持传入 JSON_* 常量,但实际生效的非常有限:

  • $model->toJson(JSON_UNESCAPED_UNICODE):防止中文被转成 \u4f60,常用
  • $model->toJson(JSON_PRETTY_PRINT):加缩进,仅调试用,API 返回别开
  • JSON_NUMERIC_CHECK 等对模型 JSON 输出基本无效——因为 Eloquent 已经把数字转成字符串或整型,不再依赖 json_encode 的类型探测
  • 不要传 JSON_THROW_ON_ERROR:Laravel 内部没做异常捕获,出错直接报错,不建议线上用

API 响应中直接 return $model 为什么比 toJson() 更好

Laravel 的响应自动调用模型的 toJson(),但更关键的是:它会走完整的响应生命周期,包括自动设置 Content-Type: application/json、支持中间件(如 CORS)、能被事件监听(ResponseSend)。

  • 写 return $user; 即可,框架自动处理序列化和头信息
  • 写 return response()->json($user); 是等价的,但多一层封装
  • 写 return $user->toJson(); 是错的:返回的是字符串,Content-Type 变成 text/html,前端解析失败
  • 如果用了 API 资源(Resource),必须用 return new UserResource($user);,否则资源类的 toArray() 逻辑不会触发

容易被忽略的一点:模型里定义了 $dates 或用了 Carbon 实例的属性,若没在 $casts 里声明,toJson() 仍可能输出对象而非字符串——这不是 bug,是序列化时机早于 Carbon 的 toString 处理所致。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

877

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

855

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2508

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

4701

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

6870

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

4516

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

8469

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1516

2026.03.04

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 221人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn