Maison  >  Article  >  développement back-end  >  Une étude préliminaire sur les spécifications PHP PSR2 et PSR4

Une étude préliminaire sur les spécifications PHP PSR2 et PSR4

王林
王林original
2023-10-15 15:33:14932parcourir

PHP PSR2和PSR4规范初探

Étude préliminaire sur les spécifications PHP PSR2 et PSR4

Introduction :
Dans le processus d'écriture de code PHP, il est très important de suivre certaines spécifications de codage. De bonnes normes de codage peuvent améliorer la lisibilité et la maintenabilité du code et faciliter le travail d’équipe. PHP possède une série de spécifications de codage, parmi lesquelles PSR2 et PSR4 sont les deux spécifications les plus utilisées. Cet article se concentrera sur les spécifications PSR2 et PSR4 et illustrera comment suivre ces spécifications à travers des exemples de code spécifiques.

1. Spécification PSR2
La spécification PSR2 se concentre principalement sur la lisibilité et la cohérence du code PHP. Voici quelques exigences de spécifications courantes :

  1. Indentation
  2. Utilisez 4 espaces pour l'indentation, pas de tabulations.
  3. Utilisez 4 espaces pour un niveau de retrait.
  4. Commentaires d'en-tête de fichier
  5. Chaque fichier PHP doit contenir des commentaires d'en-tête de fichier appropriés pour décrire l'objectif, l'auteur, la date de création et d'autres informations du fichier.
  6. Saut de ligne
  7. Enroulez une ligne après la fin de l'instruction et limitez chaque ligne à 80 caractères maximum.
  8. Autorisez une ligne vide entre les méthodes pour améliorer la lisibilité du code.
  9. Fonctions et méthodes
  10. Les noms de fonctions et les noms de méthodes doivent utiliser la nomenclature en cas de chameau, c'est-à-dire que la première lettre est en minuscule et la première lettre des mots suivants est en majuscule.
  11. La parenthèse gauche des fonctions et des méthodes doit être sur la même ligne que le nom de la fonction ou de la méthode, et la parenthèse droite doit être sur une ligne distincte, alignée avec la parenthèse gauche de la fonction ou de la méthode.
  12. Espace
  13. Il doit y avoir un espace avant et après les opérateurs (tels que =, +, -, etc.).
  14. Il devrait y avoir un espace après les mots-clés des structures de contrôle (comme si, pour, pendant, etc.).

Ce qui suit est un exemple de code conforme à la spécification PSR2 :

<?php
namespace MyApp;

class Calculator
{
    public function add($a, $b)
    {
        return $a + $b;
    }
    
    public function subtract($a, $b)
    {
        return $a - $b;
    }
}

$calculator = new Calculator();
$result = $calculator->add(2, 3);
echo $result;

2. Spécification PSR4
La spécification PSR4 se concentre principalement sur l'espace de noms et le chargement automatique de PHP. Voici quelques exigences de spécification courantes :

  1. Noms d'espaces de noms et de classes
  2. Utilisez des lettres minuscules pour les espaces de noms et utilisez "" comme séparateur.
  3. Les noms de classe utilisent la nomenclature CamelCase, c'est-à-dire que la première lettre de chaque mot est en majuscule.
  4. Structure des répertoires
  5. Les classes doivent être cohérentes avec la structure des répertoires, et chaque partie de l'espace de noms correspond à un sous-répertoire.
  6. L'extension des fichiers de classe doit être .php.
  7. Chargement automatique
  8. Utilisez Composer pour gérer les dépendances et les fonctions de chargement automatique.
  9. Configurez les règles de chargement de la classe PSR4 dans le fichier composer.json.

Ce qui suit est un exemple de code conforme à la spécification PSR4 :

(Définissez la relation de mappage entre l'espace de noms et la classe dans le fichier composer.json)

{
    "autoload": {
        "psr-4": {
            "MyApp\": "src/"
        }
    }
}

(Définissez la classe Calculator dans src/Calculator.php)

<?php
namespace MyApp;

class Calculator
{
    public function add($a, $b)
    {
        return $a + $b;
    }
    
    public function subtract($a, $b)
    {
        return $a - $b;
    }
}

(Utiliser le chargement automatique dans index.php)

<?php
require_once 'vendor/autoload.php';

use MyAppCalculator;

$calculator = new Calculator();
$result = $calculator->add(2, 3);
echo $result;

Conclusion :
Suivre les spécifications PSR2 et PSR4 peut améliorer la lisibilité, la maintenabilité et l'évolutivité du code PHP. Pendant le processus de développement, nous devons activement adopter ces spécifications et vérifier si le code est conforme aux spécifications en utilisant des outils tels que CodeSniffer. Cela nous aide à écrire un meilleur code PHP.

J'espère que grâce à l'introduction et à l'exemple de code de cet article, les lecteurs auront une compréhension préliminaire des spécifications PSR2 et PSR4 et seront en mesure d'appliquer ces spécifications dans des projets réels. Ce n'est qu'en apprenant, en pratiquant et en améliorant constamment votre niveau de codage que vous pourrez devenir un excellent développeur PHP.

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!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn