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

田勇發表於2020-10-27
Laravel字串

在設計 API 時，出於安全性等因素考慮，有時需要放棄使用自增 ID，使 ID 非連續且不可猜測。通常可以使用 Hash id，UUID,雪花 ID 等來實現。

在最近的一個專案中，我嘗試使用雪花 ID。一通折騰下來發現，逼格挺高，實現也挺簡單。然而當我繼續擼起袖子與前端部分對接時，卻出現了 JS 精度丟失問題，因為儲存的 ID 是一個 unsigned bigint 型的值。（至於為什麼會有精度丟失現象，這裡就不具體解釋了，不清楚的可以自行搜尋），本文主要介紹解決辦法。

想要解決這問題，基本原理也很簡單，就是把 ID 轉成字串再返回給前端。

錯誤嘗試

一開始我想到的是使用 Laravel Eloquent 模型的模型訪問器。只要給需要轉換的模型加一個 getIdAttribute，將 ID 轉成字串不就行了嘛？

如：App\Models\User 模型裡這樣寫：


/**

 * @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 自然也不在話下。

為了省事，我直接修改 App\Http\Resource 這個基類。只需要過載它的 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 轉為了字串，前端在進行比較判斷，特別是 === 判斷時要特別注意

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章