Laravel访问器Accessor_格式化模型属性输出【详解】

风墨酱_3644

风墨酱_3644

2026-05-04

879人浏览

原创

访问器仅在读取属性、toarray()、tojson()时生效,不参与查询;需正确配置$dates或$casts确保carbon实例,$appends声明虚拟字段,用getraworiginal()获取原始值,返回类型须统一。

laravel访问器accessor_格式化模型属性输出【详解】

访问器不是万能的格式化开关,它只在你“读取属性”时生效,且不能替代数据库层或序列化配置的职责。 直接在模型里写 getCreatedAtAttribute 看似简单,但若没处理好 Carbon 实例、时区、原始值获取等细节,反而会让日期显示错乱、API 返回不一致、导出数据失真。

访问器触发时机与常见误用场景

访问器只在以下情况自动调用:$user->created_at、$user->toArray()、$user->toJson()。但它不会在 where 查询、orderBy、pluck 或 select('created_at') 中触发——这些操作走的是原始 SQL 字段,访问器完全不参与。

常见误用包括:

  • 在访问器里做数据库查询(如 User::where(...)->first()),引发 N+1 问题
  • 把 getFullNameAttribute 当作计算字段用于 orderBy('full_name'),结果报错或排序失效
  • 在 Blade 模板中反复写 $user->getCreatedAtAttribute($user->created_at),手动调用破坏了访问器设计本意

日期字段必须先确认是否已被 Carbon 包装

Laravel 默认将 created_at、updated_at 和 $dates 数组中声明的字段转为 Carbon 实例。但如果你自定义了日期字段(比如 published_at),又没加进 $dates,那传给 getPublishedAtAttribute 的就是一个字符串,不是 Carbon 对象——直接调用 format() 会报错。

正确做法是:

  • 先在模型中声明:protected $dates = ['published_at'];
  • 或改用 $casts(Laravel 7+ 推荐):protected $casts = ['published_at' => 'datetime'];
  • 再写访问器:public function getPublishedAtAttribute($value) { return $value ? $value->format('Y-m-d H:i') : null; }

需要输出但不在数据库中的字段,必须加到 $appends

比如你想提供一个 is_active_text 属性,返回 “启用” 或 “停用”,这个字段不存在于数据库,仅靠 getIsActiveTextAttribute 方法还不够。

否则:$user->is_active_text 能取到值,但 $user->toArray() 或 JSON 响应里不会包含它。

Accessibility Review
Accessibility Review

对设计或页面进行 WCAG 2.1 AA 无障碍审计。触发关键词:“audit accessibility”、 “check a11y”、 “is this accessible?” 或在审查设计时使用。

下载

必须显式声明:protected $appends = ['is_active_text'];

同时注意:$appends 中的字段名要和访问器方法名前缀一致(去掉 get 和 Attribute),即 getIsActiveTextAttribute → is_active_text。

绕过访问器读原始值:用 getRawOriginal()

当你要比对修改前后值、记录审计日志、导出原始时间戳,就不能依赖 $user->created_at——它已经被访问器格式化过了。

此时必须用:$user->getRawOriginal('created_at'),它返回数据库存储的原始值(如 "2025-03-12 14:22:08" 或 1710253328,取决于字段类型)。

注意:getOriginal() 不可靠,它返回的是“上次同步后的值”,可能已被修改器或其它逻辑污染;getRawOriginal() 才是真正从数据库捞出来的那一行原始数据。

最常被忽略的一点:访问器返回值类型必须稳定。比如 getAvatarUrlAttribute 在用户没上传头像时返回空字符串,有头像时返回 URL,前端就容易因类型不一致出 bug。建议统一返回 null 或带默认占位符的字符串,并在文档/注释里明确契约。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel access

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3409

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2388

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1320

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1258

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2258

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3680

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17075

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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

共1课时 | 213人学习

Composer手册
Composer手册

共0课时 | 0人学习