要在 PHP 框架中集成 Hashids,请按照以下步骤操作:
安装 Hashids:
使用 Composer 安装 Hashids。打开命令行或终端,然后运行以下命令:
composer require hashids/hashids
创建一个配置文件:
在你的应用程序的 config
目录中创建一个名为 hashids.php
的新文件。将以下内容添加到该文件中:
<?php
return [
'salt' => env('HASHIDS_SALT', 'your-salt-string'),
'length' => env('HASHIDS_LENGTH', 10),
'alphabet' => env('HASHIDS_ALPHABET', 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'),
];
这里的值可以根据你的需求进行修改。salt
是用于加密的盐值,length
是生成的 Hash 字符串的长度,alphabet
是用于生成 Hash 的字符集。
在 .env
文件中添加配置变量:
在项目根目录的 .env
文件中添加以下内容:
HASHIDS_SALT=your-salt-string
HASHIDS_LENGTH=10
HASHIDS_ALPHABET=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890
请确保为 HASHIDS_SALT
设置一个安全的值。
创建一个服务提供者:
在 app/Providers
目录中创建一个名为 HashidsServiceProvider.php
的新文件。将以下内容添加到该文件中:
<?php
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
use Hashids\Hashids;
class HashidsServiceProvider extends ServiceProvider
{
/**
* Register services.
*
* @return void
*/
public function register()
{
$this->app->singleton(Hashids::class, function ($app) {
return new Hashids(
config('hashids.salt'),
config('hashids.length'),
config('hashids.alphabet')
);
});
}
/**
* Bootstrap services.
*
* @return void
*/
public function boot()
{
//
}
}
这个服务提供者将 Hashids 注册为一个单例,以便在整个应用程序中重复使用。
在 config/app.php
中注册服务提供者:
在 config/app.php
文件的 providers
数组中添加以下内容:
App\Providers\HashidsServiceProvider::class,
使用 Hashids:
现在你可以在你的应用程序中使用 Hashids。例如,在控制器中,你可以这样做:
use Hashids\Hashids;
public function getHashedId(int $id, Hashids $hashids)
{
return $hashids->encode($id);
}
这将返回给定 ID 的 Hash 字符串。要解码 Hash 字符串,只需调用 decode()
方法:
$decodedId = $hashids->decode($hashedId)[0];
通过以上步骤,你已经成功地在 PHP 框架中集成了 Hashids。现在你可以在你的应用程序中使用它来生成和解码 Hash 字符串。