Laravel 自动转换长整型雪花 ID 为字符串的实现


Posted in PHP onOctober 27, 2020

在设计 API 时,出于安全性等因素考虑,有时需要放弃使用自增 ID,使 ID 非连续且不可猜测。通常可以使用 Hash id,UUID,雪花 ID 等来实现。

在最近的一个项目中,我尝试使用雪花 ID。一通折腾下来发现,逼格挺高,实现也挺简单。然而当我继续撸起袖子与前端部分对接时,却出现了 JS 精度丢失问题,因为存储的 ID 是一个 unsigned bigint 型的值。(至于为什么会有精度丢失现象,这里就不具体解释了,不清楚的可以自行搜索),本文主要介绍解决办法。

想要解决这问题,基本原理也很简单,就是把 ID 转成字符串再返回给前端。

错误尝试

一开始我想到的是使用 Laravel Eloquent 模型的模型访问器。只要给需要转换的模型加一个 getIdAttribute,将 ID 转成字符串不就行了嘛?

如:AppModelsUser 模型里这样写:

/**
 * @return string
 */
public function getIdAttribute()
{
  return strval($this->attributes['id']);
}

但事实并非如此,属性访问器确实能让 API 返回给前端的 ID 变为字符串。但同时也会影响关联模型插入、修改时的结果,例如,user 关联的了 post 模型,使用 $user->posts()->saveMany(...); 这种方式保存的新的 posts 记录,对应的 user_id 会为空。

这也不难理解,因为模型访问器是要参与模型相关处理的,访问器将 ID 由数字转为了字符串,自然会导致数据错乱。

正确姿势

冷静下来决定先认真思考再动手,查阅了官方文档,才发现 Resource 正是我想要的。Resource 只会影响返回给前端的数据,我们可以通过自定义 Resource 来实现 API 返回结果的结构、类型转换等功能。转换个 ID 自然也不在话下。

为了省事,我直接修改 AppHttpResource 这个基类。只需要重载它的 toArray() 方法,在其中使用递归,对可能超出 JS 安全数值范围的值进行转换就可以了。大家也可以根据自己的实际情况,新建 Resource 类,如 UserResource 来处理。

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class Resource extends JsonResource
{
  /**
   * Transform the resource into an array.
   *
   * @param \Illuminate\Http\Request $request
   *
   * @return array
   */
  public function toArray($request)
  {
    $parentReturn = parent::toArray($request);

    foreach (array_keys($parentReturn) as $key) {
      // 为方便演示这里把所有整型字段都转成字符串
      if (is_int($parentReturn[$key])) {
        $parentReturn[$key] = strval($parentReturn[$key]);
      }

      // 关联的字段,如 $user->post,相当于递归处理
      if (is_array($parentReturn[$key])) {
        $parentReturn[$key] = new Resource($parentReturn[$key]);
      }
    }

    return $parentReturn;
  }
}

然后,在接口控制器中返回 Resource 返回数据,整型字段值就会自动变为字符串了。

<?php

namespace App\Http\Controllers;

use App\Http\Resources\Resource;
use App\Models\User;
use Illuminate\Http\Request;

class TestController extends Controller
{
  /**
   * @return \App\Http\Resources\Resource
   */
  public function __invoke(Request $request)
  {
    $user = User::first();

    return new Resource($user);
  }
}

结果如下图:

Laravel 自动转换长整型雪花 ID 为字符串的实现

注意事项

因为这种办法使用了遍历,而且有递归处理,当数据结构复杂、数据量较大时可能会对性能造成一定影响。我这里算是比较偷懒取巧的写法,如果对性能有追求,自定义 Resource 类,然后根据特定的已知的字段名来进行转换会比较好
因为返回给前端的 ID 转为了字符串,前端在进行比较判断,特别是 === 判断时要特别注意

到此这篇关于Laravel 自动转换长整型雪花 ID 为字符串的实现的文章就介绍到这了,更多相关Laravel 长整型雪花ID转换为字符串内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

