Début avec les annotations de l'itinéraire Symfony2

Points de base

• SENSIOFRAMEWORKEXTRABUNDLE DE SYMFONY2 Permet aux développeurs d'acheminer la configuration directement dans le contrôleur en utilisant des annotations, fournissant une alternative pratique.
• Les annotations de routage dans Symfony2 rendent la configuration de routage plus modulaire, et chaque route est directement définie dans ses opérations de contrôleur correspondantes, ce qui rend le code plus facile à comprendre et à maintenir.
• Les annotations permettent des configurations de routage détaillées, notamment en définissant les paramètres par défaut de l'URL, en ajoutant des exigences, en appliquant des méthodes ou des schémas HTTP et en appliquant les noms d'hôtes.
• Bien que l'utilisation d'annotations puisse rendre les opérations de contrôleur plus compliquées, car elles incluent désormais les configurations de routage, cela peut être atténué en gardant le routage simple et bien documenté.

La distribution standard de Symfony 2 contient un bundle pratique appelé sensioframeworkextrabundle, qui implémente de nombreuses fonctionnalités puissantes, en particulier la possibilité d'utiliser des annotations directement dans le contrôleur.

Cet article vise à introduire une alternative pratique à la configuration du contrôleur et n'est pas un moyen d'annotation obligatoire. La meilleure approche dépend des exigences de scénario spécifiques.

Symfony 2 gère tout routage pour les applications avec de puissants composants intégrés: composants de routage. Fondamentalement, l'itinéraire correspond à l'URL vers l'action du contrôleur. Étant donné que Symfony est conçu pour être modulaire, un fichier est spécialement configuré pour ceci: routing.yml, situé dans app > config > routing.yml.

Pour comprendre comment définir les itinéraires à l'aide d'annotations, prenons une application de blog simple comme exemple.

Étape 1: Créez un itinéraire de page d'accueil

Nous relions le chemin

à une opération de /. HomeController

pas de méthode d'annotation

dans

: app/config/routing.yml

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

dans

: src/Blog/FrontBundle/Controller/HomeController.php

<?php namespace Blog\FrontBundle\Controller;

class HomeController
{
    public function indexAction()
    {
        //... 创建并返回一个 Response 对象
    } 
}

Dans

, nous déclarons une configuration de routage simple routing.yml avec deux paramètres: le chemin et l'opération de contrôleur à localiser. Le contrôleur lui-même ne nécessite aucun paramètre spécial. blog_front_homepage

en utilisant des annotations

dans

: app/config/routing.yml

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

dans

: src/Blog/FrontBundle/Controller/HomeController.php

<?php 
namespace Blog\FrontBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }
}

Centre: routing.yml

• resource Spécifiez le contrôleur pour affecter
• type Définir comment déclarer les routes
• prefix Définir les préfixes pour toutes les opérations de la classe du contrôleur (facultatif)

Plus important est la façon dont le contrôleur est construit. Tout d'abord, nous devons appeler la classe pertinente de sensioframeworkextrabundle: use SensioBundleFrameworkExtraBundleConfigurationRoute;. Ensuite, nous pouvons implémenter l'itinéraire et ses paramètres: ici seulement le chemin et le nom (nous verrons toutes les opérations qui peuvent être effectuées plus tard): @Route("/", name="blog_homepage").

On pourrait penser: "Nous savons comment écraser le contrôleur avec la couche de routage, alors quel est le point?

Étape 2: Ajouter la route de la page d'article

pas de méthode d'annotation

dans app/config/routing.yml:

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

dans src/Blog/FrontBundle/Controller/HomeController.php:

<?php namespace Blog\FrontBundle\Controller;

class HomeController
{
    public function indexAction()
    {
        //... 创建并返回一个 Response 对象
    } 
}

en utilisant des annotations

dans app/config/routing.yml:

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

dans src/Blog/FrontBundle/Controller/HomeController.php:

