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编程风格规范分享
Jan 15 PHP
浅析PHP中strlen和mb_strlen的区别
Aug 31 PHP
php使用标签替换的方式生成静态页面
May 21 PHP
PHP中的数组处理函数实例总结
Jan 09 PHP
Symfony生成二维码的方法
Feb 04 PHP
PHP使用curl模拟post上传及接收文件的方法
Mar 04 PHP
php版微信支付api.mch.weixin.qq.com域名解析慢原因与解决方法
Oct 12 PHP
PHP编程实现的TCP服务端和客户端功能示例
Apr 13 PHP
php无限级评论嵌套实现代码
Apr 18 PHP
php app支付宝回调(异步通知)详解
Jul 25 PHP
YII框架常用技巧总结
Apr 27 PHP
Laravel 实现Eloquent模型分组查询并返回每个分组的数量 groupBy()
Oct 23 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
PHP连接SQLServer2005 的问题解决方法
2010/07/19 PHP
ini_set的用法介绍
2014/01/07 PHP
Ubuntu server 11.04安装memcache及php使用memcache来存储session的方法
2016/05/31 PHP
PHP实现限制IP访问及提交次数的方法详解
2017/07/17 PHP
PHP实现提取多维数组指定一列的方法总结
2019/12/04 PHP
用函数式编程技术编写优美的 JavaScript_ibm
2008/05/16 Javascript
JS 表单验证大全
2011/11/23 Javascript
angularjs的一些优化小技巧
2014/12/06 Javascript
JS实现黑色风格的网页TAB选项卡效果代码
2015/10/09 Javascript
jQuery实现三级菜单的代码
2016/05/09 Javascript
jQuery对象的链式操作用法分析
2016/05/10 Javascript
JavaScript必知必会(三) String .的方法来自何方
2016/06/08 Javascript
AngularJS  $modal弹出框实例代码
2016/08/24 Javascript
微信小程序页面开发注意事项整理
2017/05/18 Javascript
解决vue+element 键盘回车事件导致页面刷新的问题
2018/08/25 Javascript
代码整洁之道(重构)
2018/10/25 Javascript
js回文数的4种判断方法示例
2019/06/04 Javascript
layui监听下拉选框选中值变化的方法(包含监听普通下拉选框)
2019/09/24 Javascript
Vue触发input选取文件点击事件操作
2020/08/07 Javascript
[54:28]EG vs OG 2019国际邀请赛小组赛 BO2 第一场 8.16
2019/08/18 DOTA
Python图像灰度变换及图像数组操作
2016/01/27 Python
python操作文件的参数整理
2019/06/11 Python
python实现按行分割文件
2019/07/22 Python
pyenv与virtualenv安装实现python多版本多项目管理
2019/08/17 Python
Python 导入文件过程图解
2019/10/15 Python
opencv python 图片读取与显示图片窗口未响应问题的解决
2020/04/24 Python
东南亚排名第一的服务市场:kaodim
2019/03/28 全球购物
北京-环亚运商测试题.net程序员初步测试题
2013/05/28 面试题
经典的班主任推荐信
2013/10/28 职场文书
药学职务聘任书
2014/03/29 职场文书
《卖木雕的少年》教学反思
2014/04/11 职场文书
2014县委书记四风对照检查材料思想汇报
2014/09/21 职场文书
2015年大学迎新晚会总结
2015/07/16 职场文书
在HTML5 localStorage中存储对象的示例代码
2021/04/21 Javascript
Vue实现tab导航栏并支持左右滑动功能
2021/06/28 Vue.js
win11无法登录onedrive错误代码0x8004def7怎么办 ?
2022/04/05 数码科技