Anotaciones para rutas en Symfony

Introducción

Acabamos de ver cómo instalar symfony 4 y también cómo se usa el archivo de configuración YAML para las rutas de Symfony.

Este framework PHP ofrece otra manera de enrutar o configurar las rutas, una de ella es a través de las anotaciones.

Por cierto, por favor lee primero el post que indico al inicio, pues aquí explicaré suponiendo que ya lo leíste.

¿Qué son las anotaciones?

Específicamente en este framework y en este lenguaje, las anotaciones son comentarios en donde anotamos cosas. Es decir, son unos comentarios especiales o con un formato específico.

Usar anotaciones en lugar de archivo YAML

Si queremos usar comentarios o annotations para el routing de nuestra app, entonces instalamos el paquete. Nos vamos a donde tengamos nuestro proyecto y ejecutamos:

composer require annotations

Eso instalará el nuevo paquete. Ahora vamos a nuestro controlador que vimos en el post anterior, y agregamos un nuevo método llamado anotaciones para probar.

Nota: para que esto funcione, debemos indicar que usaremos el paquete de Annotation\Route. Junto a nuestros use ponemos:

use Symfony\Component\Routing\Annotation\Route;

Ahora sí agregamos el controlador pero con un comentario arriba de su definición:

<?php
/**
 * @Route("/anotaciones", name="probar_anotaciones")
 */public function anotaciones(){
    return new Response(
        '<html><body>Ahora usamos las anotaciones</body></html>'
    );
}

La anotación viene cuando ponemos @Route("/ruta", name="el nombre")

Sólo para ejemplificar y eliminar confusiones, todo nuestro controlador se ve así:

<?php
namespace App\Controller;
 
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
 
# El nombre de la clase debe coincidir con el nombre del archivo .php 
class HolaController
{
    public function hola()
    {
        return new Response(
            '<html><body>Hola mundo desde <strong>Symfony</strong><br>parzibyte.me</body></html>'
        );
    }
    /**
     * @Route("/anotaciones", name="probar_anotaciones")
     */    public function anotaciones(){
        return new Response(
            '<html><body>Ahora usamos las anotaciones</body></html>'
        );
    }
}
?>

Aquí viene la magia. Ahora navegamos a /anotaciones (pues es la ruta que definimos) y he aquí el resultado:

Anotaciones para rutas en Symfony

Listo, ya hemos configurado nuestra ruta sin tener que modificar el archivo yaml. Aquí dejo la documentación oficial.

Sobre el rendimiento y la preferencia de rutas

Symfony dice que no importa si usamos este método, configuramos con YAML o con XML: el rendimiento sigue siendo el mismo.

Por otro lado, la página recomienda usar la forma de enrutar que aquí se explica.

Por cierto, podemos usar ambos métodos.

Es decir, si queremos usamos algunas rutas con la forma que se explica aquí y tal vez otras con un archivo externo. Esto no se recomienda, pero sí es posible.

Estoy aquí para ayudarte 🤝💻

Estoy aquí para ayudarte en todo lo que necesites. Si requieres alguna modificación en lo presentado en este post, deseas asistencia con tu tarea, proyecto o precisas desarrollar un software a medida, no dudes en contactarme. Estoy comprometido a brindarte el apoyo necesario para que logres tus objetivos. Mi correo es parzibyte(arroba)gmail.com, estoy como@parzibyte en Telegram o en mi página de contacto

No te pierdas ninguno de mis posts 🚀🔔

Suscríbete a mi canal de Telegram para recibir una notificación cuando escriba un nuevo tutorial de programación.

parzibyte

Programador freelancer listo para trabajar contigo. Aplicaciones web, móviles y de escritorio. PHP, Java, Go, Python, JavaScript, Kotlin y más :) https://parzibyte.me/blog/software-creado-por-parzibyte/