Application et promotion des spécifications PSR2 et PSR4 dans le microframework Lumen

Application et promotion des spécifications PSR2 et PSR4 dans le microframework Lumen

Introduction :
Avec l'application et le développement généralisés du langage PHP, les spécifications de code sont devenues un aspect important pour maintenir la qualité et la lisibilité du code. PHP FIG (PHP FIG, PHP Framework Interop Group) a créé une série de spécifications de bonnes pratiques (PSR, PHP Standards Recommendations) pour le développement PHP, parmi lesquelles PSR2 et PSR4 sont deux spécifications importantes. Cet article se concentrera sur la façon d'appliquer et de promouvoir les spécifications PSR2 et PSR4 dans le microframework Lumen, et fournira des exemples de code spécifiques.

1. Application et promotion des spécifications PSR2 dans Lumen :

1. Style de code :
   Les spécifications PSR2 ont des exigences détaillées pour le style de code, y compris l'indentation, les sauts de ligne, la dénomination, etc. Dans le projet Lumen, nous pouvons appliquer et promouvoir la spécification PSR2 à travers les aspects suivants :

(1) Indentation et sauts de ligne : utilisez quatre espaces pour l'indentation de manière uniforme, et la longueur de chaque ligne ne doit pas dépasser 80 caractères.

Exemples de code spécifiques :

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;

class UserController extends Controller
{
    public function index(Request $request)
    {
        // your code here
    }
}

(2) Convention de dénomination : utilisez la casse camel pour les noms de classe et utilisez des lettres minuscules et des traits de soulignement pour les noms de fonctions et de variables. Utilisez des crochets {} entre les classes et les espaces de noms.

Exemple de code spécifique :

<?php

namespace AppServices;

use AppRepositoriesUserRepository;

class UserService
{
    protected $userRepository;

    public function __construct(UserRepository $userRepository)
    {
        $this->userRepository = $userRepository;
    }

    public function getUserById($id)
    {
        // your code here
    }
}

2. Commentaires :
   La spécification PSR2 stipule le format et le contenu des commentaires. Dans le projet Lumen, nous devons développer de bonnes habitudes de commentaires et utiliser des formats de commentaires standardisés.

(1) Commentaires sur le fichier : Chaque fichier doit contenir des commentaires sur le fichier, indiquant l'auteur du fichier, la date de création, l'enregistrement de modification, etc.

Exemples de code spécifiques :

<?php

/**
 * UserController.php
 *
 * This file is part of the Lumen project.
 *
 * @author John Doe <john.doe@example.com>
 * @created 2022-09-01
 * @updated 2022-09-10
 */

namespace AppHttpControllers;

// ...

(2) Commentaires de fonction : chaque fonction doit contenir des commentaires de fonction, indiquant les paramètres de la fonction, la valeur de retour, la description de la fonction, etc.

Exemples de code spécifiques :

/**
 * Get user by ID.
 *
 * @param int $id User ID
 * @return array
 */
public function getUserById($id)
{
    // your code here
}

2. Application et promotion de la spécification PSR4 dans Lumen :

1. Structure du répertoire :
   La spécification PSR4 propose des exigences détaillées pour le chargement automatique. Dans le projet Lumen, nous pouvons organiser la structure des répertoires du code selon la spécification PSR4 pour améliorer la maintenabilité et l'évolutivité du code.

Exemples de code spécifiques :

│   app/
│   ├── Http/
│   │   ├── Controllers/
│   │   └── Middleware/
│   ├── Models/
│   ├── Repositories/
│   └── Services/

2. Chargement automatique des espaces de noms et des classes :
   Selon les exigences de la spécification PSR4, nous devons configurer la relation de mappage entre les espaces de noms et les classes dans le fichier composer.json, et utiliser Composer pour charger les classes Charger automatiquement.

Exemple de code spécifique (composer.json) :

{
    "autoload": {
        "psr-4": {
            "App\": "app/"
        }
    }
}

Exécutez la commande suivante dans le terminal pour mettre à jour le chargement automatique de la classe :

composer dump-autoload

Après avoir appliqué la configuration ci-dessus, nous pouvons utiliser l'espace de noms complet pour référencer la classe sans introduire manuellement le document.

Exemples de code spécifiques :

<?php

namespace AppHttpControllers;

use AppServicesUserService;
use IlluminateHttpRequest;

class UserController extends Controller
{
    protected $userService;

    public function __construct(UserService $userService)
    {
        $this->userService = $userService;
    }

    public function index(Request $request)
    {
        // your code here
    }
}

Conclusion :
Dans le microframework Lumen, l'application et la promotion des spécifications PSR2 et PSR4 peuvent améliorer la qualité du code, la lisibilité et la maintenabilité du projet. En utilisant des styles de codage et des spécifications d'annotation standardisés, les développeurs peuvent plus facilement comprendre et gérer le code. Dans le même temps, en organisant la structure du répertoire du code et le chargement automatique des classes de configuration conformément aux spécifications PSR4, l'évolutivité et la réutilisabilité du code peuvent être améliorées. Dans les projets réels, nous devons développer de bonnes habitudes de codage et choisir les spécifications appropriées à appliquer et à promouvoir en fonction de la situation réelle.

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!