.NET RESTful服务中如何在自定义JsonResult中管理HttpStatusCode

我来帮你搞定这个问题！你想要既保持接口方法签名的清晰（明确返回JsonResult<T>），又能灵活设置HttpStatusCode，结合你已经把CreateResponse移到CustomApiController的情况，有两种实用的方案，我给你详细说下：

方案一：直接在控制器的CreateResponse方法中设置状态码 #

这种方式最简单直接，利用ApiController自带的Response属性就能修改当前请求的状态码，同时返回你的自定义JsonResult<T>：

首先调整CustomApiController中的CreateResponse方法：

public class CustomApiController : ApiController
{
    // 改成控制器的实例方法，方便访问上下文
    protected JsonResult<T> CreateResponse<T>(T data, Notify notify = null, HttpStatusCode code = HttpStatusCode.OK)
    {
        // 直接设置响应状态码
        Response.StatusCode = (int)code;
        
        // 处理空的Notify，避免返回null
        var defaultNotify = notify ?? new Notify { Severity = Severity.Info };
        
        return new JsonResult<T>
        {
            Data = data,
            Notify = defaultNotify
        };
    }
}

然后你的接口方法就可以这样写，既清晰看到返回类型，又能指定状态码：

public class TestController : CustomApiController
{
    public JsonResult<string> GetSuccess()
    {
        // 默认返回200 OK
        return CreateResponse("Ciao Mondo!");
    }

    public JsonResult<MyDataModel> GetBadRequest()
    {
        var errorNotify = new Notify 
        { 
            Message = "参数格式错误", 
            Severity = Severity.Error 
        };
        // 返回400 BadRequest状态码
        return CreateResponse(new MyDataModel(), errorNotify, HttpStatusCode.BadRequest);
    }
}

方案二：让JsonResult实现IHttpActionResult（更规范的Web API方式） #

如果你想更贴合Web API的设计模式，推荐让JsonResult<T>实现IHttpActionResult接口，这样可以完全控制响应的创建过程，包括状态码、序列化配置等：

首先修改JsonResult<T>的定义：

public class JsonResult<T> : IHttpActionResult
{
    public Notify Notify { get; set; }
    public T Data { get; set; }
    public HttpStatusCode StatusCode { get; set; }
    private readonly HttpRequestMessage _request;

    // 构造函数接收请求对象、数据、通知和状态码
    public JsonResult(T data, Notify notify, HttpStatusCode statusCode, HttpRequestMessage request)
    {
        Data = data;
        Notify = notify ?? new Notify { Severity = Severity.Info };
        StatusCode = statusCode;
        _request = request;
    }

    // 实现IHttpActionResult的核心方法，创建完整的HttpResponseMessage
    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        // 用Request创建响应，自动处理序列化，同时设置状态码
        var response = _request.CreateResponse(StatusCode, this);
        return Task.FromResult(response);
    }
}

然后在CustomApiController中更新CreateResponse方法：

public class CustomApiController : ApiController
{
    protected JsonResult<T> CreateResponse<T>(T data, Notify notify = null, HttpStatusCode code = HttpStatusCode.OK)
    {
        // 传入当前请求对象，让JsonResult自己创建响应
        return new JsonResult<T>(data, notify, code, Request);
    }
}

接口方法的调用方式和方案一完全一样，但这种方式扩展性更强——比如后续你想添加自定义的JSON序列化设置、响应头，都可以在ExecuteAsync方法里统一处理，而且完全符合Web API的最佳实践。

两种方案的对比 #

• 方案一：快速上手，代码改动小，适合简单场景；
• 方案二：更规范，扩展性更好，适合需要对响应做更多定制的项目。

不管选哪种，都能满足你「直观看到返回类型+控制HttpStatusCode」的需求～

内容的提问来源于stack exchange，提问作者Lollo