{"id":283,"date":"2021-06-21T10:24:00","date_gmt":"2021-06-21T10:24:00","guid":{"rendered":"https:\/\/www.escueladefrikis.com\/?p=283"},"modified":"2021-06-21T10:24:00","modified_gmt":"2021-06-21T10:24:00","slug":"dto-en-laravel-8","status":"publish","type":"post","link":"https:\/\/escueladefrikis.com\/index.php\/2021\/06\/21\/dto-en-laravel-8\/","title":{"rendered":"Modelos DTO en Laravel 8"},"content":{"rendered":"\n

Los DTO o Data Transfer Object son los tipos de objetos utilizados para modelar la comunicaci\u00f3n entre sistemas, lo que en una API REST significa que son los modelos de las peticiones (requests) y respuestas (responses). En la implementaci\u00f3n de la API en Laravel, los controladores reciben un objeto gen\u00e9rico Request:<\/p>\n\n\n\n

    \/**\n     * Store a newly created resource in storage.\n     *\n     * @param  \\Illuminate\\Http\\Request  $request\n     * @return \\Illuminate\\Http\\Response\n     *\/\n    public function store(Request $request)\n    {\n        \/\/ your code here! \n    }<\/code><\/pre>\n\n\n\n
Lo que implica que toda la validaci\u00f3n del modelo de datos se debe implementar en el controlador. Buscando referencias y librer\u00edas, encontr\u00e9 esta librer\u00eda para Data Transfer Objects (DTOs): https:\/\/github.com\/spatie\/data-transfer-object<\/a> y vamos a ver c\u00f3mo aplicarla para modelar la petici\u00f3n o request.<\/p>\n
<\/p>\n\n\n\n
Soluci\u00f3n cl\u00e1sica: Request gen\u00e9rica<\/h3>\n\n\n\n
Vamos a ver un poco m\u00e1s en detalle la soluci\u00f3n cl\u00e1sica. Como indicaba al comienzo del art\u00edculo, el controlador recibe una Request gen\u00e9rica y por tanto es parte de la implementaci\u00f3n validar el DTO recibido. Por ejemplo, vamos a tener un modelo llamado \u00abBook\u00bb<\/p>\n\n\n\n
class Book extends Model\n{\n    use HasFactory;\n\n    \/**\n     * The attributes that are mass assignable.\n     *\n     * @var array\n     *\/\n    protected $fillable = [\n        'name',\n        'author',\n    ];\n}<\/code><\/pre>\n\n\n\n
Ahora vamos a implementar un endpoint que reciba un nuevo libro. En la implementaci\u00f3n en el controlador, validaremos la petici\u00f3n y se mostrar\u00e1, o bien los errores de la validaci\u00f3n en caso de que el modelo de la petici\u00f3n no sea correcto, o bien los datos recibidos:<\/p>\n\n\n\n
    \/**\n     * Store a newly created resource in storage.\n     *\n     * @param  \\Illuminate\\Http\\Request  $request\n     * @return \\Illuminate\\Http\\Response\n     *\/\n    public function store(Request $request)\n    {\n        $validator = Validator::make($request->all(), [\n            'name' =>  'required',\n            'author' => 'required',\n        ]);\n \n        if($validator->fails()){\n            return response()->json($validator->errors(), 400); \n        }\n\n        $data=[\n            'name' => $request['name'],\n            'author' => $request['author']\n        ];\n\n        return response()->json($data, 200); \n\n    }<\/code><\/pre>\n\n\n\n
Es un endpoint muy simple, pero la mitad del c\u00f3digo es para validar la petici\u00f3n, es decir, para validar un DTO.<\/p>\n
Vamos a ver ahora una soluci\u00f3n m\u00e1s optimizada utilizando la librer\u00eda https:\/\/github.com\/spatie\/data-transfer-object<\/a>.<\/p>\n\n\n\n
Implementar una DTO de petici\u00f3n (request) en Laravel<\/h3>\n\n\n\n
Utilizando la librer\u00eda de DTO (https:\/\/github.com\/spatie\/data-transfer-object<\/a>), vamos a definir una clase que gestione la petici\u00f3n (request) y adem\u00e1s se encargue de validar el modelo:<\/p>\n\n\n\n
<?php\n\nnamespace App\\Models\\Requests;\n\nuse Spatie\\DataTransferObject\\DataTransferObject;\nuse Illuminate\\Http\\Request;\nuse Validator;\n\nclass BookStoreRequest extends DataTransferObject\n{\n\n    public string $name;\n\n    public string $author;\n\n\n    public static function fromRequest(Request $request): self\n    {\n        return BookStoreRequest::fromArray($request->all());\n    }\n\n    public static function fromArray($request): self\n    {\n\n        $validator = Validator::make($request, [\n            'name' =>  'required',\n            'author' =>  'required',\n        ]);\n \n        if($validator->fails()){\n            return response()->json($validator->errors(), 400); \n        }\n\n        return new self([\n            'name' => $request['name'],\n            'author' => $request['author'],\n        ]);\n    }\n\n}<\/code><\/pre>\n\n\n\n
La clase que modela el DTO de la request dispone de dos m\u00e9todos est\u00e1ticos que devuelven un objeto de la clase, una parte de la Request gen\u00e9rica de Laravel (\u00abfromRequest\u00bb) y una segunda que tiene como entrada un array (\u00abfromArray\u00bb).<\/p>\n
Ahora podemos modificar el controller, que quedar\u00eda:<\/p>\n\n\n\n
use App\\Models\\Requests\\BookStoreRequest;\n\n    \/**\n     * Store a newly created resource in storage.\n     *\n     * @param  \\Illuminate\\Http\\Request  $request\n     * @return \\Illuminate\\Http\\Response\n     *\/\n    public function store(Request $request)\n    {\n        $bookStoreRequest = BookStoreRequest::fromRequest($request);\n\n        $data=[\n            'name' => $request['name'],\n            'author' => $request['author']\n        ];\n\n        return response()->json($data, 200); \n\n    }<\/code><\/pre>\n\n\n\n
De esta manera, la clase BookStoreRequest se encarga de modelar y validar el DTO de la petici\u00f3n, dejando \u00fanicamente en el controlador la implementaci\u00f3n de la l\u00f3gica de negocio. En mi opini\u00f3n, una aproximaci\u00f3n mucho m\u00e1s adecuada.<\/p>\n
Pero a\u00fan podemos mejorarlo un poco m\u00e1s \ud83d\ude42<\/p>\n\n\n\n
Inyecci\u00f3n del DTO como Request<\/h3>\n\n\n\n
Ahora vamos a sustituir el tipo de objeto recibido por el controlador, cambiando la Request gen\u00e9rica:<\/p>\n\n\n\n
    public function store(Request $request)\n    {\n        \/\/ your code here!\n    }<\/code><\/pre>\n\n\n\n
y sustituirla por el DTO que hemos implementado:<\/p>\n\n\n\n
    public function store(BookStoreRequest $request)\n    {\n        \/\/ your code here!\n    }<\/code><\/pre>\n\n\n\n
En este caso, cuando Laravel intenta inyectar \u00abBookStoreRequest \u00ab, intenta crear la instancia del objeto a partir de la \u00abRequest\u00bb. Por tanto, para ello tenemos que a\u00f1adir un constructor a la clase \u00abBookStoreRequest\u00bb que tenga como argumento de entrada la \u00abRequest\u00bb e incluya la \u00b4l\u00f3gica de validaci\u00f3n:<\/p>\n\n\n\n
<?php\n\nnamespace App\\Models\\Requests;\n\nuse Spatie\\DataTransferObject\\DataTransferObject;\nuse Illuminate\\Http\\Request;\nuse Validator;\n\nclass BookStoreRequest extends DataTransferObject\n{\n\n    public string $name;\n\n    public string $author;\n\n\n    public function __construct(Request $request)\n    {\n        $validator = Validator::make($request, [\n            'name' =>  'required',\n            'author' =>  'required',\n        ]);\n \n        if($validator->fails()){\n            return response()->json($validator->errors(), 400); \n        }\n\n        \/\/ everything OK, we set the attributes\n        $this->name = $request['name'];\n        $this->author = $request['author];\n    }\n\n}<\/code><\/pre>\n\n\n\n
Por tanto, ya podemos hacer:<\/p>\n\n\n\n
use App\\Models\\Requests\\BookStoreRequest;\n\n   \/**\n     * Store a newly created resource in storage.\n     *\n     * @param  App\\Models\\Requests\\BookStoreRequest  $request\n     * @return \\Illuminate\\Http\\Response\n     *\/\n    public function store(BookStoreRequest $request)\n    {\n\n        $data=[\n            'name' => $request->name,\n            'author' => $request->author\n        ];\n\n        return response()->json($data, 200); \n\n    }<\/code><\/pre>\n\n\n\n
E incre\u00edblemente, esto… funciona<\/strong>!<\/p>\n\n\n\n
<\/span>\"\"
\n
DTO Request en Laravel 8<\/p>\n\n\n<\/div><\/div>\n\n\n\n
Como puedes ver, el c\u00f3digo del controlador queda muy limpio y \u00fanicamente tiene l\u00f3gica de negocio.<\/p>\n
Aun as\u00ed, la soluci\u00f3n todav\u00eda no est\u00e1 completa, ya que si bien es cierto que valida la entrada, en caso que la petici\u00f3n no sea correcta obtenemos el siguiente error:<\/p>\n\n\n\n
<\/span>\"\"
\n
DTO Request excepci\u00f3n<\/p>\n<\/div><\/div>\n\n\n\n
Este error nos indica que est\u00e1 esperando un objeto de tipo \u00abBookStoreRequest\u00bb y le estamos devolviendo un \u00abJsonResponse\u00bb, que es la salida del validador:<\/p>\n\n\n\n
class BookStoreRequest extends DataTransferObject\n{\n\n...\n    public function __construct(Request $request)\n    {\n\n.. \n        if($validator->fails()){\n            return response()->json($validator->errors(), 400);<\/span> \n        }\n\n...\n    }\n\n}<\/code><\/pre>\n\n\n\n
En este punto, lo realmente interesante ser\u00eda que no llegara a ejecutarse nada en el controlador sino que simplemente se devolviera una excepci\u00f3n, y para ello necesitamos a\u00f1adir una nueva funcionalidad a la API: la gesti\u00f3n de excepciones o Exception Handling en Laravel 8<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7,5],"tags":[22,25],"class_list":["post-283","post","type-post","status-publish","format-standard","hentry","category-laravel-8","category-programacion","tag-laravel","tag-php"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/posts\/283","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/comments?post=283"}],"version-history":[{"count":0,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/posts\/283\/revisions"}],"wp:attachment":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/media?parent=283"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/categories?post=283"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/tags?post=283"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}