在php8.0+版本中使用属性来增加值代码示例

Java  /  管理员 发布于 2年前   469

PHP属性是在语言的8.0版本中加入的，它对许多开发者来说是一个误区。它们有什么好处，我怎样才能使用它们？

自从它们发布以来，我一直在问自己这个问题，直到最近我才发现它们的一个用例。

在做一个需要API访问的项目时, 我决定使用Laravel Breeze并在Sanctums API Tokens周围添加一个封装器，而不是Jetstream。

这让我开始琢磨如何更好地利用令牌本身的作用。

如果你以前使用过Laravel Jetstream，你会知道你在服务提供者中注册权限和令牌能力。

如果你有一个简单的API，这是一个可以接受的方法。

然而, 我的需求比这更复杂 - 但还没有复杂到需要设置OAuth.

取而代之的是，我想利用PHP的原生枚举结构，这是存储用户角色时常用的方法之一。

但是枚举不够详细，这就造成了一个问题。

关于如何在PHP 8.1版本的枚举中可以使用属性扩展示例：

https://www.zongscan.com/demo333/96277.html

他的用例与我的不同，但是，哇--我的眼睛终于被打开了，看到了一个用例!

我需要创建一套权限，允许用户创建的API令牌具有特定的能力。

然而，我想让用户也能理解他们所设置的权限。

我的第一步是创建一个基本的枚举：

enum Permission: string
{
    case ADMIN = 'ADMIN';
 
    case EDITOR = 'EDITOR';
}

这两种类型的权限有明显的区别。一个人应该可以做所有的事情--而另一个人则有更多有限的权限。

这就是我回顾Robs的教程并实现描述属性的地方。

use Attribute;
 
#[Attribute]
final readonly class Description
{
    public function __construct(
        public string $description,
    ) {}
}

我希望我的属性是不可变的，这样就没有什么可以改变它们。

所以一个只读的类在这里是很有意义的，这并不是说我需要一个借口......

现在我所要做的就是把属性添加到我的枚举中：

enum Permission: string
{
    #[Description('Admin users can perform any action.')]
    case ADMIN = 'ADMIN';
 
    #[Description('Editor users have the ability to read, and update.')]
    case EDITOR = 'EDITOR';
}

这就提供了我希望用户能够理解的每个权限的信息。然而，我又面临着另一个问题。

我怎样才能存储能力？我知道枚举只允许字符串或整数作为案例，那么我可以做什么？

我又一次在属性中找到了我的答案--出乎意料。如果一个属性可以用来添加描述，它也可以用来添加其他东西。

所以我创建了另一个名为Abilities的属性，它可以接收一个字符串数组，以自由的方式列出它们。

#[Attribute]
final readonly class Abilities
{
    public function __construct(
        public array $abilities,
    ) {}
}

现在我所需要做的就是把这个添加到我的枚举中，我可以把令牌设置为枚举，并在保存到数据库时使用反射来拉出能力。

enum Permission: string
{
    #[Key('admin')]
    #[Description('Admin users can perform any action.')]
    #[Abilities(['create','read','update','delete'])]
    case ADMIN = 'ADMIN';
 
    #[Key('editor')]
    #[Description('Editor users have the ability to read, and update.')]
    #[Abilities(['read','update'])]
    case EDITOR = 'EDITOR';
}

这是我最终得到的结果。我想让一个引用键有一个更好的字符串来引用。

现在我可以按照Robs的教程，实现一个访问这些属性的方法。

trait CanAccessAttributes
{
    public static function abilities(BackedEnum $enum): array
    {
        $reflection = new ReflectionClassConstant(
            class: self::class,
            constant: $enum->name,
        );
 
        $attributes = $reflection->getAttributes(
            name: Abilities::class,
        );
 
        if (0 === count($attributes)) {
            return [Str::headline(
                value: strval($enum->value)
            )];
        }
 
        return $attributes[0]->newInstance()->abilities;
    }
 
    public static function key(BackedEnum $enum): string
    {
        $reflection = new ReflectionClassConstant(
            class: self::class,
            constant: $enum->name,
        );
 
        $attributes = $reflection->getAttributes(
            name: Key::class,
        );
 
        if (0 === count($attributes)) {
            return Str::headline(
                value: $enum->value
            );
        }
 
        return $attributes[0]->newInstance()->key;
    }
 
    public static function description(BackedEnum $enum): string
    {
        $reflection = new ReflectionClassConstant(
            class: self::class,
            constant: $enum->name,
        );
 
        $attributes = $reflection->getAttributes(
            name: Description::class,
        );
 
        if (0 === count($attributes)) {
            return Str::headline(
                value: $enum->value
            );
        }
 
        return $attributes[0]->newInstance()->description;
    }
}

一个简单的特质允许我访问我想要的所有属性。

由于我的应用程序使用的是Inertia，我所需要做的就是在HandlesInertia中间件中传递一个资源，这样我的用户界面就可以详细地访问各地的这些权限。

我决定为此创建一个API资源，这样我就可以一致地处理格式化问题。

/**
 * @property-read Permission $resource
 */
final class PermissionResource extends JsonResource
{
    public function toArray(Request $request): array
    {
        return [
            'key' => $this->resource->key($this->resource),
            'name' => $this->resource->name,
            'value' => $this->resource->value,
            'description' => $this->resource->description($this->resource),
            'abilities' => $this->resource->abilities($this->resource),
        ];
    }
}

我终于找到了一个属性的用例，同时建立了一个我认为是在你的应用程序中注册这些数据的好方法。

转：

https://laravel-news.com/using-attributes-to-add-value