Explication détaillée des exemples de spécifications de développement PHP

Cet article partage principalement avec vous des exemples détaillés de spécifications de développement PHP, dans l'espoir d'aider tout le monde.

Fichier source

Le code commence par a9499b5adefe6f01f1cfa030ff753a97

Le format de fichier doit être sans nomenclature Format UTF-8

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, comme vrai, faux

Nom

Le nom de la classe est en casse chameau, comme UserModel

Les noms de méthodes de classe sont en CamelCase, comme getUserId()

Les fonctions utilisent des lettres minuscules plus _, comme get_cookie()

Les noms de variables utilisent La méthode CamelCase, telle que $userId

, est définie comme une combinaison de lettres majuscules plus _, telle que IS_DEBUG

étiquette de commentaire de code

dans le fichier de classe Annotez les classes, les méthodes et les attributs. Utilisez l'annotation @param @return @throwns

@param pour écrire des explications détaillées, telles que @param string $username username
<.>

Module métier

Les itinéraires sont composés de lettres minuscules plus _, telles que /api/get_user_info

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

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

La couche Logique est responsable de la logique métier spécifique, appelle la Couche modèle et renvoie les données de traitement

La couche modèle est responsable des requêtes et des associations de tables de données

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

Les exceptions doivent être classées et définies en code, utilisez des classes PHP Remplacez par des constantes, 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
  }
}

où code et msg sont un champ obligatoire, ne remplissez pas si les données sont vides, exemple

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

Autres

tableau, la clé est une chaîne Utiliser des guillemets simples lorsqu'il n'y a qu'une seule clé, utiliser une seule ligne lorsqu'il n'y en a qu'une une touche, exemple

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

Utiliser plusieurs lignes lorsqu'il y a plusieurs touches, exemple

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

Utilisez des guillemets simples pour les chaînes '

Recommandations associées :

code php Manuel de spécification de développement PHP Explication détaillée des spécifications du code PHP

Résumé de Spécifications de développement PHP

Explication détaillée des spécifications du code PHP dans le manuel des spécifications de développement 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!