C＃（Web API）多层（IOC）API控制器返回类型

Question

我正在构建一个ASP Web API应用程序，这次我想我将使用MVC模式。我和大部分东西相处得很好，但有一件事我不确定。首先我所有的项目包括以下内容：

• 数据层
• 业务层
• 模型层（只是模型的属性）

• 服务应用（在这里是我的控制器）

  每个人都在一个单独的项目中

可以说我有以下控制器

public class TestController : ApiController 
{ 
    ISomeService _someBusiness; 

    public TestController(ISomeService someBusiness) 
    { 
     _someBusiness = someBusiness; 
    } 

    public **SomeModelObject** GetModelObject(ind id) 
    { 
     return _someBusiness .GetSomeModelObject(id); 
    } 

} 

现在我的问题是返回值为GetModelObject(int id)。这里写着SomeModelObject。这意味着我的Service应用程序（或我的控制器）必须知道正在使用的模型的所有内容（所以我没有看到在单独的.dll中定义它的要点）。一种方法是将模型（准确地说是get/set方法）定义为接口，但我认为每个模型类都有一个接口太多了（主要是因为，正如我所说的，只是属性被存储在模型中），尽管如此，我只是觉得不适合为只存储数据的类创建接口。那么，在这种情况下是否有任何通用响应类型（甚至是一些完全不同的方法），还是我必须使用我的模型类（或者我可能总是使用字符串，并且它正在被转换为适当的格式客户端） ？

Answer 1

使用接口来隐藏模型对象的复杂性有很好的理由。它保存数据，当然。但是它包含了仅对数据层有意义的不必要数据。以此EF型号：

public class Employee 
{ 
    public int Id { get; set; } 
    public string EmployeeNumber { get; set; } 
    public string Name { get; set; } 
    public virtual Collection<TimeCard> TimeCards { get; set; } 

    public int DepartmentId { get; set; } 
    public virtual Department Department { get; set; } 
} 

这是一个仙女常见的EF模型。它包含一个代理键Id和一个外键DepartmentId。这些值除了数据库和扩展后的实体框架之外毫无意义。 EmployeeNumber是唯一标识用户域中实体的自然键。

数据库访问之外，你应该只处理自然数据值。您可以通过在Business层中声明另一个携带数据的类并执行映射来做到这一点，或者更好的办法是使用一个接口来隐藏所有无用的成员。

public interface IEmployee 
{ 
    string EmployeeNumber { get; } 
    string Name { get; set; } 

    ICollection<ITimeCard> TimeCards { get; } 
    IDepartment Department { get; set; } 
} 

注意接口中缺少一些setter。您永远不会想要更改EmployeeNumber，因为这是实体的自然键。同样，您永远不会将收集对象分配给TimeCards属性。你只能迭代，添加或删除它们。

现在你的Employee类成为

public class Employee : IEmployee 
{ 
    public int Id { get; set; } 
    public string EmployeeNumber { get; set; } 
    public string Name { get; set; } 
    public virtual Collection<TimeCard> TimeCards { get; set; } 
    ICollection<ITimeCard> IEmployee.TimeCards { get { return TimeCards; } } 

    public int DepartmentId { get; set; } 
    public virtual Department Department { get; set; } 
    IDepartment IEmployee.Department { get { return Department; } set { Department = value; } } 
} 

在业务层及以上的，你只用IEmployee，IDepartment和ITimeCard的变量。因此，您将更紧密的API暴露给更高层，这是一件好事。

Answer 2

你可以尝试使用在控制器级别的通用方法：

public class BusinessController<T> : ApiController 
{ 
    ISomeService _someBusiness; 

    public TestController(ISomeService someBusiness) 
    { 
     _someBusiness = someBusiness; 
    } 

    public T GetModelObject(ind id) 
    { 
     return _someBusiness.GetSomeModelObject(id); 
    } 

} 

最后你controlers从BusinessController继承，而不是ApiController：

public class TestController : BusinessController<SomeModelObject> 
{ 
} 

你也可以把模板的提前注入通过使用IoC容器和引导程序来实现正确的“ISomeService”。