<?php 
namespace Blog\FrontBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }
}

Remarque: routing.yml Aucune modification n'est requise. Maintenant, vous pouvez voir en un coup d'œil quelle opération est appelée à partir du mode de routage.

Si vous souhaitez que toutes les opérations du contrôleur soient préfixées, telles que /admin, vous pouvez supprimer la clé routing.yml de prefix et ajouter un extra @Route en haut de la classe Remarque:

dans app/config/routing.yml:

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

blog_front_article:
  path : /article/{slug}
  defaults:  { _controller: BlogFrontBundle:Home:showArticle }

dans src/Blog/AdminBundle/Controller/AdminController.php:

<?php // namespace & uses...

class HomeController
{
    public function indexAction() { /* ... */ }

    public function showArticleAction($slug) { /* ... */ }
}

Étape 3: Configuration de routage supplémentaire

Définir les paramètres par défaut de l'URL

Chemisme: defaults = { "key" = "value" }.

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

L'espace réservé slug n'est plus nécessaire en ajoutant defaults à la clé {slug}. L'URL /article correspondra à cette voie et la valeur du paramètre slug sera définie sur hello. L'URL /blog/world correspondra également et définira la valeur du paramètre page à world.

Ajouter des exigences

Chemisme: requirements = { "key" = "value" }.

<?php // namespace & uses...

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }

    /**
     * @Route("/article/{slug}", name="blog_home_show_article")
     */
    public function showArticleAction($slug) { /* ... */ }
}

Nous pouvons utiliser des expressions régulières pour définir les exigences pour la clé slug, et définir clairement la valeur de {slug} ne doit être constituée que des caractères alphabétiques. Dans l'exemple suivant, nous faisons exactement la même chose avec le nombre:

blog_front: ...

blog_admin:
    resource: "@BlogAdminBundle/Controller/"
    type:     annotation

appliquer la méthode HTTP

Chemisme: methods = { "request method" }.

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

Nous pouvons également correspondre en fonction des méthodes de demandes entrantes (telles que Get, Post, Put, Supprimer). N'oubliez pas que si aucune méthode n'est spécifiée, l'itinéraire correspondra à n'importe quelle méthode.

appliquer la solution HTTP

Chemisme: schemes = { "protocol" }.

<?php namespace Blog\FrontBundle\Controller;

class HomeController
{
    public function indexAction()
    {
        //... 创建并返回一个 Response 对象
    } 
}

Dans ce cas, nous voulons nous assurer que l'itinéraire est accessible via le protocole HTTPS.

appliquer le nom d'hôte

Chemisme: host = "myhost.com".

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

Nous pouvons également correspondre à la base des hôtes HTTP. Cela ne correspondra que si l'hôte est myblog.com.

Étape 4: Pratique

Maintenant, nous pouvons construire une structure de routage fiable, en supposant que nous devons créer la route correcte pour le fonctionnement de la suppression d'articles dans AdminController.php. Nous avons besoin:

• Définissez le chemin comme /admin/delete/article/{id};
Définissez le nom comme
• ; blog_admin_delete_article Définissez l'exigence de la clé
comme numérique uniquement;
• définit la méthode de demande de GET. id
• La réponse est la suivante:

Réflexions finales

<?php 
namespace Blog\FrontBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }
}

Comme vous pouvez le voir, la gestion du routage avec les annotations est facile à écrire, à lire et à maintenir. Il a également l'avantage de concentrer à la fois le code et la configuration dans un fichier: la classe de contrôleur.

utilisez-vous des annotations ou une configuration standard? Lequel préférez-vous et pourquoi?

Symfony2 Routing Annotation FAQS (FAQS)

(La partie FAQ est omise ici car cette partie du contenu ne correspond pas à l'objectif pseudo-original et est trop long. Si nécessaire, une demande pseudo-originale de la partie FAQ peut être faite séparément.)

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!