PHPackages                             isszz/webman-hashids - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. isszz/webman-hashids

ActiveLibrary[Utility & Helpers](/categories/utility)

isszz/webman-hashids
====================

Webman Hashids Used to generate a youtube-like ID from a digital ID

v0.0.2(3mo ago)52.6k↓33.3%[2 issues](https://github.com/isszz/webman-hashids/issues)MITPHPPHP >=8.0.0

Since Aug 1Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/isszz/webman-hashids)[ Packagist](https://packagist.org/packages/isszz/webman-hashids)[ RSS](/packages/isszz-webman-hashids/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (3)Used By (0)

webman-hashids
==============

[](#webman-hashids)

- Webman 中使用 Hashids 用于将数字ID生成类似YouTube的ID。当您不想向用户公开数据库数字ID时使用
- 支持B站的ID生成模式，生成B站/video/`BV1fx411v7eo`这种ID

 [![Minimum PHP Version](https://camo.githubusercontent.com/e8223ac675b6f9feddec95a806a57528e8009d21035aca7c0650e6006fa81c36/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d3e3d382e302d3838393242462e737667)](https://packagist.org/packages/isszz/webman-hashids) [![Minimum Webman Version](https://camo.githubusercontent.com/6850dbda4c87c752e9dca528b726d0f6bbceaeec4da955ed37bd655f9a138116/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5765626d616e2d3e3d312e342e782d3838393242462e737667)](https://packagist.org/packages/isszz/webman-hashids) [![Stable Version](https://camo.githubusercontent.com/ce006940d42c1e0af162e56f631a6e270b20d8615fef8681ee4e3121318a5fc8/68747470733a2f2f706f7365722e707567782e6f72672f6973737a7a2f7765626d616e2d686173686964732f762f737461626c65)](https://packagist.org/packages/isszz/webman-hashids) [![Total Downloads](https://camo.githubusercontent.com/274786e52990ac57d4e7a4b0538219d199ed07d74d6dbbe09c4ba25d2b66c670/68747470733a2f2f706f7365722e707567782e6f72672f6973737a7a2f7765626d616e2d686173686964732f646f776e6c6f616473)](https://packagist.org/packages/isszz/webman-hashids) [![License](https://camo.githubusercontent.com/9c735e2e3ba1b36e6a5950b1f31ae62380256eb6344c8580ee8930a64b640570/68747470733a2f2f706f7365722e707567782e6f72672f6973737a7a2f7765626d616e2d686173686964732f6c6963656e7365)](https://packagist.org/packages/isszz/webman-hashids)

安装
--

[](#安装)

```
composer require isszz/webman-hashids
```

配置
--

[](#配置)

在 config/plugin/isszz/webman-hashids/app.php 中更改

```
return [
    'enable'  => true,

    // 默认连接名称
    'default' => 'main', // 支持bilibili的BV模式

    // Hashids modes
    'modes' => [
        'main' => [
            'salt' => '',
            'length' => 0,
            'alphabet' => 'oqyei4pYnjDLXuPOw6c9IvzlWUmBs1Z0rdAkFCKM8hgHb2QV7NJ35TfaxRtESGArray'
        ],
        'other' => [
            'salt' => 'salt',
            'length' => 0,
            'alphabet' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'
        ],
        'bilibili' => [
            // 此模式无需添加其他的配置
            // 前缀超过2位英文字母忽略
            'prefix' => '', // B站BV模式前缀类似: BV1fx411v7eo = 12345678
        ],
    ],
];
```

用法
--

[](#用法)

**依赖注入方式**

```
use isszz\hashids\Hashids;

class Index
{
    public function index(Hashids $hashids)
    {
        // B站BV模式, B站模式支持第二个参数增加前缀，可以设置例如: prefix = 'BV'
        $_hashids = $hashids->mode(name: 'bilibili');
        $_hashids->encode(12345678); // 1fx411v7eo
        $_hashids->decode('1fx411v7eo'); // 12345678

        // other模式
        $hashids->mode('other')->encode(12345678); // gpyAoR
        $hashids->mode('other')->decode('gpyAoR'); // 12345678

        // 默认
        $hashids->encode(12345678); // 1rQ2go
        $hashids->decode('1rQ2go'); // 12345678

        // 其他传输ID的方式，返回为数组，对应传参
        $hashID = $hashids->encode(12, 34, 56, 78); // nyILSjosbR
        $hashID2 = $hashids->encode([12, 34, 56, 78]); // nyILSjosbR

        $result = $hashids->decode($hashID);
        // 返回数组
        /*
        $result = [
            '0' => 12
            '1' => 34
            '2' => 56
            '3' => 78
        ];
        */
    }
}
```

**facade方式引入**

```
use isszz\hashids\facade\Hashids;

class Index
{
    public function index()
    {
        // B站BV模式
        Hashids::mode('bilibili')->encode(12345678); // 1fx411v7eo
        Hashids::mode('bilibili')->decode('1fx411v7eo'); // 12345678

        // other模式
        Hashids::mode('other')->encode(12345678); // gpyAoR
        Hashids::mode('other')->decode('gpyAoR'); // 12345678

        // 默认
        Hashids::encode(12345678); // 1rQ2go
        Hashids::decode('1rQ2go'); // 12345678
    }
}
```

**助手函数**

```
class Index
{
    public function index()
    {
        // 加密
        id_encode(12345678); // 1rQ2go
        id_encode(12, 34, 56, 78, 'other'); // nyILSjosbR
        id_encode([12, 34, 56, 78], mode: 'other'); // nyILSjosbR

        // 解密
        id_decode('1rQ2go'); // 12345678
        id_decode('gpyAoR', 'other'); // 12345678

        // 切换模式
        id_mode('other')->encode(12345678); // gpyAoR
        id_mode('other')->decode('gpyAoR'); // 12345678

        // 助手函数还有一个获取字母表的函数
        // 拿到可以用来设置`config/plugin/isszz/webman-hashids/app.php `配置中的alphabet字段
        $alphabet = id_build_alphabet();
    }
}
```

**使用ThinkORM获取器对ID进行加密**

```
public function getIdAttr($value)
{
    return id_encode($value);
}

// 主键非id时, 比如是tid时
public function getTidAttr($value)
{
    return id_encode($value);
}
```

**使用Laravel Eloquent ORM访问器对ID进行加密**

```
// 10.x版本
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    protected function id(): Attribute
    {
        return Attribute::make(
            get: fn (int $value) => id_encode($value),
        );
    }
}

// 8.x版本
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    public function getIdAttribute($value)
    {
        return id_encode($value);
    }
}
```

### Request请求中的使用案例

[](#request请求中的使用案例)

**新建一个路由中间件，在需要的路由引入，不需要解密的路由不建议引入**

```