isszz / think-hashids
Thinkphp Hashids Used to generate a youtube-like ID from a digital ID
v0.0.1
2023-07-27 08:24 UTC
Requires
- php: >=8.0.0
- hashids/hashids: ^4.1.0
- topthink/framework: 8.*|6.0.*
README
- Thinkphp 中使用 Hashids 用于将数字ID生成类似YouTube的ID。当您不想向用户公开数据库数字ID时使用
- 支持B站的ID生成模式,生成B站/video/
BV1fx411v7eo
这种ID
安装
composer require isszz/think-hashids
配置
在 config/hashids.php 中更改
return [ // 默认连接名称 'default' => 'main', // 支持bilibili的BV模式 // Hashids modes 'modes' => [ 'main' => [ 'salt' => '', 'length' => 0, ], 'other' => [ 'salt' => 'salt', 'length' => 0, 'alphabet' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890' ], 'bilibili' => [ // 此模式无需添加其他的配置 // 前缀超过2位英文字母忽略 'prefix' => ['', ''], // B站BV模式前缀类似: BV1fx411v7eo = 12345678 ], ], ];
用法
facade方式引入
use isszz\hashids\facade\Hashids; class Index { public function index() { // B站BV模式, B站模式支持第二个参数增加前缀,可以设置例如: prefix = '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 // 更改默认模式为bilibili Hashids::setDefaultMode('bilibili'); Hashids::encode(12345678); // 1fx411v7eo Hashids::decode('1rQ2go'); // 12345678 // 其他传输ID的方式,返回为数组,对应传参 Hashids::encode(12, 34, 56, 78); // nyILSjosbR $hashID = Hashids::encode([12, 34, 56, 78]); // nyILSjosbR $result = Hashids::decode($hashID); // 返回数组,对应传入参数 /* $result = [ '0' => 12 '1' => 34 '2' => 56 '3' => 78 ]; */ } }
依赖注入方式
use isszz\hashids\Hashids; class Index { public function index(Hashids $hashids) { // B站BV模式, B站模式支持第二个参数增加前缀,可以设置例如: prefix = '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 // 更改默认模式为bilibili $hashids->setDefaultMode('bilibili'); } }
助手函数
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(); } }
使用模型获取器对ID进行加密
public function getIdAttr($value) { return id_encode($value); } // 主键非id时, 比如是tid时 public function getTidAttr($value) { return id_encode($value); }
- 基础库来自: vinkla/hashids