Eloquent：序列化
簡介
使用 Laravel 建立 API 時，經常需要將模型與關聯轉換為陣列或 JSON。Eloquent 包含方便的方法來進行這些轉換，並能控制哪些屬性應包含在序列化後的模型中。
[!NOTE] 若要以更強大的方式處理 Eloquent 模型與集合的 JSON 序列化，請參考 Eloquent API 資源 的文件。
序列化模型與集合
序列化為陣列
要將模型及其已載入的 關聯 轉換為陣列，應使用 toArray 方法。此方法是遞迴的，因此所有屬性與所有關聯（包括關聯的關聯）都會被轉換為陣列：
use App\Models\User;
$user = User::with('roles')->first();
return $user->toArray();attributesToArray 方法可用於將模型的屬性轉換為陣列，但不包含其關聯：
$user = User::first();
return $user->attributesToArray();你也可以透過在集合實例上呼叫 toArray 方法，將整個模型的 集合 轉換為陣列：
$users = User::all();
return $users->toArray();序列化為 JSON
要將模型轉換為 JSON，應使用 toJson 方法。與 toArray 一樣，toJson 方法也是遞迴的，因此所有屬性與關聯都會被轉換為 JSON。你也可以指定任何 PHP 支援 的 JSON 編碼選項：
use App\Models\User;
$user = User::find(1);
return $user->toJson();
return $user->toJson(JSON_PRETTY_PRINT);或者，你可以將模型或集合轉型為字串，這會自動在模型或集合上呼叫 toJson 方法：
return (string) User::find(1);由於模型與集合在轉型為字串時會被轉換為 JSON，因此你可以直接從應用程式的路由或控制器回傳 Eloquent 物件。當路由或控制器回傳 Eloquent 模型或集合時，Laravel 會自動將其序列化為 JSON：
Route::get('/users', function () {
return User::all();
});關聯
當 Eloquent 模型被轉換為 JSON 時，其已載入的關聯會自動作為 JSON 物件的屬性包含在內。此外，雖然 Eloquent 關聯方法是使用「駝峰式 (camel case)」命名，但關聯的 JSON 屬性將會是「蛇底式 (snake case)」。
在 JSON 中隱藏屬性
有時你可能希望限制包含在模型陣列或 JSON 表示中的屬性，例如密碼。為此，你可以在模型上使用 Hidden 屬性 (Attribute)。列在 Hidden 屬性中的屬性將不會包含在序列化後的模型中：
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Attributes\Hidden;
use Illuminate\Database\Eloquent\Model;
#[Hidden(['password'])]
class User extends Model
{
// ...
}[!NOTE] 要隱藏關聯，請將關聯的方法名稱加入到 Eloquent 模型的
Hidden屬性中。
或者，你可以使用 Visible 屬性來定義應包含在模型陣列與 JSON 表示中的「白名單」。所有未出現在 Visible 屬性中的屬性在模型轉換為陣列或 JSON 時都會被隱藏：
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Attributes\Visible;
use Illuminate\Database\Eloquent\Model;
#[Visible(['first_name', 'last_name'])]
class User extends Model
{
// ...
}暫時修改屬性可見性
如果你想在特定的模型實例上讓某些通常隱藏的屬性變得可見，可以使用 makeVisible 或 mergeVisible 方法。makeVisible 方法會回傳該模型實例：
return $user->makeVisible('attribute')->toArray();
return $user->mergeVisible(['name', 'email'])->toArray();同樣地，如果你想隱藏某些通常可見的屬性，可以使用 makeHidden 或 mergeHidden 方法：
return $user->makeHidden('attribute')->toArray();
return $user->mergeHidden(['name', 'email'])->toArray();如果你希望暫時覆蓋所有的可見或隱藏屬性，可以分別使用 setVisible 與 setHidden 方法：
return $user->setVisible(['id', 'name'])->toArray();
return $user->setHidden(['email', 'password', 'remember_token'])->toArray();在 JSON 中追加數值
偶爾在將模型轉換為陣列或 JSON 時，你可能希望加入在資料庫中沒有對應欄位的屬性。為此，請先為該數值定義一個 存取器 (Accessor)：
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* 判斷使用者是否為管理員。
*/
protected function isAdmin(): Attribute
{
return new Attribute(
get: fn () => 'yes',
);
}
}如果你希望該存取器總是追加到模型的陣列與 JSON 表示中，可以在模型上使用 Appends 屬性。請注意，屬性名稱通常使用其序列化後的「蛇底式 (snake case)」來引用，即使存取器的 PHP 方法是使用「駝峰式 (camel case)」定義的：
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Attributes\Appends;
use Illuminate\Database\Eloquent\Model;
#[Appends(['is_admin'])]
class User extends Model
{
// ...
}一旦屬性被加入到 appends 清單中，它就會同時包含在模型的陣列與 JSON 表示中。appends 陣列中的屬性也會遵循模型上設定的 visible 與 hidden 設定。
執行時追加
在執行時，你可以使用 append 或 mergeAppends 方法指示模型實例追加額外的屬性。或者，你可以使用 setAppends 方法來覆蓋特定模型實例的整個追加屬性陣列：
return $user->append('is_admin')->toArray();
return $user->mergeAppends(['is_admin', 'status'])->toArray();
return $user->setAppends(['is_admin'])->toArray();同樣地，如果你想從模型中移除所有追加的屬性，可以使用 withoutAppends 方法：
return $user->withoutAppends()->toArray();日期序列化
自訂預設日期格式
你可以透過覆蓋 serializeDate 方法來自訂預設的序列化格式。此方法不會影響日期在資料庫中儲存的格式：
/**
* 為陣列 / JSON 序列化準備日期格式。
*/
protected function serializeDate(DateTimeInterface $date): string
{
return $date->format('Y-m-d');
}自訂個別屬性的日期格式
你可以在模型的 轉型宣告 (Cast Declarations) 中指定日期格式，藉此自訂個別 Eloquent 日期屬性的序列化格式：
protected function casts(): array
{
return [
'birthday' => 'date:Y-m-d',
'joined_at' => 'datetime:Y-m-d H:00',
];
}