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 04 PHP
PHP syntax error, unexpected $end 错误的一种原因及解决
Oct 25 PHP
php下获取客户端ip地址的函数
Mar 15 PHP
PHP stristr() 函数(不区分大小写的字符串查找)
Jun 03 PHP
PHP 遍历文件实现代码
May 04 PHP
php简单对象与数组的转换函数代码(php多层数组和对象的转换)
May 18 PHP
curl实现站外采集的方法和技巧
Jan 31 PHP
php 表单提交大量数据发生丢失的解决方法
Mar 03 PHP
PHP获取指定时间段之间的 年,月,天,时,分,秒
Jun 05 PHP
PHP实现RTX发送消息提醒的实例代码
Jan 03 PHP
php及codeigniter使用session-cookie的方法(详解)
Apr 06 PHP
php菜单/评论数据递归分级算法的实现方法
Aug 01 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中怎么搜索相关联数组键值及获取之
2013/10/17 PHP
PHP实现的多彩标签效果代码分享
2014/08/21 PHP
php中preg_match的isU代表什么意思
2015/10/01 PHP
php 截取中英文混合字符串的方法
2018/05/31 PHP
跟我一起学写jQuery插件开发方法(附完整实例及下载)
2010/04/01 Javascript
javascript语言结构小记(一)
2011/09/10 Javascript
jquery实现的导航固定效果
2014/04/28 Javascript
js中将String转换为number以便比较
2014/07/08 Javascript
javascript学习笔记(一)基础知识
2014/09/30 Javascript
javascript验证邮件地址和MX记录的方法
2015/06/16 Javascript
javascript实现控制的多级下拉菜单
2015/07/05 Javascript
基于JavaScript代码实现随机漂浮图片广告
2016/01/05 Javascript
理解Javascript图片预加载
2016/02/23 Javascript
Javascript农历与公历相互转换的简单实例
2016/10/09 Javascript
vue-resource 拦截器使用详解
2017/02/21 Javascript
微信小程序 动态绑定事件并实现事件修改样式
2017/04/13 Javascript
vue:el-input输入时限制输入的类型操作
2020/08/05 Javascript
[01:56]无止竞 再出发——中国军团出征2017年DOTA2国际邀请赛
2017/07/05 DOTA
Python基于scrapy采集数据时使用代理服务器的方法
2015/04/16 Python
Python实现多条件筛选目标数据功能【测试可用】
2018/06/13 Python
python Flask 装饰器顺序问题解决
2018/08/08 Python
Python中最大递归深度值的探讨
2019/03/05 Python
Python批量删除只保留最近几天table的代码实例
2019/04/01 Python
python实现一个函数版的名片管理系统过程解析
2019/08/27 Python
window环境pip切换国内源(pip安装异常缓慢的问题)
2019/12/31 Python
Python中socket网络通信是干嘛的
2020/05/27 Python
Django路由层URLconf作用及原理解析
2020/09/24 Python
接口自动化多层嵌套json数据处理代码实例
2020/11/20 Python
澳大利亚最超值的自行车之家:Reid Cycles
2019/03/24 全球购物
Made in Design英国:设计家具、照明、家庭装饰和花园家具
2019/09/24 全球购物
weblogic面试题
2016/03/07 面试题
英语专业毕业生求职信
2014/05/24 职场文书
2015年世界粮食日演讲稿
2015/03/20 职场文书
学雷锋献爱心活动总结
2015/05/11 职场文书
运动会致辞稿
2015/07/29 职场文书
Java反应式框架Reactor中的Mono和Flux
2021/07/25 Java/Android