Résumé des spécifications de développement PHP

Cette fois, je vais vous apporter un résumé des spécifications de développement PHP et quelles sont les précautions des spécifications de développement PHP. Ce qui suit est un cas pratique. .

Convention de base

Fichier source

Le code commence par

Le format de fichier doit être BOM -format UTF- 8 gratuit

Un fichier ne déclare qu'un seul type Par exemple, la classe et l'interface ne peuvent pas être mélangées dans un seul fichier source

Indentation

Utilisez 4 espaces pour. l'indentation. L'IDE peut définir la

longueur de ligne

120 caractères par ligne

Mots clés

Tous les mots clés sont en minuscules, tels que vrai, faux

Nommez le nom de la classe

en gros chameau, par exemple UserModel

La méthode de classe est nommée en petit chameau, par exemple getUserId()

La fonction utilise une combinaison de lettres minuscules plus _ , comme get_cookie()

Le nom de la variable utilise la méthode de la casse chameau, comme $userId

La définition de la constante est une combinaison de lettres majuscules plus _, comme IS_DEBUG

Balises de commentaire de code

Annotez les classes, les méthodes et les propriétés dans les fichiers de classe, utilisez @param @return @throwns

Annotation @param pour écrire des explications détaillées, telles que @param string $username Username

Business module

Le routage est composé de lettres minuscules plus _, telles que /api/get_user_info

La couche View est responsable de l'affichage des données

Contrôleur La couche est responsable de la vérification des paramètres d'entrée, la couche la plus externe capture les exceptions, appelle les couches Logic et View

La couche Logic est responsable d'une logique métier spécifique, appelle la couche Modèle et renvoie les données de traitement

La couche Modèle est responsable de la requête et de l'association de la table de données

Les classes d'exception doivent distinguer les fonctions, telles que ParamException signifie une erreur de paramètre, UserException signifie des exceptions personnalisées

Les exceptions doivent être classées et définies en code, utilisez plutôt des constantes de classe PHP, telles que

<?php
namespace app\exceptions\codes;
class UserExceptionCode extends BaseExceptionCode {
  const NO_AUTH       = 1000001;
  const NO_AUTH_MSG     = &#39;不具有权限&#39;;
  const STATUS_EXCEPTION   = 1000002;
  const STATUS_EXCEPTION_MSG = &#39;状态异常&#39;;    
}

Si le fichier de table de données a un type Enum, utilisez plutôt des constantes de classe PHP, telles que

<?php
namespace app\enums;
class UserEnum extends BaseEnum {
  const STATUS_DELETED = -1;// 已删除
  const STATUS_DISABLE = 0;// 禁用
  const STATUS_ENABLE = 1;// 正常
  const AUTH_GUEST     = 1;// 匿名用户
  const AUTH_GENERAL_ADMIN = 2;// 普通管理员
  const AUTH_SUPER_ADMIN  = 3;// 超级管理员
}

où STATUS et AUTH sont les noms des champs de mappage de table de données

Sortie de l'interface API, exemple

{
  "code" : 0,
  "msg" : "success",
  "data" : {
    "userId" : 100
  }
}

Le code et msg sont des champs obligatoires, ne remplissez pas si les données sont vides, exemple

{
  "code" : 100001,
  "msg" : "不具有权限"
}

Autres

tableau, la clé est Utilisez des guillemets simples lorsque la chaîne , utilisez une seule ligne lorsqu'il n'y a qu'une seule clé, exemple

$arr = [ 'userId' => 100 ];

utiliser plusieurs lignes lorsque plusieurs clés, exemple

$arr = [
  'id'    => 100,
  'username' => 'admin',
];

utiliser des guillemets simples pour la chaîne Guillemets '

Je pense que vous maîtrisez la méthode après avoir lu le cas dans cet article. Pour des informations plus intéressantes, veuillez prêter attention aux autres articles connexes sur le site Web chinois de PHP !

Lecture recommandée :

Résumé de la méthode de cryptage du code source PHP

Comment implémenter PHP pour supprimer des dossiers sous des chemins fixes et Fichier

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!