hashids

其他类别 2025-08-25

hashids是一个小型PHP库,可从数字中生成类似YouTube的ID。当您不想将数据库数字ID公开给用户时使用:https://hashids.org/php

笔记

hashids的创建者发布了一个新的,已升级的版本,重新命名为SQID 。但是, hashids将继续维护并供将来使用。有关更多信息,请访问SQIDS存储库,并了解其与SQIDS网站上的hashids的比较。

入门

在您的项目的根目录中需要此软件包,并带有作曲家。

hashids ">
composer require hashids / hashids

然后,您可以将课程导入您的应用程序:

hashids ; $ hashids = new hashids (); $ hashids ->encode(1);">
 use hashids  hashids ;

$ hashids = new hashids ();

$ hashids -> encode ( 1 );

注意hashids需要bcmathgmp扩展才能工作。

快速示例

hashids ; $ hashids = new hashids (); $id = $ hashids ->encode(1, 2, 3); // o2fXhV $numbers = $ hashids ->decode($id); // [1, 2, 3]">
 use hashids  hashids ;

$ hashids = new hashids ();

$ id = $ hashids -> encode ( 1 , 2 , 3 ); // o2fXhV
$ numbers = $ hashids -> decode ( $ id ); // [1, 2, 3] 

更多选项

其他几种将输入ID传递到encode()函数的方法:

hashids ; $ hashids = new hashids (); $ hashids ->encode(1, 2, 3); // o2fXhV $ hashids ->encode([1, 2, 3]); // o2fXhV $ hashids ->encode('1', '2', '3'); // o2fXhV $ hashids ->encode(['1', '2', '3']); // o2fXhV">
 use hashids  hashids ;

$ hashids = new hashids ();

$ hashids -> encode ( 1 , 2 , 3 ); // o2fXhV
$ hashids -> encode ([ 1 , 2 , 3 ]); // o2fXhV
$ hashids -> encode ( ' 1 ' , ' 2 ' , ' 3 ' ); // o2fXhV
$ hashids -> encode ([ ' 1 ' , ' 2 ' , ' 3 ' ]); // o2fXhV 

使您的输出ID唯一

传递项目名称以使您的输出ID唯一:

hashids ; $ hashids = new hashids ('My Project'); $ hashids ->encode(1, 2, 3); // Z4UrtW $ hashids = new hashids ('My Other Project'); $ hashids ->encode(1, 2, 3); // gPUasb">
 use hashids  hashids ;

$ hashids = new hashids ( ' My Project ' );
$ hashids -> encode ( 1 , 2 , 3 ); // Z4UrtW

$ hashids = new hashids ( ' My Other Project ' );
$ hashids -> encode ( 1 , 2 , 3 ); // gPUasb 

使用填充使您的输出ID更长

请注意,输出ID仅适合至少一定的长度。这并不意味着它们将完全是那个长度。

hashids ; $ hashids = new hashids (); // no padding $ hashids ->encode(1); // jR $ hashids = new hashids ('', 10); // pad to length 10 $ hashids ->encode(1); // VolejRejNm">
 use hashids  hashids ;

$ hashids = new hashids (); // no padding
$ hashids -> encode ( 1 ); // jR

$ hashids = new hashids ( '' , 10 ); // pad to length 10
$ hashids -> encode ( 1 ); // VolejRejNm 

使用自定义字母

hashids ; $ hashids = new hashids ('', 0, 'abcdefghijklmnopqrstuvwxyz'); // all lowercase $ hashids ->encode(1, 2, 3); // mdfphx">
 use hashids  hashids ;

$ hashids = new hashids ( '' , 0 , ' abcdefghijklmnopqrstuvwxyz ' ); // all lowercase
$ hashids -> encode ( 1 , 2 , 3 ); // mdfphx 

编码十六进制而不是数字

如果您想编码mongo的objectids,很有用。请注意,您可以通过的十六进制数量没有限制(不必是Mongo的Objectid)。

hashids ; $ hashids = new hashids (); $id = $ hashids ->encodeHex('507f1f77bcf86cd799439011'); // y42LW46J9luq3Xq9XMly $hex = $ hashids ->decodeHex($id); // 507f1f77bcf86cd799439011">
 use hashids  hashids ;

$ hashids = new hashids ();

$ id = $ hashids -> encodeHex ( ' 507f1f77bcf86cd799439011 ' ); // y42LW46J9luq3Xq9XMly
$ hex = $ hashids -> decodeHex ( $ id ); // 507f1f77bcf86cd799439011 

陷阱

  1. 解码时,输出始终是数字数组(即使您仅编码一个数字):

    hashids ; $ hashids = new hashids (); $id = $ hashids ->encode(1); $ hashids ->decode($id); // [1]">
     use hashids  hashids ;
    
    $ hashids = new hashids ();
    
    $ id = $ hashids -> encode ( 1 );
    
    $ hashids -> decode ( $ id ); // [1]
  2. 不支持编码负数。

  3. 如果将伪造输入传递给encode() ,则将返回一个空字符串:

    hashids ; $ hashids = new hashids (); $id = $ hashids ->encode('123a'); $id === ''; // true">
     use hashids  hashids ;
    
    $ hashids = new hashids ();
    
    $ id = $ hashids -> encode ( ' 123a ' );
    
    $ id === '' ; // true
  4. 请勿将此库作为安全措施。不要用它编码敏感数据。 hashids不是加密库。

随机性

hashids的主要目的是混淆数字ID。它并不意味着或测试用作安全或压缩工具。话虽如此,该算法确实试图使这些ID随机且不可预测:

编码多个相同的数字时没有显示模式(以下示例中显示3个):

hashids ; $ hashids = new hashids (); $ hashids ->encode(5, 5, 5); // A6t1tQ">
 use hashids  hashids ;

$ hashids = new hashids ();

$ hashids -> encode ( 5 , 5 , 5 ); // A6t1tQ

编码一系列数字与单独编码它们时,情况也是如此:

hashids ; $ hashids = new hashids (); $ hashids ->encode(1, 2, 3, 4, 5, 6, 7, 8, 9, 10); // wpfLh9iwsqt0uyCEFjHM $ hashids ->encode(1); // jR $ hashids ->encode(2); // k5 $ hashids ->encode(3); // l5 $ hashids ->encode(4); // mO $ hashids ->encode(5); // nR">
 use hashids  hashids ;

$ hashids = new hashids ();

$ hashids -> encode ( 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 ); // wpfLh9iwsqt0uyCEFjHM

$ hashids -> encode ( 1 ); // jR
$ hashids -> encode ( 2 ); // k5
$ hashids -> encode ( 3 ); // l5
$ hashids -> encode ( 4 ); // mO
$ hashids -> encode ( 5 ); // nR 

诅咒! #$%@

该代码的编写是为了将输出ID放置在可见位置,例如URL。因此,该算法试图避免通过生成从未有以下字母彼此的字母的ID来产生最常见的英语诅咒单词:

 c, f, h, i, s, t, u
下载源码

通过命令行克隆项目:

git clone https://github.com/vinkla/hashids.git