接口设计和响应码参考

项目响应参照http定义的响应码,成功条件下直接返回请求内容.无内容返回204.所有失败直接抛出异常,系统在使用统一的异常处理,对于json请求返回json,非json返回对应的错误页面.

在项目中,发生的任何需要返回非200开头的响应的时候,均直接抛出一个http异常.项目中有统一的异常处理中心,异常处理中心作统一化处理,比如最基本的,json请求响应json,非json请求响应页面.需要根据自己的业务定制各种异常,比如资源类错误ResourceException(继承自HttpException).然后StoreResourceFailedException继承自ResourceException.设计各种异常,在业务代码中需要返回错误的时候,直接throw一个异常就好了,十分方便清晰.

响应

响应使用json,遵照http标准.

成功

200(包括其他200开头的响应码)时直接返回请求结果;
204,表示无内容的成功响应,会执行success回调,但是没有data数据.

失败

发生错误全部使用http异常响应.
错误信息包含在响应体中的error字段中.
(如ajax请求获取:XMLHttpRequest.responseJSON.error).

关于 422 响应码
对于422验证失败的错误,在一些情况下响应体中是不返回error字段的.
响应返回的是key-value形式的键值对,key表示错误字段,value表示错误原因.比如返回:"["name"=>"名称 不能为空","mobile"=>"手机号 不能为空"]"


例子

在ajax请求中的error中处理错误:

error: function (XMLHttpRequest, textStatus, errorThrown) {
        var msg=""; 
        if(XMLHttpRequest.status == 401){
              //未授权,刨除编码错误导致的401.
              //对于微信端可能是token失效,需要通过授权中心重新获得token
        }
        if (XMLHttpRequest.responseJSON && XMLHttpRequest.responseJSON.error) {
            //后台有专门返回的错误信息的情况
            msg += XMLHttpRequest.responseJSON.error;
        } else {
            //如果没有响应中没有error
            if (XMLHttpRequest.status == 422) {
                //422 响应可能返回数组形式错误信息.如:["name"=>"名称 不能为空","mobile"=>"手机号 不能为空"]
                var erroMsg = JSON.parse(XMLHttpRequest.responseText);
                $.each(erroMsg, function (k, v) {
                    msg += v[0] + "\\n";
                });
            } else {
                //其他
                msg += XMLHttpRequest.statusText + ":" + XMLHttpRequest.status;
            }
        }
        //拿着msg做出提示
}

详细介绍

响应码由三位十进制数字组成,它们出现在由HTTP服务器发送的响应的第一行。

响应码分五种类型,由它们的第一位数字表示:

1xx:信息,请求收到,继续处理 
2xx:成功,行为被成功地接受、理解和采纳 
3xx:重定向,为了完成请求,必须进一步执行的动作 
4xx:客户端错误,请求包含语法错误或者请求无法实现 
5xx:服务器错误,服务器不能实现一种明显无效的请求

    100 => 'Continue', //继续 
    101 => 'Switching Protocols', //分组交换协议 
    102 => 'Processing',             // RFC2518
    200 => 'OK',
    201 => 'Created',                 //被创建 
    202 => 'Accepted',              //被采纳 
    203 => 'Non-Authoritative Information',  //非授权信息 
    204 => 'No Content',   //无内容 
    205 => 'Reset Content',    //重置内容 
    206 => 'Partial Content',  //部分内容 
    207 => 'Multi-Status',          // RFC4918
    208 => 'Already Reported',      // RFC5842
    226 => 'IM Used',               // RFC3229
    300 => 'Multiple Choices',  //多选项 
    301 => 'Moved Permanently',  //永久地传送  
    302 => 'Found',   //找到 
    303 => 'See Other',   //参见其他 
    304 => 'Not Modified',   //未改动 
    305 => 'Use Proxy',    //使用代理 
    307 => 'Temporary Redirect',  //暂时重定向 
    308 => 'Permanent Redirect',    // RFC7238
    400 => 'Bad Request',   //错误请求 
    401 => 'Unauthorized',   //未授权 
    402 => 'Payment Required',  //要求付费 
    403 => 'Forbidden',   //禁止 
    404 => 'Not Found',   //未找到 
    405 => 'Method Not Allowed',   //不允许的方法 
    406 => 'Not Acceptable',   //不被采纳 
    407 => 'Proxy Authentication Required',   //要求代理授权 
    408 => 'Request Timeout',   //请求超时 
    409 => 'Conflict',   //冲突 
    410 => 'Gone',    //过期的 
    411 => 'Length Required',   //要求的长度 
    412 => 'Precondition Failed',    //前提不成立 
    413 => 'Payload Too Large',    //请求实例太大 
    414 => 'URI Too Long',    //请求URI太大 
    415 => 'Unsupported Media Type',   //不支持的媒体类型 
    416 => 'Range Not Satisfiable',     //无法满足的请求范围 
    417 => 'Expectation Failed',     //失败的预期 
    418 => 'I\'m a teapot',                                               // RFC2324
    421 => 'Misdirected Request',                                         // RFC7540
    422 => 'Unprocessable Entity',                                        // RFC4918,资源错误
    423 => 'Locked',                                                      // RFC4918
    424 => 'Failed Dependency',                                           // RFC4918
    425 => 'Reserved for WebDAV advanced collections expired proposal',   // RFC2817
    426 => 'Upgrade Required',                                            // RFC2817
    428 => 'Precondition Required',                                       // RFC6585
    429 => 'Too Many Requests',                                           // RFC6585
    431 => 'Request Header Fields Too Large',                             // RFC6585
    451 => 'Unavailable For Legal Reasons',                               // RFC7725
    500 => 'Internal Server Error',   //内部服务器错误 
    501 => 'Not Implemented',   //未被使用 
    502 => 'Bad Gateway',     //网关错误 
    503 => 'Service Unavailable',   //不可用的服务/维护
    504 => 'Gateway Timeout',   //网关超时 
    505 => 'HTTP Version Not Supported',   //HTTP版本未被支持
    506 => 'Variant Also Negotiates (Experimental)',                      // RFC2295
    507 => 'Insufficient Storage',                                        // RFC4918
    508 => 'Loop Detected',                                               // RFC5842
    510 => 'Not Extended',                                                // RFC2774
    511 => 'Network Authentication Required',                             // RFC6585

