展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > Laravel怎么实现模型查询结果转JSON时格式化日期_Laravel自定义日期序列化【说明】

Laravel怎么实现模型查询结果转JSON时格式化日期_Laravel自定义日期序列化【说明】

Laravel模型默认将日期字段序列化为ISO8601格式,不受$dateFormat属性影响。推荐在模型内重写serializeDate方法并配合$casts属性,以自定义JSON输出格式。对于复杂场景,可在JsonResource中手动格式化日期。全局修改Carbon序列化会影响所有相关组件,需谨慎评估。调整前应检查项目依赖旧格式的代码,避免连锁问题。

本文目录

    在Lara vel开发中,将模型数据转换为JSON格式是API开发的常规操作。但很多开发者都遇到过这样一个问题:明明在模型里设置了$dateFormat,为什么调用$model->toJson()时,日期字段还是输出成了"2024-05-20T09:30:45.000000Z"这种ISO 8601格式?

    Lara vel怎么实现模型查询结果转JSON时格式化日期_Lara vel自定义日期序列化【说明】

    为什么 $model->toJson() 里的日期不是你想要的格式

    问题的根源在于Lara vel的日期序列化机制。模型中的日期字段默认由Carbon实例表示,而Carbon的__toString()魔术方法直接返回ISO 8601格式的字符串。这个格式虽然对前端和国际化友好,但在调用toJson()或toArray()时,它并不会“绕道”去读取你在模型里定义的$dateFormat属性。

    这就导致了一个常见的认知误区:

    • 仅设置protected $dateFormat = 'Y-m-d H:i:s';对JSON序列化是无效的。
    • 同样,toArray()方法也不受$dateFormat的影响,因为这个属性主要控制的是日期在数据库写入和读取时的解析格式。
    • 有人可能会想到用Carbon::serializeUsing()进行全局修改,但这相当于“一刀切”,很容易误伤项目其他依赖默认格式的第三方包或组件。

    在模型里用 $casts + date 或 datetime 配合 serializeDate()

    最推荐、作用域也最清晰的做法,是在模型内部重写serializeDate()方法。这样,每个模型都能自主决定其日期字段在序列化时的最终面貌。

    具体操作分两步:

    • 首先,在模型中重写serializeDate()方法,返回你期望的格式字符串。例如,想要标准的“年-月-日 时:分:秒”格式:
      protected function serializeDate(\DateTimeInterface $date)
      {
          return $date->format('Y-m-d H:i:s');
      }
    • 其次,确保目标日期字段已在$casts属性中声明为date或datetime类型。这是触发serializeDate()方法的前提:
      protected $casts = [
          'created_at' => 'datetime',
          'updated_at' => 'datetime',
          'published_at' => 'datetime',
      ];

    需要注意的是,这个方法只影响toJson()、toArray()以及API资源(JsonResource)中的日期表现,不会干扰到任何数据库层面的操作。

    API 资源里手动格式化(适合需要多版本输出的场景)

    当业务变得复杂,比如同一个模型需要为管理后台输出完整时间戳,而为移动端APP只提供日期部分时,在模型里写死格式就不太灵活了。这时,JsonResource才是更合适的舞台。

    你可以在资源类的toArray()方法中,直接对日期字段进行精细化处理:

    • 直接使用format()方法转换格式,例如$model->created_at->format('Y/m/d')。
    • 为了避免对同一字段多次调用format()造成不必要的性能开销,可以先赋值给不同的键:
      'created_date' => $this->created_at->format('Y-m-d'),
      'created_time' => $this->created_at->format('H:i'),
    • 这里有个细节必须警惕:如果字段可能为null,务必先进行判空处理,否则会抛出Call to a member function format() on null错误。

    全局统一处理但留出例外(慎用)

    如果你的项目在早期就已明确,所有API接口的日期格式统一为"Y-m-d H:i:s",且不考虑时区差异,那么全局设置似乎是个一劳永逸的选择。但务必谨慎评估其副作用。

    你可以在AppServiceProvider::boot()中设置全局钩子:

    Carbon::serializeUsing(function ($carbon) {
        return $carbon->format('Y-m-d H:i:s');
    });

    这个操作的副作用非常明显:它会改变项目中所有用到Carbon序列化的地方,包括你可能并不想触及的第三方包、日志记录、甚至队列任务。如果未来某个模型必须保持ISO格式(例如与某个外部系统对接),你就得在这个模型的serializeDate()方法中显式调用parent::serializeDate($date)来绕过全局设置。

    话说回来,真正麻烦的往往不是如何改变格式,而是改变之后带来的连锁反应。在动手调整之前,最好先用全局搜索工具(如grep)检查一遍项目:Swagger文档里的示例、前端Mock数据、以及单元测试中所有关于时间格式的断言,都可能依赖旧的格式。搜索类似"T\d{2}:\d{2}:\d{2}"(匹配ISO格式)或"\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}"(匹配本地时间格式)的模式,能帮你提前发现潜在的风险点。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 JSON
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。

    Cubase Windows版
    Cubase Windows版

    Cubase 是 Steinberg 推出的数字音频工作站,提供 MIDI 编曲、多轨录音、音频编辑、虚拟乐器、效果处理、自动化、混音和母带输出工具。其 Pro、Artist 与 Elements 版本面向不同预算和制作规模,