Maison  >  Article  >  développement back-end  >  Quelles sont les spécifications de développement PHP ?

Quelles sont les spécifications de développement PHP ?

王林
王林avant
2020-01-29 19:54:422354parcourir

Quelles sont les spécifications de développement PHP ?

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 fichier source

Indentation

Utilisez 4 espaces pour l'indentation. IDE peut Paramètres

(Apprentissage recommandé : Tutoriel vidéo php )

Longueur de ligne

120 caractères par ligne

Mots clés

Tous les mots-clés sont en minuscules, comme vrai, faux

Nommez le

nom de la classe en gros chameau, comme UserModel

nom de la méthode de classe en petit camel case, comme getUserId()

les fonctions utilisent une combinaison de lettres minuscules plus _, comme get_cookie()

les noms de variables utilisent la casse chameau, comme $userId

les constantes sont définies sous forme de lettres majuscules. Ajoutez une combinaison _, telle que IS_DEBUG

balise de commentaire de code

pour annoter les classes, les méthodes et les attributs dans les fichiers de classe, utilisez @param @return @throwns

Annotation @param à écrire Explication détaillée, telle que @param string $username Nom d'utilisateur

Module métier

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

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

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

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 de la requête et de l'association des tables 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 , comme

<?php
<?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 des champs obligatoires, ne remplissez pas in si les données sont vides, exemple

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

autre

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

$arr = [ &#39;userId&#39; => 100 ];

Utilisez plusieurs lignes lorsqu'il y a plusieurs clés, exemple

$arr = [  
&#39;id&#39;    => 100,  
&#39;username&#39; => &#39;admin&#39;,
];

Tutoriels d'articles connexes recommandés : tutoriel 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:
Cet article est reproduit dans:. en cas de violation, veuillez contacter admin@php.cn Supprimer