Laravel模型如何定义访问器_Laravel模型定义访问器【教程】

轻杰酱_1847

轻杰酱_1847

2026-04-27

1017人浏览

原创

get{attributename}attribute 是定义访问器的唯一有效方式,必须严格遵循驼峰命名规则,如 first_name 对应 getfirstnameattribute;参数 $value 为数据库原始值;需在 $appends 中声明才能序列化输出;同名字段会被屏蔽,getidattribute 会破坏框架功能。

laravel模型如何定义访问器_laravel模型定义访问器【教程】

get{AttributeName}Attribute 方法是定义访问器的唯一有效方式,不写对命名就完全不会触发。

访问器方法名必须严格遵循驼峰规则

数据库字段叫 first_name,对应访问器必须是 getFirstNameAttribute;字段叫 created_at,就得写 getCreatedAtAttribute。Laravel 不做任何模糊匹配或下划线转驼峰的自动修正——写成 getFirst_nameAttribute 或 getfirstnameAttribute 都无效。

常见错误现象:$user->first_name 仍返回原始值,控制台无报错,容易误以为逻辑没生效。

  • 字段名含多个下划线(如 is_active_flag)→ 访问器应为 getIsActiveFlagAttribute
  • 字段本身已是驼峰(如 fullName)→ 访问器就是 getFullNameAttribute,不额外转换
  • 别试图用 getAttribute 或重写 __get —— 这会绕过 Eloquent 的访问器机制

访问器参数 $value 是数据库原始值,不是模型属性

访问器方法签名里带的 $value 参数,是该字段从数据库查出来的原始值(比如 created_at 是字符串 "2025-12-01 10:30:45"),不是 $this->created_at 的结果。这意味着:

  • 你不能在 getCreatedAtAttribute($value) 里再写 $this->created_at,否则会递归调用自己,直接报 Maximum function nesting level
  • 如果想基于其他字段计算(如拼接 first_name 和 last_name),就直接读 $this->first_name 和 $this->last_name,它们各自可能也有自己的访问器,Laravel 会自动处理链式调用
  • 修改器同理:setEmailAttribute($value) 中的 $value 是你赋的值(如 "JOHN@EXAMPLE.COM"),不是 $this->email

需要 JSON/API 返回时记得加到 $appends

访问器定义后,$user->display_name 在 PHP 里能取到,但 $user->toArray() 或 API 响应中默认不包含它。要让它自动出现在序列化结果里,必须显式声明:

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
protected $appends = ['display_name'];

注意:$appends 里的名字是属性名(display_name),不是方法名(getDisplayNameAttribute)。漏写这行,前端永远收不到这个字段。

  • 如果访问器依赖敏感数据(如手机号脱敏),别盲目加进 $appends,得配合隐藏字段($hidden)或条件追加
  • $appends 只影响 toArray()、toJson() 和 API Resource,不影响 pluck() 或 select() 查询结果
  • 多个访问器要全部列出来:['display_name', 'full_address', 'status_label']

访问器和同名字段不能共存

如果你定义了 getNameAttribute,又在数据库里有 name 字段,那每次读 $user->name 都走访问器——原始值被彻底屏蔽。这本身不是 bug,但容易引发意外:

  • 想临时读原始值?用 $user->getOriginal('name')
  • 想在访问器里用原始值做判断?参数 $value 就是它,别去读 $this->name
  • 千万别定义 getIdAttribute —— 会破坏 Eloquent 内部 ID 解析,导致关联、更新全失效

最常被忽略的一点:访问器只在通过模型实例读取属性时生效。用 DB::table('users')->select('name')->get() 或原生 SQL 查出来的数据,完全不经过任何访问器。别指望它对所有查询路径都起作用。

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

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

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

2024.04.09

857

10

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

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

2024.04.09

835

9

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

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

2024.04.09

2488

10

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

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

2024.04.10

4301

7

laravel入门教程
laravel入门教程

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

2025.08.05

6190

22

laravel实战教程
laravel实战教程

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

2025.08.05

4096

13

laravel面试题
laravel面试题

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

2025.08.05

7689

7

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

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

2026.03.04

1476

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

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

共1课时 | 212人学习

Composer手册
Composer手册

共0课时 | 0人学习