如何在Laravel中使用數據傳輸對象（DTO）？

Laravel中的DTO用於組織，驗證和傳輸應用程序層之間的數據，從而提高可預測性和可檢驗性。 2。通過作曲家安裝推薦的Spatie/laravel-data軟件包，以進行魯棒的DTO功能。 3。使用工匠命令製造：數據，用類型提示和可選嵌套定義數據結構。 4。通過手動實例化在控制器中使用驗證的請求數據或通過實現從request實現自動綁定的DTO。 5。使用fercast和mapName之類的屬性應用鑄造和命名映射以轉換和標準化數據。 6. DTO可以輕鬆地轉換為API響應的數組或JSON，從而增強前端兼容性。 7。可選地將DTO與API資源集成，或直接使用FromModel從雄辯的模型中繪製它們，從而確保整個應用程序上的一致數據格式。始終保持DTO，不使用業務邏輯，使用清晰的命名約定，並利用類型的安全性來維持清潔，可擴展的代碼。

使用Laravel中的數據傳輸對象（DTO）可以幫助您在應用程序的不同層之間組織，驗證和傳輸數據，例如從請求到服務或從服務到前端。雖然Laravel不包括DTO，但您通常可以在Spatie/Data-Transfer-Object或LiveWire-UI/Slim-DTO的第三方軟件包借助下，使用PHP類有效地實現它們。

這是有效地使用Laravel中DTO的方法：

✅1。什麼是DTO，為什麼使用它？

數據傳輸對象（DTO）是用於攜帶數據的簡單PHP對象。當：

• 您想在服務之間傳遞結構化數據。
• 您需要從HTTP請求中標準化輸入。
• 您正在使用API，並且需要一致的數據格式。
• 您想執行類型的安全性和驗證。

DTO並沒有傳遞原始數組或請求對象，而是使您的代碼更容易預測和更易於測試。

✅2。安裝DTO軟件包（推薦：Spatie/Laravel-Data）

雖然您可以創建普通的PHP類作為DTOS，但使用Spatie/Laravel-Data （ spatie/data-transfer-object的現代繼任者）是Laravel中最強大的方法。

通過作曲家安裝它：

作曲家需要Spatie/Laravel-Data

發布配置（可選）：

 PHP工匠供應商：發布-provider =“ Spatie \ Laraveldata \ LaraveldataServiceProvider”

✅3。創建DTO

假設您正在處理用戶創建。運行工匠命令：

 PHP工匠製造：數據用戶

這創建了類似的課程：

 // app/dtos/userdto.php
名稱空間應用\ dtos;

使用spatie \ laraveldata \ data;

班級用戶擴展數據
{
    公共功能__Construct（
        公共字符串$名稱，
        公共字符串$電子郵件，
        public？ string $ phone = null，
    ）{}
}

您還可以使用數組語法或嵌套數據：

公共功能__Construct（
    公共字符串$名稱，
    公共字符串$電子郵件，
    公共地址$地址，
    公共陣列$角色，
）

✅4。在請求或控制器中使用DTO

選項A：從表格請求中

//在您的控制器中
使用app \ dtos \ userdto;
使用照明\ http \ request;

公共功能商店（請求$請求）
{
    $ dto = userdto :: from（$ request-> varicated（））;

    //通過服務
    uservice :: create（$ dto）;

    返迴響應（） - > json（['message'=>'用戶創建']）;
}

或者更好，請與FromRequest使用自動綁定：

 //在控制器方法中
公共功能商店（userdto $ dto）
{
    uservice :: create（$ dto）;

    返迴響應（） - > json（$ dto）;
}

⚠️僅在您在DTO上實現Spatie\LaravelData\FromRequest或使用正確的表單請求映射時才能起作用。

選項B：使用表格請求DTO

 // app/http/requests/storeuserrequest.php
公共功能規則（）
{
    返回 [
        'name'=>'必需|字符串| max：255'，
        '電子郵件'=>'必需|電子郵件'，
        'phone'=>'無效|字符串'，
    ];
}

//在控制器中
公共功能商店（StoreUserRequest $請求）
{
    $ dto = userdto :: from（$ request-> varicated（））;

    //處理邏輯
}

✅5。添加鑄件和自定義映射

使用數據變壓器和腳輪格式輸入：

使用spatie \ laraveldata \ attributes \ mapname;
使用spatie \ laraveldata \屬性\ withcast;
使用spatie \ laraveldata \ casts \ dateTimeInterfaceCast;

班級用戶擴展數據
{
    公共功能__Construct（
        公共字符串$名稱，
        公共字符串$電子郵件，
        ＃[withcast（dateTimeInterfaceCast :: class，格式：'ym-d'）]
        public？ \ dateTime Interface $ dob = null，
        ＃[mapname（'phone_number'）]
        public？ string $ phone = null，
    ）{}
}

現在，它將phone_number從json映射到phone ，並格式化日期。

✅6。將DTO轉換為數組/JSON

DTO很容易序列化：

 $ dto = userdto ::來自[[[
    'name'=>'John Doe'，
    '電子郵件'=>'john@example.com'
）;

返回$ dto-> toarray（）;
//或自動響應：
返迴響應（） - > json（$ dto）;

✅7。在API資源中使用DTO（可選）

您可以使用DTO與API資源一起使用：

返回新的jsonresponse（userdto :: from（$ user））;

或將雄辯的模型映射到DTO：

 userdto ::來自[[
    'name'=> $ user->名稱，
    '電子郵件'=> $ user->電子郵件，
）;

您甚至可以使用Spatie\LaravelData\FromModel從模型中自動映射DTO。

✅摘要：最佳實踐

• ✅使用spatie/laravel-data進行功能強大，乾淨的DTO。
• ✅名稱dtos： UserDTO ， CreateUserDTO ， UserProfileDTO 。
• ✅在控制器，服務和API中使用它們來標準化數據流。
• ✅利用類型提示，默認值和鑄件。
• ✅避免將業務邏輯放入DTO中 - 它們應該是數據容器。

使用DTO可以使您的Laravel應用程序保持清潔，類型安全且易於維護，尤其是隨著它的增長。一旦您開始將它們用於表單，API和服務層，您就會想知道沒有它們的生活。

基本上，這是一個很小的設置，可以在代碼質量方面取得重大勝利。

以上是如何在Laravel中使用數據傳輸對象（DTO）？的詳細內容。更多資訊請關注PHP中文網其他相關文章！