[asp.net web api] HttpStatusCode的使用

摘要

在开放api的时，我们需要返回不同的状态给调用方，以告诉它们当前请求的结果，是成功了还是失败了。当然这种给调用方的反馈有很多种做法，这里就说是web api内置的对Http状态码。http状态码基本上可以满足日常接口开发的需要了。

HttpStatusCode

该枚举有以下n种值：

#region 程序集 System.dll, v4.0.0.0
// C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5\System.dll
#endregion

using System;

namespace System.Net
{
    // 摘要:
    //     包含为 HTTP 定义的状态代码的值。
    public enum HttpStatusCode
    {
        // 摘要:
        //     等效于 HTTP 状态 100。 System.Net.HttpStatusCode.Continue 指示客户端可能继续其请求。
        Continue = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 101。 System.Net.HttpStatusCode.SwitchingProtocols 指示正在更改协议版本或协议。
        SwitchingProtocols = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 200。 System.Net.HttpStatusCode.OK 指示请求成功，且请求的信息包含在响应中。 这是最常接收的状态代码。
        OK = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 201。 System.Net.HttpStatusCode.Created 指示请求导致在响应被发送前创建新资源。
        Created = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 202。 System.Net.HttpStatusCode.Accepted 指示请求已被接受做进一步处理。
        Accepted = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 203。 System.Net.HttpStatusCode.NonAuthoritativeInformation 指示返回的元信息来自缓存副本而不是原始服务器，因此可能不正确。
        NonAuthoritativeInformation = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 204。 System.Net.HttpStatusCode.NoContent 指示已成功处理请求并且响应已被设定为无内容。
        NoContent = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 205。 System.Net.HttpStatusCode.ResetContent 指示客户端应重置（或重新加载）当前资源。
        ResetContent = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 206。 System.Net.HttpStatusCode.PartialContent 指示响应是包括字节范围的 GET
        //     请求所请求的部分响应。
        PartialContent = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 300。 System.Net.HttpStatusCode.MultipleChoices 指示请求的信息有多种表示形式。
        //     默认操作是将此状态视为重定向，并遵循与此响应关联的 Location 标头的内容。
        MultipleChoices = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 300。 System.Net.HttpStatusCode.Ambiguous 指示请求的信息有多种表示形式。 默认操作是将此状态视为重定向，并遵循与此响应关联的
        //     Location 标头的内容。
        Ambiguous = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 301。 System.Net.HttpStatusCode.MovedPermanently 指示请求的信息已移到 Location
        //     头中指定的 URI 处。 接收到此状态时的默认操作为遵循与响应关联的 Location 头。
        MovedPermanently = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 301。 System.Net.HttpStatusCode.Moved 指示请求的信息已移到 Location 头中指定的
        //     URI 处。 接收到此状态时的默认操作为遵循与响应关联的 Location 头。 原始请求方法为 POST 时，重定向的请求将使用 GET 方法。
        Moved = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 302。 System.Net.HttpStatusCode.Found 指示请求的信息位于 Location 头中指定的
        //     URI 处。 接收到此状态时的默认操作为遵循与响应关联的 Location 头。 原始请求方法为 POST 时，重定向的请求将使用 GET 方法。
        Found = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 302。 System.Net.HttpStatusCode.Redirect 指示请求的信息位于 Location 头中指定的
        //     URI 处。 接收到此状态时的默认操作为遵循与响应关联的 Location 头。 原始请求方法为 POST 时，重定向的请求将使用 GET 方法。
        Redirect = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 303。 作为 POST 的结果，System.Net.HttpStatusCode.SeeOther 将客户端自动重定向到
        //     Location 头中指定的 URI。 用 GET 生成对 Location 标头所指定的资源的请求。
        SeeOther = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 303。 作为 POST 的结果，System.Net.HttpStatusCode.RedirectMethod 将客户端自动重定向到
        //     Location 头中指定的 URI。 用 GET 生成对 Location 标头所指定的资源的请求。
        RedirectMethod = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 304。 System.Net.HttpStatusCode.NotModified 指示客户端的缓存副本是最新的。 未传输此资源的内容。
        NotModified = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 305。 System.Net.HttpStatusCode.UseProxy 指示请求应使用位于 Location 头中指定的
        //     URI 的代理服务器。
        UseProxy = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 306。 System.Net.HttpStatusCode.Unused 是未完全指定的 HTTP/1.1 规范的建议扩展。
        Unused = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 307。 System.Net.HttpStatusCode.RedirectKeepVerb 指示请求信息位于 Location
        //     头中指定的 URI 处。 接收到此状态时的默认操作为遵循与响应关联的 Location 头。 原始请求方法为 POST 时，重定向的请求还将使用
        //     POST 方法。
        RedirectKeepVerb = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 307。 System.Net.HttpStatusCode.TemporaryRedirect 指示请求信息位于 Location
        //     头中指定的 URI 处。 接收到此状态时的默认操作为遵循与响应关联的 Location 头。 原始请求方法为 POST 时，重定向的请求还将使用
        //     POST 方法。
        TemporaryRedirect = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 400。 System.Net.HttpStatusCode.BadRequest 指示服务器未能识别请求。 如果没有其他适用的错误，或者不知道准确的错误或错误没有自己的错误代码，则发送
        //     System.Net.HttpStatusCode.BadRequest。
        BadRequest = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 401。 System.Net.HttpStatusCode.Unauthorized 指示请求的资源要求身份验证。 WWW-Authenticate
        //     头包含如何执行身份验证的详细信息。
        Unauthorized = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 402。 保留 System.Net.HttpStatusCode.PaymentRequired 以供将来使用。
        PaymentRequired = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 403。 System.Net.HttpStatusCode.Forbidden 指示服务器拒绝满足请求。
        Forbidden = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 404。 System.Net.HttpStatusCode.NotFound 指示请求的资源不在服务器上。
        NotFound = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 405。 System.Net.HttpStatusCode.MethodNotAllowed 指示请求的资源上不允许请求方法（POST
        //     或 GET）。
        MethodNotAllowed = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 406。 System.Net.HttpStatusCode.NotAcceptable 指示客户端已用 Accept 头指示将不接受资源的任何可用表示形式。
        NotAcceptable = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 407。 System.Net.HttpStatusCode.ProxyAuthenticationRequired 指示请求的代理要求身份验证。
        //     Proxy-authenticate 头包含如何执行身份验证的详细信息。
        ProxyAuthenticationRequired = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 408。 System.Net.HttpStatusCode.RequestTimeout 指示客户端没有在服务器期望请求的时间内发送请求。
        RequestTimeout = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 409。 System.Net.HttpStatusCode.Conflict 指示由于服务器上的冲突而未能执行请求。
        Conflict = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 410。 System.Net.HttpStatusCode.Gone 指示请求的资源不再可用。
        Gone = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 411。 System.Net.HttpStatusCode.LengthRequired 指示缺少必需的 Content-length
        //     头。
        LengthRequired = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 412。 System.Net.HttpStatusCode.PreconditionFailed 指示为此请求设置的条件失败，且无法执行此请求。
        //     条件是用条件请求标头（如 If-Match、If-None-Match 或 If-Unmodified-Since）设置的。
        PreconditionFailed = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 413。 System.Net.HttpStatusCode.RequestEntityTooLarge 指示请求太大，服务器无法处理。
        RequestEntityTooLarge = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 414。 System.Net.HttpStatusCode.RequestUriTooLong 指示 URI 太长。
        RequestUriTooLong = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 415。 System.Net.HttpStatusCode.UnsupportedMediaType 指示请求是不支持的类型。
        UnsupportedMediaType = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 416。 System.Net.HttpStatusCode.RequestedRangeNotSatisfiable 指示无法返回从资源请求的数据范围，因为范围的开头在资源的开头之前，或因为范围的结尾在资源的结尾之后。
        RequestedRangeNotSatisfiable = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 417。 System.Net.HttpStatusCode.ExpectationFailed 指示服务器未能符合 Expect
        //     头中给定的预期值。
        ExpectationFailed = ,
        //
        UpgradeRequired = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 500。 System.Net.HttpStatusCode.InternalServerError 指示服务器上发生了一般错误。
        InternalServerError = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 501。 System.Net.HttpStatusCode.NotImplemented 指示服务器不支持请求的函数。
        NotImplemented = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 502。 System.Net.HttpStatusCode.BadGateway 指示中间代理服务器从另一代理或原始服务器接收到错误响应。
        BadGateway = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 503。 System.Net.HttpStatusCode.ServiceUnavailable 指示服务器暂时不可用，通常是由于过多加载或维护。
        ServiceUnavailable = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 504。 System.Net.HttpStatusCode.GatewayTimeout 指示中间代理服务器在等待来自另一个代理或原始服务器的响应时已超时。
        GatewayTimeout = ,
        //
        // 摘要:
        //     等效于 HTTP 状态 505。 System.Net.HttpStatusCode.HttpVersionNotSupported 指示服务器不支持请求的
        //     HTTP 版本。
        HttpVersionNotSupported = ,
    }
}

