Laravel 一个对 ID 对称加密的 Composer 包 hashid

头条 jenkincei ⋅ 于 10个月前 ⋅ 最后回复由 hogus2037 6个月前 ⋅ 785 阅读

分享链接:https://zhuanlan.zhihu.com/p/29469956
Github:https://github.com/jiaxincui/hashid

介绍

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

依赖于hashids/hashids

只适用于正整数加密。

安装

$ composer require jiaxincui/hashid

配置

  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');

      简单使用

      包含两个辅助方法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'); //校验错误,抛出错误

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

Laravel深度应用

加密

有2种方法实现自动加密

  • 如果模型主键为id

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

    
    <?php
    namespace App;

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);
}

解密

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

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

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

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

中间件参数

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

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

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

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

本文章首发在 Laravel China 社区
回复数量: 1
  • 有遇到过使用懒加载的时候 如果定义主键访问器,主键ID会默认使用hash值造成的错误吗?

    6个月前
您需要登陆以后才能留下评论!

Composer 中国全量镜像

Top 250 扩展包

Lumen 中文文档

Laravel 速查表

Laravel 中文文档

Laravel 项目开发规范

Laravel 开发环境部署

Composer 中文文档

Elasticsearch-PHP 中文文档

Lumen 中文文档

GraphQL PHP 中文文档

社区文档撰写指南

TDD 构建 Laravel 论坛笔记

PHP PSR 标准规范

PHP 设计模式全集

Dingo API 中文文档