部分响应码详细介绍

了解更多请参考:http响应码

  • 100 Continue 初始的请求已经接受,客户应当继续发送请求的其余部分。(HTTP 1.1新)
  • 101 Switching Protocols 服务器将遵从客户的请求转换到另外一种协议(HTTP 1.1新)
  • 200 OK 一切正常,对GET和POST请求的应答文档跟在后面。
  • 201 Created 服务器已经创建了文档,Location头给出了它的URL。
  • 202 Accepted 已经接受请求,但处理尚未完成。
  • 203 Non-Authoritative Information 文档已经正常地返回,但一些应答头可能不正确,因为使用的是文档的拷贝(HTTP 1.1新)。
  • 204 No Content 没有新文档,浏览器应该继续显示原来的文档。如果用户定期地刷新页面,而Servlet可以确定用户文档足够新,这个状态代码是很有用的。
  • 205 Reset Content 没有新的内容,但浏览器应该重置它所显示的内容。用来强制浏览器清除表单输入内容(HTTP 1.1新)。
  • 206 Partial Content 客户发送了一个带有Range头的GET请求,服务器完成了它(HTTP 1.1新)。
  • 300 Multiple Choices 客户请求的文档可以在多个位置找到,这些位置已经在返回的文档内列出。如果服务器要提出优先选择,则应该在Location应答头指明。
  • 301 Moved Permanently 客户请求的文档在其他地方,新的URL在Location头中给出,浏览器应该自动地访问新的URL。
  • 302 Found 类似于301,但新的URL应该被视为临时性的替代,而不是永久性的。注意,在HTTP1.0中对应的状态信息是“Moved Temporatily”. 出现该状态代码时,浏览器能够自动访问新的URL,因此它是一个很有用的状态代码。 注意这个状态代码有时候可以和301替换使用。例如,如果浏览器错误地请求http://host/~user(缺少了后面的斜杠),有的服务器返回301,有的则返回302。严格地说,我们只能假定只有当原来的请求是GET时浏览器才会自动重定向。请参见307。
  • 303 See Other 类似于301/302,不同之处在于,如果原来的请求是POST,Location头指定的重定向目标文档应该通过GET提取(HTTP 1.1新)。
  • 304 Not Modified 客户端有缓冲的文档并发出了一个条件性的请求(一般是提供If-Modified-Since头表示客户只想比指定日期更新的文档)。服务器告诉客户,原来缓冲的文档还可以继续使用。
  • 305 Use Proxy 客户请求的文档应该通过Location头所指明的代理服务器提取(HTTP 1.1新)。
  • 307 Temporary Redirect 和302(Found)相同。许多浏览器会错误地响应302应答进行重定向,即使原来的请求是POST,即使它实际上只能在POST请求的应答是303时 才能重定向。由于这个原因,HTTP 1.1新增了307,以便更加清除地区分几个状态代码:当出现303应答时,浏览器可以跟随重定向的GET和POST请求;如果是307应答,则浏览器只 能跟随对GET请求的重定向。(HTTP 1.1新)
  • 400 Bad Request 请求出现语法错误。
  • 401 Unauthorized 客户试图未经授权访问受密码保护的页面。应答中会包含一个WWW-Authenticate头,浏览器据此显示用户名字/密码对话框,然后在填写合适的Authorization头后再次发出请求。
  • 403 Forbidden 资源不可用。服务器理解客户的请求,但拒绝处理它。通常由于服务器上文件或目录的权限设置导致。
  • 404 Not Found 无法找到指定位置的资源。这也是一个常用的应答。
  • 405 Method Not Allowed 请求方法(GET、POST、HEAD、Delete、PUT、TRACE等)对指定的资源不适用。(HTTP 1.1新)
  • 406 Not Acceptable 指定的资源已经找到,但它的MIME类型和客户在Accpet头中所指定的不兼容(HTTP 1.1新)。
  • 407 Proxy Authentication Required 类似于401,表示客户必须先经过代理服务器的授权。(HTTP 1.1新)
  • 408 Request Timeout 在服务器许可的等待时间内,客户一直没有发出任何请求。客户可以在以后重复同一请求。(HTTP 1.1新)
  • 409 Conflict 通常和PUT请求有关。由于请求和资源的当前状态相冲突,因此请求不能成功。(HTTP 1.1新)
  • 410 Gone 所请求的文档已经不再可用,而且服务器不知道应该重定向到哪一个地址。它和404的不同在于,返回407表示文档永久地离开了指定的位置,而404表示由于未知的原因文档不可用。(HTTP 1.1新)
  • 411 Length Required 服务器不能处理请求,除非客户发送一个Content-Length头。(HTTP 1.1新)
  • 412 Precondition Failed 请求头中指定的一些前提条件失败(HTTP 1.1新)。
  • 413 Request Entity Too Large 目标文档的大小超过服务器当前愿意处理的大小。如果服务器认为自己能够稍后再处理该请求,则应该提供一个Retry-After头(HTTP 1.1新)。
  • 414 Request URI Too Long URI太长(HTTP 1.1新)。
  • 416 Requested Range Not Satisfiable 服务器不能满足客户在请求中指定的Range头。(HTTP 1.1新)
  • 500 Internal Server Error 服务器遇到了意料不到的情况,不能完成客户的请求。
  • 501 Not Implemented 服务器不支持实现请求所需要的功能。例如,客户发出了一个服务器不支持的PUT请求。
  • 502 Bad Gateway 服务器作为网关或者代理时,为了完成请求访问下一个服务器,但该服务器返回了非法的应答。
  • 503 Service Unavailable 服务器由于维护或者负载过重未能应答。例如,Servlet可能在数据库连接池已满的情况下返回503。服务器返回503时可以提供一个Retry-After头。
  • 504 Gateway Timeout 由作为代理或网关的服务器使用,表示不能及时地从远程服务器获得应答。(HTTP 1.1新)
  • 505 HTTP Version Not Supported 服务器不支持请求中所指明的HTTP版本。(HTTP 1.1新)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 148,827评论 1 317
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 63,511评论 1 266
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 99,318评论 0 218
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,108评论 0 189
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,112评论 1 266
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,387评论 1 185
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,905评论 2 283
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,657评论 0 177
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,144评论 0 223
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,744评论 2 225
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,100评论 1 236
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,565评论 2 222
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,041评论 3 216
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,769评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,301评论 0 178
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,173评论 2 239
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,313评论 2 242

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,036评论 18 139
  • API定义规范 本规范设计基于如下使用场景: 请求频率不是非常高:如果产品的使用周期内请求频率非常高,建议使用双通...
    有涯逐无涯阅读 2,436评论 0 6
  • 一、概念(载录于:http://www.cnblogs.com/EricaMIN1987_IT/p/3837436...
    yuantao123434阅读 8,266评论 6 152
  • 跟浩子在家搭摩托车模型,拆了装,装了拆,直到组装完毕。我们都说,小孩子获取快乐的成本特别低,一个玩具就能快乐一整天...
    卖小妞的饼干阅读 258评论 0 0
  • 黑白本是一色,有了此才生成了彼。 网络解构的不单单是空间,还毫不留情的祸害了时间。 时间已经被你压缩的不成样子,为...
    七色黑白阅读 241评论 0 1