WebAPI中自定义ServiceResponse传递状态对象是否合理？求最优方案

我有C#基础，但刚接触WebAPI开发。之前给Angular前端返回数据用的是IActionResult，无内容返回StatusCodeResult，有内容返回ObjectResult。现在要做服务间调用，这种方式不好用，所以自定义了ServiceResponse类来传递带状态信息（HTTP状态码、状态消息）的可选内容：

public class ServiceResponse {
    private object? Content { get; set; }
    private Type? ContentType { get; set; }
    public string? StatusMessage { get; set; }
    public int StatusCode { get; set; }
    public bool IsSuccess => StatusCode >= 200 && StatusCode < 300;

    public ServiceResponse(int statusCode, string? statusMessage) {
        StatusMessage = statusMessage;
        StatusCode = statusCode;
    }

    public T? GetContent<T>() {
        if (Content is T content) {
            return content;
        }
        return default;
    }

    public void SetContent<T>(T content) {
        Content = content;
        ContentType = typeof(T);
    }
}

现在遇到的问题是没法明确返回内容类型，比如IUserService接口里的方法返回内容类型没法直观区分：

public interface IUserService {
    /// <returns>User? - user or null</returns>
    public ServiceResponse GetUser(int id);
    /// <returns>List<User> - list of users (may be empty)</returns>
    public ServiceResponse GetAllUsers();
    /// <returns>int - database id generated for the user</returns>
    public ServiceResponse CreateUser(User user);
    /// <returns>null - no content</returns>
    public ServiceResponse UpdateUser(User user);
    /// <returns>null - no content</returns>
    public ServiceResponse DeleteUser(int id);
}

想知道这个实现合理吗？是不是重复造轮子？怎么实现可区分且可选的返回内容类型（部分方法仅返回状态码无内容）？另外，泛型能不能实现可选类型？

1. 你的实现算不算重复造轮子？ #

算，.NET生态里已经有现成的成熟方案：

• ActionResult<T>：原本是为WebAPI控制器设计，但也完全能用于服务间调用，它既可以携带内容（比如Ok(user)），也能返回无内容状态（比如NoContent()），同时自带状态码、错误消息的处理能力。
• 社区还有专门的结果处理库，比如ErrorOr、MediatR的Result模式，都能满足「带状态信息+可选内容」的需求，稳定性和易用性都比自定义类强。

你的ServiceResponse本质是手动实现了一个非泛型的结果容器，虽然能用，但没必要重复造轮子，现成方案更省心，团队其他成员也更熟悉。

2. 怎么实现可区分的返回内容类型？ #

用**泛型版ServiceResponse<T>**就能解决，同时保留无内容的场景：

第一步：定义泛型基类和无内容版本 #

// 无内容的服务响应，适配Update、Delete这类无需返回数据的方法
public class ServiceResponse : ServiceResponse<object?>
{
    public ServiceResponse(int statusCode, string? statusMessage) 
        : base(statusCode, statusMessage, null)
    {
    }
}

// 带内容的泛型服务响应
public class ServiceResponse<T>
{
    public T? Content { get; }
    public string? StatusMessage { get; }
    public int StatusCode { get; }
    public bool IsSuccess => StatusCode >= 200 && StatusCode < 300;

    public ServiceResponse(int statusCode, string? statusMessage, T? content)
    {
        StatusCode = statusCode;
        StatusMessage = statusMessage;
        Content = content;
    }

    // 快捷创建成功响应的静态方法
    public static ServiceResponse<T> Success(T content, string? message = null)
    {
        return new ServiceResponse<T>(200, message, content);
    }

    public static ServiceResponse<T> Created(T content, string? message = null)
    {
        return new ServiceResponse<T>(201, message, content);
    }

    // 快捷创建无内容成功响应
    public static ServiceResponse NoContent(string? message = null)
    {
        return new ServiceResponse(204, message);
    }

    // 快捷创建错误响应的静态方法
    public static ServiceResponse<T> Error(int statusCode, string message)
    {
        return new ServiceResponse<T>(statusCode, message, default);
    }
}

第二步：修改IUserService接口，明确返回类型 #

public interface IUserService {
    // 明确返回带User?的响应
    public ServiceResponse<User?> GetUser(int id);
    // 明确返回带List<User>的响应
    public ServiceResponse<List<User>> GetAllUsers();
    // 明确返回带int的响应
    public ServiceResponse<int> CreateUser(User user);
    // 无内容用ServiceResponse
    public ServiceResponse UpdateUser(User user);
    // 无内容用ServiceResponse
    public ServiceResponse DeleteUser(int id);
}

这样接口的返回类型一目了然，调用方不用猜内容类型，也不需要手动做类型转换。

3. 泛型能不能实现可选类型？ #

当然可以，上面的泛型方案已经解决了这个问题：

• 对于需要返回内容的方法，用ServiceResponse<T>，T可以是任意类型，包括可空值类型（比如User?），明确表示内容可能为null。
• 对于不需要返回内容的方法，用非泛版的ServiceResponse，它本质是继承自ServiceResponse<object?>并将Content设为null，完美适配无内容场景。

4. 额外建议 #

如果是服务间调用，更推荐直接用.NET自带的ActionResult<T>，因为它和WebAPI生态完全兼容，不需要维护额外的自定义类。比如：

public interface IUserService {
    public Task<ActionResult<User?>> GetUser(int id);
    public Task<ActionResult<List<User>>> GetAllUsers();
    public Task<ActionResult<int>> CreateUser(User user);
    public Task<IActionResult> UpdateUser(User user);
    public Task<IActionResult> DeleteUser(int id);
}

服务实现里可以直接返回Ok(user)、NoContent()、BadRequest("错误消息")这类标准结果，调用方也能直接获取状态码和内容，非常便捷。

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