如何返回具有通用属性的 C# Web 服务？

Question

我正在创建一个 Web 服务，并且希望在返回数据方面更加优雅，而不是让消费者需要检查大量属性。

根据幕后生成的数据，我需要能够返回错误数据，或者消费者期望的数据。

我不想拥有一个大的平面对象，并在需要时填充属性并让用户检查“成功”标志，而是希望单个属性 Data 成为错误类的实例，或者一个成功类的实例。

这就是我想做的事情：

class ItemResponse
{
    public bool Success { get; set; }
    public T Data{ get; set; }
}

if( /*acceptance criteria*/ )
{
    ItemResponse<SuccessData> resp = new ItemResponse<SuccessData>();
    resp.Data = new SuccessData();
}
else
{
    ItemResponse<ErrorData> resp = new ItemResponse<ErrorData>();
    resp.Data = new ErrorData();
}

return resp;


public class SuccessData
{

}

public class ErrorData
{

}

然后让 web 方法返回具有通用属性的对象。

这可能吗？如果可以，鉴于必须正确输入 webmethod 返回类型，我该怎么做？

Answer 1

泛型是在编译时添加类型安全的工具。因此，类的使用者使用的具体类型必须在编译时知道。如果你创建一个函数

List<T> myFunction<T>() {...}

...那么你需要在调用时指定T，例如

var myResult = myFunction<int>();

...这使得在编译时知道具体类型。 （即使你没有指定T，因为它可以被推断出来，具体类型在编译时也是也知道的。）

但是，您希望在run-time 确定Data 的泛型类型：如果发生错误，则返回ItemResponse<SuccessData>，否则返回ItemResponse<ErrorData>。泛型不是这样工作的。

Answer 2

短版，你不能按照你的建议去做。

加长版 A部分：

可以将 Web 服务视为类的方法，实际上 是 Web 服务类的方法。我建议阅读一些 Web 服务教程，以便更好地掌握设置 Web 服务背后的机制。 MSDN 有许多特定于 Microsoft 堆栈的教程，可通过您最喜欢的搜索引擎轻松找到。

方法的返回对象不允许具有多态行为，这本质上是您所要求的。

此伪代码等同于您尝试创建的代码，这就是编译器不允许它的原因。它不知道哪个您正在尝试呼叫DoSomething()。

class myFoo
{
     public SuccessResponse DoSomething() {....}  
     public ErrorResponse DoSomething() {....}
}

或者，您可以设想这样的事情：
public [SuccessResponse | ErrorResponse] DoSomething()
但这也因显而易见的原因而失败。 C# 根本不支持多态返回。

B 部分 即使我们只关注resp.Data，该对象仍然必须声明为某种类型。

class Response
{
     public Collection<someType> Data;
}

如果您的SuccessData 和ErrorData 实现相同的接口，那么someType 可能只是IyourInterface，但这会引发另一个问题。也就是说，最终用户如何知道他们是否在Data 中获得了良好的数据，或者那里是否存在错误响应。

我相信，只要您将其声明为 WCF 服务对象的公共部分，WCF 就足以为您序列化 IyourInterface。但这仍然不能解决您的最终用户如何知道该做什么。

---

如果您愿意在响应中不那么优雅，经典模式是将成功数据和错误对象简单地捆绑到另一个响应类中，如下所示：

class myResponse
{
    public SuccessResponse myRespData;
    public ErrorResponse myError
}

现在，最终用户会检查是否存在错误，如果他们关心的话。假设没有错误，然后他们去查看响应数据。

---

根据您的评论，是的，您也可以执行以下操作：

class Response
{
    public List<IYourData> Data;
    public YourEnum ReturnType;
}

public class ResponseData : IYourData { ... }  
public class ErrorData : IYourData { ... }  

然后在客户端，你可以像这样执行一个简单的检查：

if( ReturnType == YourEnum.Success ) { ... }  
else if( ReturnType == YourEnum.Error ) { ... }  
else ... 

WCF 将为您处理List 的序列化。它将转换为数组或直接传递集合，具体取决于您的设置。有一些 SO Q&A 可以处理该特定方面。