Restful api 错误提示返回实现思路

ytwman 发布于2019-06-27 12:17 / 376人阅读

摘要：为此，我仿照了淘宝的错误返回值格式，根据微博错误代码制定的标准自定了自己的错误代码，然后在上进行测试。实现思路我利用抽象工厂模式去实现这样的一个错误返回值。错误返回值的格式就在这里定义。

序言

不管是微博还是淘宝，他们都有自己的错误返回值格式规范，以及错误代码说明，这样不但手机端用起来方便，给人的感觉也清晰明了，高大上。遇到问题先找母本，大公司的规范就是我们参照的母本。为此，我仿照了淘宝的错误返回值格式，根据微博错误代码制定的标准自定了自己的错误代码，然后在Restful api 上进行测试。下面我将实现思路以及测试结果分享给大家。

实现思路

我利用抽象工厂模式去实现这样的一个错误返回值。选择这种模式是因为考虑到了这种模式可以提供一个创建一系列相关或相互依赖对象的接口，与我的需求很接近。

代码分析

1、按这个路径commonhint，我新建了个error文件夹存放我的错误提示程序文件。这文件夹中主要有这几个文件：

2、Hint.php入口文件。定义一个抽象类，里边只写一个方法。

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

3、Template.php 实现Hint这个接口。错误返回值的格式就在这里定义。

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 再创建一个createMsg抽象类。将对象的创建抽象成一个接口。

interface  createMsg { 

    function Msg(); 
    
}

5、用FactoryMsg 类去实现createMsg接口。返回实例化的Template。

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

}

6、ErrorMsg.php 给Template里边的Error方法传参。

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、调用方式。

use commonhinterrorErrorMsg;
ErrorMsg::Info(Yii::t("yii","failure"));

8、测试结果。

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

完成。整个实现过程我采用语言包的形式，这样有利于后期多语言的切换。

常见问题

1、采用这种字符串模糊搜索很泛，无法达到具体错误类型返回对应具体代码的要求。如有更好的建议，欢迎大家提议。

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

2、实现过程中没有考虑到今后多语言切换的问题，然后直接用传统的方式传提示语。比如：ErrorMsg::Info("操作失败");这样是无法实现多语言切换的。建议大家用语言包的方式传参。

相关资料

1、微博开放平台：http://open.weibo.com/wiki/Error_code
2、淘宝开放平台：http://open.taobao.com/doc2/apiDetail.ht...
3、PHP简单工厂模式、工厂方法模式和抽象工厂模式比较：http://www.phpddt.com/php/php-factory.ht...

idc机房托管超融合服务器 restful_api返回天翼云提示服务器返回错误实现思路防ddos攻击软件思路实现

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/21528.html

Restful API 中的错误处理

简介随着移动开发和前端开发的崛起，越来越多的 Web 后端应用都倾向于实现 Restful API。Restful API 是一个简单易用的前后端分离方案，它只需要对客户端请求进行处理，然后返回结果即可，无需考虑页面渲染，一定程度上减轻了后端开发人员的负担。然而，正是由于 Restful API 不需要考虑页面渲染，导致它不能在页面上展示错误信息。那就意着当出现错误的时候，它只能通过返回一个错...

NotFound 2019-08-19 10:16 评论0 收藏0
分布式之API接口返回格式如何优雅设计？

摘要：区间表示参数错误区间表示用户错误区间表示接口异常这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据相关的信息描述，可以快速定位。享学课堂特邀作者：老顾前言在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，（题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，...

phpmatt 2019-05-21 19:52 评论0 收藏0
9-django——restful设计风格

摘要：设计风格协议与用户的通信协议，总是使用协议域名应该尽量将部署在专用域名之下，如果确定很简单，不会有进一步的扩展，可以考虑放在主域名之下。数据库中的表示记录同种数据的集合，所以中的名词也应该使用复数。 showImg(https://segmentfault.com/img/bVbdXlE?w=1560&h=913); RESTful Api设计风格协议：API与用户的通信协议，总是使...

scq000 2019-07-30 17:07 评论0 收藏0
微服务指南走北（三）：Restful API 设计简述

摘要：为了避免的变动导致用户使用中产生意外结果或调用失败，最好强制要求所有访问都需要指定版本号。请避免提供默认版本号，一旦提供，日后想要修改它会相当困难。返回结果针对不同操作，服务器向用户返回的结果应该符合以下规范。 API的定义取决于选择的IPC通信方式,如果是消息机制（如 AMQP 或者 STOMP），API则由消息频道（channel）和消息类型；如果是使用HTTP机制，则是基于请求/...

hqman 2019-07-25 12:13 评论0 收藏0
微服务指南走北（三）：Restful API 设计简述

摘要：为了避免的变动导致用户使用中产生意外结果或调用失败，最好强制要求所有访问都需要指定版本号。请避免提供默认版本号，一旦提供，日后想要修改它会相当困难。返回结果针对不同操作，服务器向用户返回的结果应该符合以下规范。 API的定义取决于选择的IPC通信方式,如果是消息机制（如 AMQP 或者 STOMP），API则由消息频道（channel）和消息类型；如果是使用HTTP机制，则是基于请求/...

harryhappy 2019-05-29 19:24 评论0 收藏0