Laravel 对 ID 进行对称加密的 Composer 包 hashid

GitHub：
jiaxincui/hashid

介绍#

一个对 Laravel 应用模型 ID 进行对称加密的辅助函数。

依赖于 hashids/hashids

只适用于正整数加密。

安装#

$ composer require jiaxincui/hashidCopy

配置#

1. 复制 config/hashid.php 文件到 Laravel 项目的 config 文件夹。
2. 在.env 文件添加配置项 HASH_ID_ALPHABET=your-key。
   • 为了 Hash 成更安全的字符串，请手动重新生成 HASH_ID_ALPHABET，为 0-9a-zA-Z 共 62 个字符随机排序，字符不可重复，长度为 16-62，可使用以下方法生成

     echo str_shuffle('0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ');Copy

     简单使用#

     包含两个辅助方法 id_encode() 和 id_decode()。
     在 Laravel 项目的任何地方均可使用这两个函数对 ID 进行加密或解密。

例子#

echo id_encode(4568); //输出:N5lkv0

echo id_decode('N5lkvO'); //输出:4568

//不可对float类型数字加密，不可对负数加密，给定任何非正整数参数都会抛出错误，如：
echo id_encode(2.36); //非正整数,抛出错误
echo id_encode(-23); //非正整数,抛出错误

//解密时任何无效字符串参数或校验错误都会抛出错误, 如：
echo id_decode('m_Dl9'); //包含无效字符,抛出错误
echo id_decode('nlK8GhRW'); //校验错误,抛出错误
Copy

和 hashids/hashids 不同的是 hashids 提供多个数字或包含多个数字的数组加密成一个字符串，
解密时以数组形式返回，这在实际应用中并不常见，反而给使用带来一定麻烦，
而此包对此进行了一些处理，不提供多个数字或多个数字数组的加密，解密时直接返回解密后的数字。

Laravel 深度应用#

加密#

有 2 种方法实现自动加密

• 如果模型主键为 id

  通过 Hashid 提供的 trait，在数据库模型中使用 use Hashid;，对结果中的 id 字段自动加密成字符串，例如：

  
  <?php
  namespace App;Copy

use Illuminate\Database\Eloquent\Model;
use Jiaxincui\Hashid\Traits\Hashid;

class User extends Model
{
use Hashid;

}

* 如果模型中的主键不是`id`

  你需要在模型中定义一个访问器，如你的主键为`pid`，在Model中添加访问器如下：

```php
public function getPidAttribute($value)
{
  return id_encode($value);
}Copy

解密#

通过 Hashid 提供的 middleware 对路由参数解码，在控制器中无需做任何操作即可解码加密后的路由参数。
首先在 App\Http\Kernel.php 中注册中间件，在 Kernel 类的 $routeMiddleware 属性添加中间件条目。例如：

'hashid' => \Jiaxincui\Hashid\Http\Middleware\Hashid::class,Copy

现在你可以在路由中分配中间件了。例如：

Route::resource('/users', 'UserController')->middleware('hashid');Copy

中间件参数#

默认情况下，Hashid 中间件会解密当前路由的所有路由参数，如果你想指定被解密的路由参数可在中间件传入参数，例如：

Route::get('users/{user}/posts/{post}/comments/{comment}', function ($user, $post, $comment) {
    //
})->middleware('hashid:user,post');
Copy

以上例子中间件只解密给出的参数，如以上例子会解密路由参数 user 和 post, 不会解密 commnent

现在你的应用已经具备完整的加密和解密模型 ID 的功能。

本作品采用《CC 协议》，转载必须注明作者和本文链接