DTO oder Datenobjekt erstellen
Wann verwenden
Verwende diesen Skill, wenn Daten eine Grenze überschreiten oder von Web, API, Livewire, Jobs, Commands oder Integrationen wiederverwendet werden müssen.
Benötigte Eingaben
- Felder, Typen, Validierungsregeln, Quellgrenzen, Ausgabekonsumenten, Standardwerte und Serialisierungsanforderungen.
Arbeitsablauf
- Untersuche bestehende Datenobjekt-Konventionen.
- Verwende standardmäßig Spatie Laravel Data, da es jetzt installiert ist. Falls in einem nahegelegenen Modul bereits ein anderer Datenstil existiert, folge der lokalen Konvention.
- Bevorzuge
final readonly classmit Constructor Property Promotion für unveränderliche DTOs. - Verwende Spatie-Data-Attribute, wo sie zur Eigenschaft passen:
#[MapInputName]#[MapOutputName]#[WithCast]#[WithTransformer]#[Computed]#[ValidationAttribute]oder Paket-Validierungsattribute#[DataCollectionOf]#[Lazy]#[Hidden]#[LoadRelation]und#[LoadMissing]#[Inject]oder Property-Injection-Attribute, wenn das Paket oder die Projektkonvention sie verwendet
- Verwende Enums für geschlossene Mengen und typisierte Klassenkonstanten für wiederverwendbare skalare Verträge.
- Halte DTOs client-unabhängig.
- Füge benannte Konstruktoren wie
fromArray,fromRequestoderfromModelnur hinzu, wenn sie nützlich sind. - Platziere Validierungsregeln in der Nähe von DTOs, wenn die Projektkonvention dies unterstützt.
- Vermeide Persistenz-, Autorisierungs- oder Workflow-Logik.
- Füge Tests für Konstruktion, Validierungsregeln, Serialisierung und Randfälle hinzu.
Dateien, die erstellt werden können
app/Data/*.php,app/DTOs/*.phpoder das vorhandene lokale Äquivalent.- DTO-Tests.
Dateien, die geändert werden können
- Form Requests, Actions, Resources, Livewire-Komponenten, Controller, Jobs und Tests.
Architekturregeln
- DTOs repräsentieren Eingabe- oder Ausgabeverträge.
- DTOs unterstützen die Wiederverwendung in API und UI.
- DTOs dürfen nicht von Livewire, Blade, Controllern oder Responses abhängen.
- DTOs sollten wann immer möglich moderne PHP-Typisierung anstelle von unstrukturierten Arrays verwenden.
- Verwende Spatie Data Collections/Resources, wenn ein Feature verschachtelte, transformierte oder wiederverwendbare Datenstrukturen benötigt.
- Bevorzuge Spatie Data-Validierungsattribute vor ad hoc Array-Validierung in wiederverwendbarem Code.
Testanforderungen
- Teste erforderliche Felder, Typkonvertierung, Standardwerte, ungültige Daten und Serialisierung, falls diese offengelegt wird.
Sicherheitsanforderungen
- Vertraue der DTO-Konstruktion nicht als Autorisierung.
- Vermeide sensible Felder in Ausgabe-DTOs, es sei denn, sie sind ausdrücklich beabsichtigt.
Überprüfungs-Checkliste
- Ist das DTO stabil und client-unabhängig?
- Sind die Felder typisiert?
- Sind die Validierungsregeln nah genug, um synchron zu bleiben?
Beispiele
Gutes Beispiel
namespace App\Data;
use Spatie\LaravelData\Data;
use Spatie\LaravelData\Attributes\Validation\Email;
use Spatie\LaravelData\Attributes\Validation\Required;
use Spatie\LaravelData\Attributes\Validation\Max;
final readonly class RegisterUserData extends Data
{
public function __construct(
#[Required, Max(255)]
public string $name,
#[Required, Email]
public string $email,
) {}
}
Schlechtes Beispiel
// ❌ Schlechte Typsicherheit, kein Validierungskontext, schwer in Hintergrund-Jobs wiederverwendbar.
class RegisterController extends Controller
{
public function store(Request $request)
{
$this->action->handle($request->all());
}
}