Laravel 模型 Setter 和 Getter 方法指南：自定义属性访问和设置

在 Laravel 开发中，我们常常需要对模型属性进行一些额外的处理，例如在保存数据到数据库之前进行格式化，或者在读取数据后进行一些转换。这时，我们就需要用到 Setter 和 Getter 方法。它们就像模型属性的守门员，控制着数据的进出。

Laravel 自身提供了一种优雅的方式来实现 Setter 和 Getter，那就是 Accessors 和 Mutators。Accessors 用于获取属性值时的处理，而 Mutators 则用于设置属性值时的处理。

举个例子，假设我们有一个 User 模型，其中有一个 first_name 和 last_name 属性。我们希望在获取用户全名时，能够自动将这两个属性拼接起来。这时，我们可以使用 Accessor：

class User extends Model
{
    public function getFullNameAttribute()
    {
        return $this->first_name . ' ' . $this->last_name;
    }
}

现在，当我们访问 $user->full_name 时，Laravel 会自动调用 getFullNameAttribute() 方法，并将结果返回给我们。

同样的，如果我们希望在设置用户全名时，能够自动将全名拆分成 first_name 和 last_name 两个属性，我们可以使用 Mutator：

class User extends Model
{
    public function setFullNameAttribute($value)
    {
        $names = explode(' ', $value);
        $this->attributes['first_name'] = $names[0];
        $this->attributes['last_name'] = $names[1];
    }
}

现在，当我们设置 $user->full_name = 'John Doe' 时，Laravel 会自动调用 setFullNameAttribute() 方法，并将 'John Doe' 拆分成 'John' 和 'Doe'，分别赋值给 first_name 和 last_name 属性。

Accessors 和 Mutators 的命名规则非常简单，get[AttributeName]Attribute 用于 Accessor，set[AttributeName]Attribute 用于 Mutator。

除了 Accessors 和 Mutators，我们还可以使用自定义的 Setter 和 Getter 方法。这种方式更加灵活，可以实现更复杂的逻辑。

例如，我们希望对用户的年龄进行一些限制，例如年龄不能小于 0，也不能大于 120。我们可以这样实现：

class User extends Model
{
    public function setAgeAttribute($value)
    {
        if ($value < 0 || $value > 120) {
            throw new \InvalidArgumentException('年龄必须在 0 到 120 之间。');
        }
        $this->attributes['age'] = $value;
    }

    public function getAgeAttribute($value)
    {
        // 可以在这里对年龄进行一些额外的处理，例如转换为字符串
        return (string) $value;
    }
}

自定义 Setter 和 Getter 方法的命名规则也很简单，set[AttributeName] 用于 Setter，get[AttributeName] 用于 Getter。

需要注意的是，如果我们同时定义了 Accessor/Mutator 和自定义 Setter/Getter 方法，Laravel 会优先使用 Accessor/Mutator。

通过合理地使用 Setter 和 Getter 方法，我们可以使模型更加健壮，代码更加易于维护。

常见问题解答

1. Accessors 和 Mutators 的作用是什么？

   • Accessors 用于在获取模型属性值时进行额外的处理，例如格式化数据。Mutators 用于在设置模型属性值时进行额外的处理，例如数据验证。

2. 如何定义 Accessor 和 Mutator？

   • Accessor 的命名规则是 get[AttributeName]Attribute，Mutator 的命名规则是 set[AttributeName]Attribute。

3. 如何定义自定义 Setter 和 Getter 方法？

   • Setter 的命名规则是 set[AttributeName]，Getter 的命名规则是 get[AttributeName]。

4. 如果同时定义了 Accessor/Mutator 和自定义 Setter/Getter 方法，Laravel 会优先使用哪一个？

   • Laravel 会优先使用 Accessor/Mutator。

5. 使用 Setter 和 Getter 方法有什么好处？

   • 可以使模型更加健壮，代码更加易于维护，例如可以进行数据验证、格式化数据等。