HttpStatusCode

一个简单的例子

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;

namespace Wolfy.HttpStatusDemo.Controllers
{
    public class TestController : ApiController
    {
        [HttpGet]
        [Route("api/user/{id:int}")]
        public HttpResponseMessage FindUser(int id)
        {
            HttpResponseMessage message = new HttpResponseMessage();
            if (id == )
            {
                //模拟 查询 存在
                message.StatusCode = HttpStatusCode.OK;
                message.Content = new StringContent(JsonConvert.SerializeObject(new { id = id, name = "wolfy" }));
            }
            else
            {
                //模拟 查询 不存在
                message.StatusCode = HttpStatusCode.NotFound;
                message.Content = new StringContent("");
            }

            return message;
        }
        [HttpPost]
        [Route("api/user")]
        public HttpResponseMessage CreateUser()
        {
            object user = new { id = , name = "zhangsan" };
            HttpResponseMessage message = new HttpResponseMessage();
            message.StatusCode = HttpStatusCode.Created;
            message.Content = new StringContent(JsonConvert.SerializeObject(user));
            return message;
        }
    }
}

前端调用

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title></title>
    <script src="Scripts/jquery-3.1.1.js"></script>
    <script>
        $(function () {
            $.ajax({
                url: "api/user/1",
                cache: false,
                type: "get",
                contentType: "application/json",
                statusCode: {
                    : function (data) {
                        console.log(data);
                    },
                    : function (data) {
                        console.log(data);
                        console.log("not found");
                    }

                },
            });
        });
    </script>
</head>
<body>

</body>
</html>

测试

不存在

创建

            $.ajax({
                url: "api/user",
                cache: false,
                type: "POST",
                contentType: "application/json",
                statusCode: {
                    : function (data) {
                        console.log(data);
                    },
                    : function (data) {
                        console.log(data);
                        console.log("not found");
                    },
                    : function (data) {
                        console.log(data);
                    }

                },
            });

总结

Http状态码在实际操作中，足够响应操作的实际处理结果了。当然，如果想自定义，也可以在message.content中自定义一个code来代表你的操作是否成功。