README

Laravel 扩展包，用于生成和验证符合 RFC 4122 标准的通用唯一标识符 (UUID)。内置支持版本 1、3、4 和 5 的 UUID。

4.* 版本中的新功能

Laravel-uuid 现已准备好支持 Laravel 8。它具有相同的要求，这意味着 PHP 7.3 或 PHP 8。Laravel 扩展包自动发现已启用，您现在可以使用 UUID 验证。验证示例见下文和测试。

对于旧版本的 Laravel 或 PHP，请使用旧版本；见下文...

3.* 版本中的新功能

Laravel-uuid 现已重构以支持 Laravel 5.5。它具有相同的要求，这意味着 PHP 7。Laravel 扩展包自动发现已启用，您现在可以使用 UUID 验证。验证示例见下文和测试。

Laravel 5.0、5.1、5.2、5.3 和 5.4？请使用 版本 2

Laravel 4.*？请使用 版本 1

安装

在 Laravel 5.5 中，laravel-uuid 通过新的包发现功能进行安装，因此您只需要将包添加到您的 composer.json 文件中

composer require "webpatser/laravel-uuid:^3.0"

安装后，您应该看到

Discovered Package: webpatser/laravel-uuid

然后您就可以开始了

基本用法

要快速生成一个 UUID，只需这样做

Uuid::generate()

这将生成一个具有随机生成的 MAC 地址的版本 1 Uuid 对象。

要输出生成的 UUID，将其转换为字符串

(string) Uuid::generate()

或

Uuid::generate()->string

高级用法

UUID 创建

生成一个基于时间的版本 1 UUID。您可以设置可选的节点为 MAC 地址。如果没有提供，将生成一个随机的 MAC 地址。

Uuid::generate(1,'00:11:22:33:44:55');

生成一个基于名称的版本 3 UUID，使用 MD5 哈希

Uuid::generate(3,'test', Uuid::NS_DNS);

生成一个版本 4 的真正随机的 UUID

Uuid::generate(4);

生成一个基于名称的版本 5 UUID，使用 SHA-1 哈希

Uuid::generate(5,'test', Uuid::NS_DNS);

一些魔法功能

导入 UUID

$uuid = Uuid::import('d3d29d70-1d25-11e3-8591-034165a3a613');

提取基于时间的 UUID（版本 1）的时间

$uuid = Uuid::generate(1);
dd($uuid->time);

提取 UUID 的版本

$uuid = Uuid::generate(4);
dd($uuid->version);

Eloquent UUID 生成

如果您想在 Laravel 模型中自动生成 UUID，只需将此 boot 方法添加到您的模型中。

/**
 *  Setup model event hooks
 */
public static function boot()
{
    parent::boot();
    self::creating(function ($model) {
        $model->uuid = (string) Uuid::generate(4);
    });
}

这将在新记录创建时生成版本 4 UUID。

将模型绑定到 UUID 而不是主键

如果您想在 URL 中使用 UUID 而不是主键，可以将此添加到您的模型中（其中 'uuid' 是存储 UUID 的列名）

/**
 * Get the route key for the model.
 *
 * @return string
 */
public function getRouteKeyName()
{
    return 'uuid';
}

当您在资源控制器方法中注入模型时，将获取正确的记录

public function edit(Model $model)
{
   return view('someview.edit')->with([
        'model' => $model,
    ]);
}

验证

就像使用任何其他 Laravel 验证器一样。

'uuid-field' => 'uuid'

或从头创建验证器。在示例中验证了一个 Uuid 对象。您还可以验证字符串 $uuid->string、URN $uuid->urn 或二进制值 $uuid->bytes

$uuid = Uuid::generate();
$validator = Validator::make(['uuid' => $uuid], ['uuid' => 'uuid']);
dd($validator->passes());

注意

有关 UUID 规范的完整详细信息，请参阅 http://tools.ietf.org/html/rfc4122。