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」。