Laravel访问器？模型访问器如何定义？-Laravel-PHP中文网

Laravel访问器？模型访问器如何定义？

星降

发布： 2025-09-03 09:28:01

原创

202人浏览过

Laravel访问器通过get[属性名]Attribute方法在获取模型属性时修改值，如格式化日期、组合字段或解密数据，实现数据的自动处理与转换。

laravel访问器？模型访问器如何定义？

Laravel 访问器允许你在获取 Eloquent 模型属性时修改其值，本质上是在读取数据时提供一个“getter”方法。你可以使用访问器来格式化日期、加密数据、组合字段等等。定义访问器非常简单，只需在模型中创建一个以

get[属性名]Attribute

登录后复制

命名的方法即可。

解决方案：

定义 Laravel 模型访问器，实际上就是为模型属性创建一个“get”方法。这允许你在从模型中获取数据时，对该属性的值进行修改或格式化。

模型访问器如何定义？

定义访问器的方法是在你的 Eloquent 模型中创建一个方法，该方法遵循特定的命名约定：

get[属性名]Attribute

登录后复制

。例如，如果你想创建一个访问器来格式化

created_at

登录后复制

属性，你可以定义一个名为

getCreatedAtAttribute

登录后复制

的方法。

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 获取用户创建日期的格式化版本.
     *
     * @param  string  $value
     * @return string
     */
    public function getCreatedAtAttribute($value)
    {
        return date('Y-m-d H:i:s', strtotime($value));
    }

    /**
     * 获取用户的全名.
     *
     * @return string
     */
    public function getFullNameAttribute()
    {
        return $this->first_name . ' ' . $this->last_name;
    }
}

登录后复制

在这个例子中，

getCreatedAtAttribute

登录后复制

接收原始的

created_at

登录后复制

值，并使用

date()

登录后复制

函数将其格式化为

Y-m-d H:i:s

登录后复制

格式。当你在代码中访问

$user->created_at

登录后复制

时，你将获得格式化后的日期字符串，而不是原始的数据库值。

另外，

getFullNameAttribute

登录后复制

展示了如何组合多个字段。它将

first_name

登录后复制

和

last_name

登录后复制

属性组合成一个

full_name

登录后复制

属性。你可以像访问任何其他属性一样访问

$user->full_name

登录后复制

，而无需手动拼接字符串。

访问器的工作原理是 Laravel 会自动检测模型中以

get[属性名]Attribute

登录后复制

命名的方法。当你尝试访问该属性时，Laravel 会调用这个方法，并将方法的返回值作为属性的值返回。

访问器能做什么？

访问器不仅仅是简单的格式化工具。它们可以用于执行各种操作，例如：

数据转换： 将数据库中的原始数据转换为更易于使用的格式，例如将字符串转换为数组或对象。
数据组合： 将多个字段组合成一个逻辑属性，例如将
```
first_name
```
登录后复制
和
```
last_name
```
登录后复制
组合成
```
full_name
```
登录后复制
。
数据加密/解密： 在获取敏感数据时，对其进行解密操作。
数据计算： 根据其他属性计算出一个新的属性值，例如根据订单中的商品计算总价。
权限控制： 根据当前用户的权限，返回不同的属性值。

何时应该使用访问器？

一般来说，当需要在每次访问属性时都执行相同的逻辑时，就应该使用访问器。这可以避免在代码中重复编写相同的逻辑，提高代码的可维护性。

一个常见的错误是过度使用访问器。如果只需要在特定情况下修改属性值，那么使用访问器可能不是最佳选择。在这种情况下，直接在需要修改属性值的地方进行修改可能更简单。

MyBB 国外最好的免费论坛

MyBB的全称是mybboard，是一个基于PHP+MySQL搭建，功能强大，高效的开源论坛系统。 MyBB 使用了标准的论坛结构和模式，所以您的用户可以在您的论坛获得良好的用户体验。用户可以通过用户控制面板来自定义他们访问论坛的方式或者自定义他们想看到的论坛的内容，他们还可以方便地发表和答复一个主题并且标记与他们有关的主题。论坛管理员和版主可以使用MyBB的内置编辑器和版主工具等功能，控制并维

查看详情

如何使用访问器进行数据加密和解密？

你可以使用访问器来加密和解密敏感数据，例如用户的密码或信用卡信息。但是，需要注意的是，在数据库中存储加密数据是更安全的方法。

以下是一个使用访问器进行数据解密的示例：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Crypt;

class User extends Model
{
    /**
     * 获取解密后的信用卡号.
     *
     * @param  string  $value
     * @return string
     */
    public function getCreditCardAttribute($value)
    {
        try {
            return Crypt::decryptString($value);
        } catch (\Exception $e) {
            return null; // 或者抛出异常，取决于你的需求
        }
    }
}

登录后复制

在这个例子中，

getCreditCardAttribute

登录后复制

方法使用

Crypt::decryptString()

登录后复制

函数来解密

credit_card

登录后复制

属性的值。需要注意的是，如果解密失败，该方法会返回

null

登录后复制

。你需要根据你的需求来处理解密失败的情况。

使用访问器进行数据加密的示例：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Crypt;

class User extends Model
{
    /**
     * 设置加密后的信用卡号.
     *
     * @param  string  $value
     * @return void
     */
    public function setCreditCardAttribute($value)
    {
        $this->attributes['credit_card'] = Crypt::encryptString($value);
    }
}

登录后复制

需要注意的是，这里使用了