Laravel中的优雅访问器和修改器-猿码集

1. 什么是访问器和修改器

访问器和修改器是Laravel中的两个重要概念，它们允许您在获取和设置模型属性值时添加额外的逻辑。使用这些方法可以帮助减少对模型属性的重复代码。

访问器和修改器可以定义为普通的公共方法，用于处理模型的属性访问和修改行为。

访问器：用于获取模型的属性值，在获取属性值时对其进行处理或计算，返回需要的值。

修改器：用于设置属性值，当设置属性值时自动执行修改器方法，对该属性值进行处理或验证，返回处理后的值。

让我们看看如何在Laravel中使用访问器和修改器。

2. 如何定义访问器

Laravel允许您通过在模型中定义以 get 开头的方法来定义访问器。这些方法将被用于获取给定属性的值。

2.1 定义简单的访问器

下面是一个例子，其中定义了一个简单的访问器来转换用户的名字：

namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * 获取用户的名字
     *
     * @param  string  $value
     * @return string
     */
    public function getNameAttribute($value)
    {
        return ucfirst($value);
    }
}

在上面的示例中，当您试图访问用户模型的name属性时，会自动调用getNameAttribute方法，将其返回值作为属性的值。在这个例子中，我们使用ucfirst函数（将字符串的首字母大写）转换了用户的名字。

2.2 定义带参数的访问器

您还可以定义带参数的访问器，这些参数将被传递给访问器方法：

namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * 获取用户的名字和姓氏
     *
     * @param  string  $value
     * @param  string  $delimiter
     * @return string
     */
    public function getFullNameAttribute($value, $delimiter = ' ')
    {
        $fullName = $this->attributes['first_name'].$delimiter.$this->attributes['last_name'];
        return ucwords($fullName);
    }
}

在上面的示例中，我们定义了一个带有$delimiter参数的getFullNameAttribute访问器方法，它将用户的first_name和last_name连接起来形成全名，并将其返回。

3. 如何定义修改器

与访问器类似，Laravel也允许您通过在模型中定义以 set 开头的方法来定义修改器。这些方法将被用于在设置模型属性值时执行逻辑。

3.1 定义简单的修改器

下面是一个例子，其中定义了一个简单的修改器，用于将用户的名字转换为大写：

namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * 设置用户的名字
     *
     * @param  string  $value
     * @return void
     */
    public function setNameAttribute($value)
    {
        $this->attributes['name'] = strtoupper($value);
    }
}

在上面的示例中，当您尝试为用户模型的name属性设置值时，将自动调用setNameAttribute方法。在这个例子中，我们使用strtoupper函数将名字转换为大写，并将其赋值给模型的name属性。

3.2 定义带参数的修改器

您还可以定义带参数的修改器，这些参数将在设置属性值时传递给修改器方法：

namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * 设置用户的全名
     *
     * @param  string  $value
     * @param  string  $delimiter
     * @return void
     */
    public function setFullNameAttribute($value, $delimiter = ' ')
    {
        list($firstName, $lastName) = explode($delimiter, $value);
        $this->attributes['first_name'] = $firstName;
        $this->attributes['last_name'] = $lastName;
    }
}

在上面的示例中，我们定义了一个带有$delimiter参数的setFullNameAttribute修改器方法，它将用户的fullName属性拆分为first_name和last_name，并将它们分别存储为模型的属性。

4. 使用访问器和修改器

访问器和修改器非常适合将模型属性值转换为格式化的字符串、处理日期等操作。让我们看一些在Laravel应用中使用这些方法的例子。

4.1 案例：格式化时间戳

假设您的应用存储了用户注册的时间戳，您希望在模板中以易于阅读的方式显示该时间戳。您可以定义一个访问器来格式化该时间戳。

namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * 获取用户注册的时间戳
     *
     * @param  string  $value
     * @return string
     */
    public function getRegisteredAtAttribute($value)
    {
        return date('Y-m-d H:i:s', strtotime($value));
    }
}

在上面的示例中，我们定义了一个getRegisteredAtAttribute访问器方法，用于将用户注册的时间戳格式化为Y-m-d H:i:s格式的字符串。

4.2 案例：处理密码

假设您的应用将用户密码存储为哈希值，您希望在将密码设置为模型属性时，自动将其哈希化。您可以定义一个修改器来处理密码。

namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Hash;
class User extends Model
{
    /**
     * 设置用户密码
     *
     * @param  string  $value
     * @return void
     */
    public function setPasswordAttribute($value)
    {
        $this->attributes['password'] = Hash::make($value);
    }
}

在上面的示例中，我们定义了一个setPasswordAttribute修改器方法，用于将用户输入的密码哈希化后存储到模型的password属性中。在这里，我们使用Hash门面来进行哈希操作。

4.3 案例：处理JSON数据

假设您的应用存储订单信息，并将其作为JSON字符串存储在模型的order_data属性中。您可以定义一个访问器方法来获取该JSON字符串并将其解码为PHP数组，以便您可以轻松访问订单信息。

namespace App;
use Illuminate\Database\Eloquent\Model;
class Order extends Model
{
    /**
     * 获取订单数据
     *
     * @param  string  $value
     * @return array
     */
    public function getOrderDataAttribute($value)
    {
        return json_decode($value, true);
    }
}

在上面的示例中，我们定义了一个getOrderDataAttribute访问器方法，用于获取订单数据并将其解码为PHP数组。现在，当您尝试访问模型的order_data属性时，将返回解码的数组。

5. 总结

访问器和修改器是Laravel模型的重要特性，它们允许您对模型属性的访问进行自定义处理。访问器用于获取属性值，而修改器用于在设置属性值时执行逻辑。这些方法非常适合处理模型属性值的格式化、数学计算、日期处理等操作。

Laravel中的优雅访问器和修改器