ASP.NET API请求失败时返回Unauthorized或错误码而非Null的实现方案咨询

在你的场景里，返回null确实无法区分请求本身失败（比如未授权、服务不可用）和查询结果为空（没有符合条件的任务）这两种情况。下面给你几个实用的实现方案，你可以根据API的设计风格选择：

方案1：抛出特定异常，利用ASP.NET框架自动映射HTTP状态码 #

ASP.NET（尤其是Core版本）自带异常处理机制，可以将特定异常自动转换为对应的HTTP状态码。这种方式不需要修改方法的返回类型，只需要在请求失败时抛出合适的异常即可。

修改后的代码示例： #

public async Task<IEnumerable<TasksValue>> GetTasks(string userName, string password)
{
    var currentUser = await GetCurrentUserInfo(userName, password);
    string currentUserId = currentUser.Id.ToString();
    var credentials = new NetworkCredential(userName, password, domainName);
    var handler = new HttpClientHandler { Credentials = credentials };
    
    using (var http = new HttpClient(handler))
    {
        var mediaType = new MediaTypeWithQualityHeaderValue("application/json");
        mediaType.Parameters.Add(new NameValueHeaderValue("odata", "nometadata"));
        http.DefaultRequestHeaders.Accept.Add(mediaType);
        
        HttpResponseMessage response = await http.GetAsync(
            string.Format(Constants.TaskByUserID, siteUrl, currentUserId)
        ).ConfigureAwait(false);

        // 根据响应状态码抛出对应异常
        if (!response.IsSuccessStatusCode)
        {
            if (response.StatusCode == HttpStatusCode.Unauthorized)
            {
                // 未授权场景，抛出该异常会被框架转为401状态码
                throw new UnauthorizedAccessException("用户名或密码无效，或无访问权限");
            }
            // 其他错误场景，比如404、500等，可以抛出HttpRequestException
            throw new HttpRequestException(
                $"请求远程服务失败，状态码：{(int)response.StatusCode}",
                null,
                response.StatusCode
            );
        }

        string jsonData = await response.Content.ReadAsStringAsync();
        var result = JsonConvert.DeserializeObject<Tasks>(jsonData);
        // 无数据时返回空集合，而非null，这样前端可以区分"无数据"和"请求失败"
        var finalResult = result.Value?.Where(x => x.Status == "Open").ToList() ?? new List<TasksValue>();
        return finalResult;
    }
}

补充说明： #

• 你需要确保项目中配置了异常处理中间件（ASP.NET Core默认已经包含），它会自动将UnauthorizedAccessException转为401 Unauthorized，HttpRequestException会根据传入的状态码返回对应HTTP状态。
• 无数据场景返回空集合而非null，这样前端收到200 OK但数据为空数组，就能明确是没有符合条件的任务，而非请求失败。

方案2：修改方法返回类型为IActionResult（适合控制器方法） #

如果这个方法是控制器中的Action，最直接的方式是将返回类型改为IActionResult，这样可以直接返回对应的HTTP状态码结果，灵活性更高。

修改后的代码示例： #

public async Task<IActionResult> GetTasks(string userName, string password)
{
    var currentUser = await GetCurrentUserInfo(userName, password);
    string currentUserId = currentUser.Id.ToString();
    var credentials = new NetworkCredential(userName, password, domainName);
    var handler = new HttpClientHandler { Credentials = credentials };
    
    using (var http = new HttpClient(handler))
    {
        var mediaType = new MediaTypeWithQualityHeaderValue("application/json");
        mediaType.Parameters.Add(new NameValueHeaderValue("odata", "nometadata"));
        http.DefaultRequestHeaders.Accept.Add(mediaType);
        
        HttpResponseMessage response = await http.GetAsync(
            string.Format(Constants.TaskByUserID, siteUrl, currentUserId)
        ).ConfigureAwait(false);

        if (!response.IsSuccessStatusCode)
        {
            if (response.StatusCode == HttpStatusCode.Unauthorized)
            {
                return Unauthorized("用户名或密码无效，或无访问权限");
            }
            // 其他错误可以返回对应的结果，比如BadRequest、StatusCode等
            return StatusCode((int)response.StatusCode, $"请求失败：{response.ReasonPhrase}");
        }

        string jsonData = await response.Content.ReadAsStringAsync();
        var result = JsonConvert.DeserializeObject<Tasks>(jsonData);
        var finalResult = result.Value?.Where(x => x.Status == "Open").ToList() ?? new List<TasksValue>();
        // 返回200 OK和数据，即使是空集合
        return Ok(finalResult);
    }
}

