教你Laravel自動轉換長整型雪花ID為字符串

? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

下面由Laravel教程欄目給大家介紹Laravel自動轉換長整型雪花ID為字符串的方法,希望對需要的朋友有所幫助!

在設計 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 AppHttpResources;  use IlluminateHttpResourcesJsonJsonResource;  class Resource extends JsonResource {     /**      * Transform the resource into an array.      *      * @param IlluminateHttpRequest $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 AppHttpControllers;  use AppHttpResourcesResource;  use AppModelsUser;  use IlluminateHttpRequest;  class TestController extends Controller {     /**      * @return AppHttpResourcesResource      */     public function __invoke(Request $request)     {         $user = User::first();         return new Resource($user);     } }

結果如下圖:
教你Laravel自動轉換長整型雪花ID為字符串

注意事項

  • 因為這種辦法使用了遍歷,而且有遞歸處理,當數據結構復雜、數據量較大時可能會對性能造成一定影響。我這里算是比較偷懶取巧的寫法,如果對性能有追求,自定義 Resource 類,然后根據特定的已知的字段名來進行轉換會比較好

  • 因為返回給前端的 ID 轉為了字符串,前端在進行比較判斷,特別是 === 判斷時要特別注意

? 版權聲明
THE END
喜歡就支持一下吧
點贊14 分享