PHP 相关文章推荐
十天学会php之第五天
Oct 09 PHP
十天学会php之第七天
Oct 09 PHP
PHP网站安装程序制作的原理、步骤、注意事项和示例代码
Aug 01 PHP
PHP学习之输出字符串(echo,print,printf,print_r和var_dump)
Apr 17 PHP
php循环语句 for()与foreach()用法区别介绍
Sep 05 PHP
php生成二维码的几种方式整理及使用实例
Jun 03 PHP
根据中文裁减字符串函数的php代码
Dec 03 PHP
php中自定义函数dump查看数组信息类似var_dump
Jan 27 PHP
php上传文件常见问题总结
Feb 03 PHP
简单了解PHP编程中数组的指针的使用
Nov 30 PHP
Yii针对添加行的增删改查操作示例
Oct 18 PHP
Laravel5.4简单实现app接口Api Token认证方法
Aug 29 PHP
Laravel配合jwt使用的方法实例
Oct 25 #PHP
数据结构之利用PHP实现二分搜索树
Oct 25 #PHP
如何运行/调试你的PHP代码
Oct 23 #PHP
php redis setnx分布式锁简单原理解析
Oct 23 #PHP
PHP如何通过带尾指针的链表实现'队列'
Oct 22 #PHP
php使用event扩展的io复用测试的示例
Oct 20 #PHP
Aliyun Linux 编译安装 php7.3 tengine2.3.2 mysql8.0 redis5的过程详解
Oct 20 #PHP
You might like
山进SANGEAN ATS-909X电路分析
2021/03/02 无线电
Laravel框架实现定时发布任务的方法
2018/08/16 PHP
PHP数组对象与Json转换操作实例分析
2019/10/22 PHP
PHP数组访问常用方法解析
2020/09/05 PHP
用javascript实现在小方框中浏览大图的代码
2007/08/14 Javascript
Extjs Ext.MessageBox.confirm 确认对话框详解
2010/04/02 Javascript
JS求平均值的小例子
2013/11/29 Javascript
jquery原创弹出层折叠效果点击折叠弹出一个层
2014/03/12 Javascript
用js提交表单解决一个页面有多个提交按钮的问题
2014/09/01 Javascript
深入分析原生JavaScript事件
2014/12/29 Javascript
JS实现自动切换文字的导航效果代码
2015/08/27 Javascript
jQuery实现仿QQ空间装扮预览图片的鼠标提示效果代码
2015/10/30 Javascript
对象题目的一个坑 理解Javascript对象
2015/12/22 Javascript
使用jQuery制作浮动工具栏的实例分享
2016/05/13 Javascript
Bootstrap表单Form全面解析
2016/06/13 Javascript
Bootstrap的modal拖动效果
2016/12/25 Javascript
详解JavaScript RegExp对象
2017/02/04 Javascript
JavaScript 中使用 Generator的方法
2017/12/29 Javascript
JS/HTML5游戏常用算法之路径搜索算法 随机迷宫算法详解【普里姆算法】
2018/12/13 Javascript
node命令行工具之实现项目工程自动初始化的标准流程
2019/08/12 Javascript
layui加载表格,绑定新增,编辑删除,查看按钮事件的例子
2019/09/06 Javascript
python 生成不重复的随机数的代码
2011/05/15 Python
python解析文件示例
2014/01/23 Python
python网络编程学习笔记(二):socket建立网络客户端
2014/06/09 Python
Python 类与元类的深度挖掘 I【经验】
2016/05/06 Python
使用pygame模块编写贪吃蛇的实例讲解
2018/02/05 Python
Python实现购物车购物小程序
2018/04/18 Python
Python 实现「食行生鲜」签到领积分功能
2018/09/26 Python
Python日志logging模块功能与用法详解
2020/04/09 Python
Python实现将元组中的元素作为参数传入函数的操作
2020/06/05 Python
家庭教育先进个人事迹材料
2014/01/24 职场文书
2014村务公开实施方案
2014/02/25 职场文书
优秀乡村医生事迹材料
2014/05/28 职场文书
辞职信模板(中英文版)
2015/02/27 职场文书
辩论赛新闻稿
2015/07/17 职场文书
从结婚开始的恋爱故事。小说《我的美好婚事》TV动画化决定
2022/04/07 日漫