Comment implémenter la valeur de retour de l'invite d'erreur dans l'API Restful en PHP

REST est l'abréviation de Representational State Transfer, qui se traduit par « transformation d'état de la couche de présentation ». La couche de présentation est en fait une ressource, elle peut donc être comprise comme une « transformation de l'état de la ressource ». Ensuite, cet article vous présentera les idées de mise en œuvre de la valeur de retour de l'invite d'erreur de l'API Restful. Les amis intéressés peuvent apprendre ensemble

L'architecture RESTful est un Internet populaire. Architecture logicielle, elle a une structure claire, est conforme aux normes, est facile à comprendre et facile à développer.

REST est l'abréviation de Representational State Transfer, qui se traduit par « transformation d'état de la couche de présentation ». La couche de présentation est en fait une ressource, elle peut donc être comprise comme une « transformation de l'état de la ressource ».

Toute entité présente sur l'application web peut être considérée comme une ressource, pointée par un URI (Uniform Resource Locator).

Préface

Qu'il s'agisse de Weibo ou de Taobao, ils ont leurs propres spécifications de format de valeur de retour d'erreur et descriptions de code d'erreur. la version mobile est facile à utiliser et semble claire et haut de gamme. Lorsque nous rencontrons des problèmes, nous devons d 'abord nous adresser à la société mère. Les normes des grandes entreprises sont la mère à laquelle nous pouvons nous référer. À cette fin, j'ai imité le format de valeur de retour d'erreur de Taobao, personnalisé mon propre code d'erreur en fonction des normes définies par les codes d'erreur Weibo, puis je l'ai testé sur l'API Restful. Ci-dessous, je partagerai avec vous les idées de mise en œuvre et les résultats des tests.

Idée d'implémentation

J'utilise le modèle d'usine abstraite pour implémenter une telle valeur de retour d'erreur. J'ai choisi ce modèle car il fournit une interface de création d'une série d'objets liés ou interdépendants, très proche de mes besoins.

Analyse du code

1 Selon ce chemin commun, j'ai créé un nouveau dossier d'erreur pour stocker mes fichiers de programme d'invite d'erreur. Ce dossier contient principalement ces fichiers :

2. Fichier d'entrée Hint.php. Définissez une classe abstraite et n’y écrivez qu’une seule méthode.

interface Hint {
function Error($_errors,$code);
}

3. Template.php implémente l'interface Hint. Le format de la valeur de retour d'erreur est défini ici.

class Template implements Hint{
function Error($_errors,$code) { 
if (empty($_errors)) {
print_r(json_encode([]));
} else { 
$errors['error']['name'] = 'Not Found';
$errors['error']['message'] = $_errors;
$errors['error']['error_code'] = $code; 
print_r(json_encode($errors));
}
}
}

4. createMsg.php Créez une autre classe abstraite createMsg. Abstraction de la création d'objets dans une interface.

interface createMsg { 
function Msg(); 
}

5. Utilisez la classe FactoryMsg pour implémenter l'interface createMsg. Renvoie le modèle instancié.

class FactoryMsg implements createMsg{
function Msg() {
return new Template;
}
}

6. ErrorMsg.php transmet les paramètres à la méthode Error dans le modèle.

class ErrorMsg {
// 抽象工厂里的静态方法
public static function Info($_errors) { 
$Factory = new FactoryMsg;
$result = strstr($_errors,Yii::t('yii','Not exist')); //数据不存在 20001
$result1 = strstr($_errors,Yii::t('yii','Null')); //参数不能为空 20002
$result2 = strstr($_errors,Yii::t('yii','Fail')); //新增、更新、删除失败 20003
$result3 = strstr($_errors,Yii::t('yii','Not right')); //XX不正确 20004
$result4 = strstr($_errors,Yii::t('yii','Robc')); //XX无权限 20005
//数据不存在 20001
if(!empty($result)){ 
$M = $Factory->Msg();
$M->Error($_errors,'20001');die;
}
//参数不能为空 20002
if(!empty($result1)){ 
$M = $Factory->Msg();
$M->Error($_errors,'20002');die;
}
//新增、更新、删除失败 20003
if(!empty($result2)){ 
$M = $Factory->Msg();
$M->Error($_errors,'20003');die;
}
//XX不正确 20004
if(!empty($result3)){ 
$M = $Factory->Msg();
$M->Error($_errors,'20004');die;
}
//XX无权限 20005
if(!empty($result4)){ 
$M = $Factory->Msg();
$M->Error($_errors,'20005');die;
}
//默认类型 21000
$M = $Factory->Msg();
$M->Error($_errors,'21000');
}
}

7. Méthode d'appel.

use common\hint\error\ErrorMsg;
ErrorMsg::Info(Yii::t('yii','failure'));

8. Résultats des tests.

{
"error": {
"name": "Not Found",
"message": "操作失败",
"error_code": "20003"
}
}

Fait. J'utilise la forme de packs linguistiques pour l'ensemble du processus de mise en œuvre, ce qui facilitera le changement multilingue ultérieur.

Questions fréquemment posées

1 L'utilisation de ce type de recherche floue de chaîne est très générale et ne peut pas répondre à l'exigence de renvoyer des codes spécifiques correspondant à. types d'erreurs spécifiques. Si vous avez de meilleures suggestions, n'hésitez pas à les faire.

$result = strstr($_errors,Yii::t('yii','Not exist'));

2. Lors du processus de mise en œuvre, la question de la future commutation multilingue n'a pas été prise en compte et les invites ont été directement transmises de la manière traditionnelle. Par exemple : ErrorMsg::Info("Operation failed"); La commutation multilingue ne peut pas être obtenue de cette manière. Il est recommandé d'utiliser des modules linguistiques pour transmettre les paramètres.

Résumé : Ce qui précède représente l'intégralité du contenu de cet article, j'espère qu'il sera utile à l'étude de chacun.

Recommandations associées :

phpUtiliser curl pour obtenir la méthode d'implémentation d'images distantes

phpMettre en œuvre la méthode et l'exemple simple d'obtention de la valeur de la case à cocher

phpExplication graphique détaillée de l'utilisation du texte pour compter les visites

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!