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下获取客户端ip地址的函数
Mar 15 PHP
晋城吧对DiscuzX进行的前端优化要点
Sep 05 PHP
input file获得文件根目录简单实现
Apr 26 PHP
PHP针对常规模板引擎中与CSS/JSON冲突的解决方法
Aug 19 PHP
php生成百度sitemap站点地图类函数实例
Oct 17 PHP
thinkPHP学习笔记之安装配置篇
Mar 05 PHP
PHP+Mysql+jQuery文件下载次数统计实例讲解
Oct 10 PHP
Yii数据模型中rules类验证器用法分析
Jul 15 PHP
YII中Ueditor富文本编辑器文件和图片上传的配置图文教程
Mar 15 PHP
PHP获取二叉树镜像的方法
Jan 17 PHP
Laravel5.1 框架Middleware中间件基本用法实例分析
Jan 04 PHP
PHP实现随机发扑克牌
Apr 22 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
ueditor 1.2.6 使用方法说明
2013/07/24 PHP
PHP编程基本语法快速入门手册
2016/01/07 PHP
php多文件打包下载的实例代码
2017/07/12 PHP
thinkPHP5框架auth权限控制类与用法示例
2018/06/12 PHP
PHP自定义错误处理的方法分析
2018/12/19 PHP
Add a Picture to a Microsoft Word Document
2007/06/15 Javascript
JQuery困惑—包装集 DOM节点
2009/10/16 Javascript
asp.net中System.Timers.Timer的使用方法
2013/03/20 Javascript
使用Math.floor与Math.random取随机整数的方法详解
2013/05/07 Javascript
利用JS延迟加载百度分享代码,提高网页速度
2013/07/01 Javascript
JavaScript中按位“异或”运算符使用介绍
2014/03/14 Javascript
Bootstrap框架结合jQuery仿百度换肤功能实例解析
2016/09/17 Javascript
简单实现Bootstrap标签页
2020/08/09 Javascript
微信小程序 高德地图SDK详解及简单实例(源码下载)
2017/01/11 Javascript
jQuery 实现倒计时天,时,分,秒功能
2018/07/31 jQuery
JavaScript高级函数应用之分时函数实例分析
2018/08/03 Javascript
AngularJS发送异步Get/Post请求方法
2018/08/13 Javascript
AngularJs返回前一页面时刷新一次前面页面的方法
2018/10/09 Javascript
一篇文章,教你学会Vue CLI 插件开发
2019/04/17 Javascript
vue cli安装使用less的教程详解
2019/07/12 Javascript
IE11下处理Promise及Vue的单项数据流问题
2019/07/24 Javascript
Vue.js如何使用Socket.IO的示例代码
2019/09/05 Javascript
jQuery 图片查看器插件 Viewer.js用法简单示例
2020/04/04 jQuery
浅谈Python类里的__init__方法函数,Python类的构造函数
2016/12/10 Python
利用Python在一个文件的头部插入数据的实例
2018/05/02 Python
Python3网络爬虫开发实战之极验滑动验证码的识别
2019/08/02 Python
Django中自定义模型管理器(Manager)及方法
2019/09/23 Python
使用python库xlsxwriter库来输出各种xlsx文件的示例
2020/09/01 Python
Selenium环境变量配置(火狐浏览器)及验证实现
2020/12/07 Python
美国在线购买和出售礼品卡网站:EJ Gift Cards
2019/06/09 全球购物
opencv实现图像平移效果
2021/03/24 Python
网络信息管理员岗位职责
2014/01/05 职场文书
宿舍保安职务说明书
2014/02/25 职场文书
研究生简历自我评价范文
2014/09/13 职场文书
2016年小学优秀班主任事迹材料
2016/02/29 职场文书
详解Laravel制作API接口
2021/05/31 PHP