具有多個路由級別的webapi的乾式方法

Question

當我們有多個所需級別的每個方法的路由時，是否有一種方法可以簡化？

我有一個假想的WebAPI項目，我用這個問題的一般看看。它給我們來自某些來源的電影。

public class MovieController : ApiController 
{ 
    // GET api/<controller> 
    public IEnumerable<Movie> Get() 
    { 
     return MoviesDB.All(); 
    } 

    // GET api/<controller>/5 
    public Movie Get(int id) 
    { 
     return MoviesDB.ThisSpecificOne(id); 
    } 

    // POST api/<controller> 
    public void Post([FromBody]Movie value) 
    { 
    } 

    // PUT api/<controller>/5 
    public void Put(int id, [FromBody]Movie value) 
    { 
    } 

    // DELETE api/<controller>/5 
    public void Delete(int id) 
    { 
    } 
} 

但讓我們說一些愚蠢的原因電影存儲的流派。所以你需要流派+編號組合。

我假設這是你會怎麼做

config.Routes.MapHttpRoute(
    name: "MoviesWithGenre", 
    routeTemplate: "api/{controller}/{genre}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
); 

public class MovieController : ApiController 
{ 
    // GET api/<controller>/<genre> 
    public IEnumerable<Movie> Get(string genre) 
    { 
     return MoviesDB.All(genre); 
    } 

    // GET api/<controller>/<genre>/5 
    public Movie Get((string genre, int id) 
    { 
     return MoviesDB.ThisSpecificOne(string genre, id); 
    } 

    // POST api/<controller>/<genre> 
    public void Post(string genre, [FromBody]Movie value) 
    { 
    } 

    // PUT api/<controller>/<genre>/5 
    public void Put(string genre, int id, [FromBody]Movie value) 
    { 
    } 

    // DELETE api/<controller>/<genre>/5 
    public void Delete(string genre, int id) 
    { 
    } 
} 

所以現在MySite.Com/api/movie/horror/12345可能會返回一個電影，但我需要添加可選參數的每個方法。現在我發現它們也是按年存儲的。

config.Routes.MapHttpRoute(
    name: "MoviesWithGenreAndYear", 
    routeTemplate: "api/{controller}/{genre}/{year}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
); 

public class MovieController : ApiController 
{ 
    // GET api/<controller>/<genre>/<year> 
    public IEnumerable<Movie> Get(string genre, int year) 
    { 
     return MoviesDB.All(string genre, int year); 
    } 

    // GET api/<controller>/<genre>/<year>/5 
    public Movie Get(string genre, int year, int id) 
    { 
     return MoviesDB.ThisSpecificOne(string genre, int year, id); 
    } 

    // POST api/<controller>/<genre>/<year> 
    public void Post(string genre, int year, [FromBody]Movie value) 
    { 
    } 

    // PUT api/<controller>/<genre>/<year>/5 
    public void Put(string genre, int year, int id, [FromBody]Movie value) 
    { 
    } 

    // DELETE api/<controller>/<genre>/<year>/5 
    public void Delete(string genre, int year, int id) 
    { 
    } 
} 

這一切都可以正常工作，但是每個新層都需要爲每個方法添加一個新參數。這不覺得很DRY

我可以注入這些層到構造函數而不是方法本身。

也許我想根據這些圖層對控制器進行不同的初始化，所以我會根據流派和/或年份或類似情況設置不同的回購。

有沒有解決方案呢？

Answer 1

您是否考慮過使用OData？ Web Api支持OData烘焙，您可以將查詢編寫爲網址：例如？$ filter =類型eq'恐怖'。如果由於某種原因你，不想作爲OData的數據返回，但想的OData的查詢語法，那麼你可以：

1. 使用Linq To QueryString：此LIB給你一個擴展方法IQueryable的那解析查詢字符串和查詢適用於任何的IQueryable

2. 變換ODataQueryOptions成一個查詢到你的數據庫（見this MSDN article該轉換查詢到HQL爲例）

Answer 2

是移動日e可選參數到查詢字符串中一個可行的選項？

例如GET api/movie?genre=horror&year=2014

這將簡化您的路線，控制器：

config.Routes.MapHttpRoute(
    name: "Movies", 
    routeTemplate: "api/{controller}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
); 

public class MovieController : ApiController 
{ 
    // GET api/<controller>?genre=<genre>&year=<year> 
    public IEnumerable<Movie> Get(string genre = null, int? year = null) 
    { 
     return MoviesDB.All(string genre, int year); 
    } 

    // GET api/<controller>/5?genre=<genre>&year=<year> 
    public Movie Get(int id, string genre = null, int? year = null) 
    { 
     return MoviesDB.ThisSpecificOne(string genre, int year, id); 
    } 

    // POST api/<controller>?genre=<genre>&year=<year> 
    public void Post([FromBody]Movie value, string genre = null, int? year = null) 
    { 
    } 

    // PUT api/<controller>/5?genre=<genre>&year=<year> 
    public void Put(int id, [FromBody]Movie value, string genre = null, int? year = null) 
    { 
    } 

    // DELETE api/<controller>/5?genre=<genre>&year=<year> 
    public void Delete(int id, string genre = null, int? year = null) 
    { 
    } 
} 

Answer 3

如果你真的是按流派和年份存儲的電影，那麼我相信你不會這麼幹的解決方案實際上是正確的。這讓我質疑構建這樣的多部分標識符的目的，例如在你的例子中使用的電影，肯定年和流派只是關於電影的元信息，而不是標識符的一部分。更一般地說，我真的會爭論一個超過兩個或至少超過三個部分的複合標識符是否適合任何軟件的和平。代理鍵可以緩解這種情況下的發展困境。

還討論您的關注對幹：重複的湖，我認爲，作爲一個對象的主鍵結構很少改變，它不是一個真正的大問題。更重要的是，主鍵的改變將永遠是一個打破所有後向兼容性的改變。

爲噱頭，你可以創建一個包含複雜的ID作爲這樣一個新的類：

public class MovieId 
{ 
    public int Id { get; set; } 
    public int Yead { get; set; } 
    public string Genre { get; set; } 
} 

然後使控制器方法是這樣的：

public Movie Get([FromBody]MovieId id) 
    { 
     return MoviesDB.ThisSpecificOne(id); 
    } 

這個工程現在代碼完全符合DRY原則。問題是，複雜類型必須是一個主體參數，所以查詢字符串不會再漂亮和自我解釋了，你必須對路由進行創造性的區分不同的get方法。

移動到業務層或DDD層，這種組合鍵作爲值對象是一種非常常見的情況，由於查詢字符串在那裏沒有問題，所以它實際上是一個非常可行和推薦的解決方案。