补充说明： #

• 这种方式可以精准控制每个场景的返回结果，比如未授权返回401，服务端错误返回500，无数据返回200 OK加空数组，完全区分不同场景。
• 适合直接暴露给前端的控制器Action，语义清晰，符合RESTful API的设计规范。

方案3：返回自定义统一响应模型 #

如果你的API需要统一的响应格式（比如所有接口都返回包含状态码、消息、数据的结构），可以定义一个通用的响应模型，通过模型中的状态字段来区分场景。

第一步：定义统一响应模型 #

public class ApiResponse<T>
{
    public int StatusCode { get; set; }
    public string Message { get; set; }
    public T Data { get; set; }

    public ApiResponse(int statusCode, string message, T data)
    {
        StatusCode = statusCode;
        Message = message;
        Data = data;
    }

    // 快捷方法：成功响应
    public static ApiResponse<T> Success(T data, string message = "请求成功")
    {
        return new ApiResponse<T>(200, message, data);
    }

    // 快捷方法：未授权响应
    public static ApiResponse<T> Unauthorized(string message = "未授权访问")
    {
        return new ApiResponse<T>(401, message, default);
    }

    // 其他错误场景的快捷方法可以按需添加
}

第二步：修改方法返回类型并实现逻辑 #

public async Task<ApiResponse<IEnumerable<TasksValue>>> GetTasks(string userName, string password)
{
    var currentUser = await GetCurrentUserInfo(userName, password);
    string currentUserId = currentUser.Id.ToString();
    var credentials = new NetworkCredential(userName, password, domainName);
    var handler = new HttpClientHandler { Credentials = credentials };
    
    using (var http = new HttpClient(handler))
    {
        var mediaType = new MediaTypeWithQualityHeaderValue("application/json");
        mediaType.Parameters.Add(new NameValueHeaderValue("odata", "nometadata"));
        http.DefaultRequestHeaders.Accept.Add(mediaType);
        
        HttpResponseMessage response = await http.GetAsync(
            string.Format(Constants.TaskByUserID, siteUrl, currentUserId)
        ).ConfigureAwait(false);

        if (!response.IsSuccessStatusCode)
        {
            if (response.StatusCode == HttpStatusCode.Unauthorized)
            {
                return ApiResponse<IEnumerable<TasksValue>>.Unauthorized("用户名或密码无效，或无访问权限");
            }
            return new ApiResponse<IEnumerable<TasksValue>>(
                (int)response.StatusCode,
                $"请求失败：{response.ReasonPhrase}",
                null
            );
        }

        string jsonData = await response.Content.ReadAsStringAsync();
        var result = JsonConvert.DeserializeObject<Tasks>(jsonData);
        var finalResult = result.Value?.Where(x => x.Status == "Open").ToList() ?? new List<TasksValue>();
        return ApiResponse<IEnumerable<TasksValue>>.Success(finalResult);
    }
}

补充说明： #

• 这种方式适合需要统一响应格式的API，前端可以通过StatusCode字段快速判断请求状态，Data字段存放业务数据，空数据时Data是空集合而非null。
• 便于前端统一处理所有接口的响应逻辑，减少重复代码。

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