Laravel自動(dòng)轉(zhuǎn)換長(zhǎng)整型雪花ID為字符串的示例

這篇文章給大家分享的是有關(guān)Laravel自動(dòng)轉(zhuǎn)換長(zhǎng)整型雪花ID為字符串的示例的內(nèi)容。小編覺(jué)得挺實(shí)用的，因此分享給大家做個(gè)參考，一起跟隨小編過(guò)來(lái)看看吧。

在設(shè)計(jì) API 時(shí)，出于安全性等因素考慮，有時(shí)需要放棄使用自增 ID，使 ID 非連續(xù)且不可猜測(cè)。通?？梢允褂?Hash id，UUID,雪花 ID 等來(lái)實(shí)現(xiàn)。

在最近的一個(gè)項(xiàng)目中，我嘗試使用雪花 ID。一通折騰下來(lái)發(fā)現(xiàn)，逼格挺高，實(shí)現(xiàn)也挺簡(jiǎn)單。然而當(dāng)我繼續(xù)擼起袖子與前端部分對(duì)接時(shí)，卻出現(xiàn)了 JS 精度丟失問(wèn)題，因?yàn)榇鎯?chǔ)的 ID 是一個(gè) unsigned bigint 型的值。（至于為什么會(huì)有精度丟失現(xiàn)象，這里就不具體解釋了，不清楚的可以自行搜索），本文主要介紹解決辦法。

想要解決這問(wèn)題，基本原理也很簡(jiǎn)單，就是把 ID 轉(zhuǎn)成字符串再返回給前端。

錯(cuò)誤嘗試

一開(kāi)始我想到的是使用 Laravel Eloquent 模型的模型訪(fǎng)問(wèn)器。只要給需要轉(zhuǎn)換的模型加一個(gè) getIdAttribute，將 ID 轉(zhuǎn)成字符串不就行了嘛？

如：App\Models\User 模型里這樣寫(xiě)：

/**

 * @return string

 */public function getIdAttribute(){

    return strval($this->attributes['id']);}

但事實(shí)并非如此，屬性訪(fǎng)問(wèn)器確實(shí)能讓 API 返回給前端的 ID 變?yōu)樽址?。但同時(shí)也會(huì)影響關(guān)聯(lián)模型插入、修改時(shí)的結(jié)果，例如，user 關(guān)聯(lián)的了 post 模型，使用 $user->posts()->saveMany(…); 這種方式保存的新的 posts 記錄，對(duì)應(yīng)的 user_id 會(huì)為空。

這也不難理解，因?yàn)槟Ｐ驮L(fǎng)問(wèn)器是要參與模型相關(guān)處理的，訪(fǎng)問(wèn)器將 ID 由數(shù)字轉(zhuǎn)為了字符串，自然會(huì)導(dǎo)致數(shù)據(jù)錯(cuò)亂。

正確姿勢(shì)

冷靜下來(lái)決定先認(rèn)真思考再動(dòng)手，查閱了官方文檔，才發(fā)現(xiàn) Resource 正是我想要的。Resource 只會(huì)影響返回給前端的數(shù)據(jù)，我們可以通過(guò)自定義 Resource 來(lái)實(shí)現(xiàn) API 返回結(jié)果的結(jié)構(gòu)、類(lèi)型轉(zhuǎn)換等功能。轉(zhuǎn)換個(gè) ID 自然也不在話(huà)下。

為了省事，我直接修改 App\Http\Resource 這個(gè)基類(lèi)。只需要重載它的 toArray() 方法，在其中使用遞歸，對(duì)可能超出 JS 安全數(shù)值范圍的值進(jìn)行轉(zhuǎn)換就可以了。大家也可以根據(jù)自己的實(shí)際情況，新建 Resource 類(lèi)，如 UserResource 來(lái)處理。

<?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) {
            // 為方便演示這里把所有整型字段都轉(zhuǎn)成字符串
            if (is_int($parentReturn[$key])) {
                $parentReturn[$key] = strval($parentReturn[$key]);
            }

            // 關(guān)聯(lián)的字段，如 $user->post，相當(dāng)于遞歸處理
            if (is_array($parentReturn[$key])) {
                $parentReturn[$key] = new Resource($parentReturn[$key]);
            }
        }

        return $parentReturn;
    }
}

然后，在接口控制器中返回 Resource 返回?cái)?shù)據(jù)，整型字段值就會(huì)自動(dòng)變?yōu)樽址恕?/p>

<?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);
    }
}

結(jié)果如下圖：

注意事項(xiàng)

• 因?yàn)檫@種辦法使用了遍歷，而且有遞歸處理，當(dāng)數(shù)據(jù)結(jié)構(gòu)復(fù)雜、數(shù)據(jù)量較大時(shí)可能會(huì)對(duì)性能造成一定影響。我這里算是比較偷懶取巧的寫(xiě)法，如果對(duì)性能有追求，自定義 Resource 類(lèi)，然后根據(jù)特定的已知的字段名來(lái)進(jìn)行轉(zhuǎn)換會(huì)比較好

• 因?yàn)榉祷亟o前端的 ID 轉(zhuǎn)為了字符串，前端在進(jìn)行比較判斷，特別是 === 判斷時(shí)要特別注意

感謝各位的閱讀！關(guān)于“Laravel自動(dòng)轉(zhuǎn)換長(zhǎng)整型雪花ID為字符串的示例”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，讓大家可以學(xué)到更多知識(shí)，如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到吧！