在asp.net Core之前所有的Action返回值都是ActionResult，Json(),File()等方法返回的都是Action Result的子類。并且Core把MVC跟WebApi合并之后Action的返回值體系也有了很大的變化。
ActionResult類
ActionResult類是最常用的返回值類型。基本沿用了之前Asp.net MVC的那套東西，使用它大部分情況都沒問題。比如用它來返回視圖，返回json，返回文件等等。如果是異步則使用Task。
publicclassTestController:Controller
{
publicActionResultIndex()
{
returnView();
}
publicActionResultMyFile()
{
returnFile(newbyte[]{},"image/jpg");
}
publicActionResultMyJson()
{
returnJson(new{name="json"});
}
publicActionResultOk()
{
returnOk();
}
}
IActionResult接口
ActionResult類實現了IActionResult接口所以能用ActionResult的地方都可以使用IActionResult來替換。同樣異步的話使用Task包起來做為返回值。
publicclassITestController:Controller
{
publicIActionResultIndex()
{
returnView();
}
publicIActionResultMyFile()
{
returnFile(newbyte[]{},"image/jpg");
}
publicIActionResultMyJson()
{
returnJson(new{name="json"});
}
publicIActionResultHttpOk()
{
returnOk();
}
publicasyncTask
{
awaitTask.Delay(1000);
returnContent("ok");
}
}
直接返回POCO類
Asp.net Core的Controller的Action可以把POCO類型(其實不一定是POCO類，可以是任意類型，但是使用的時候一般都返回viwemodel等POCO類)當做返回值，不一定非要是ActionResult或者IActionResult。Asp.net Core框架會幫我們自動序列化返回給前端，默認使用json序列化。同樣異步的話使用Task包起來做為返回值。
publicclassPerson
{
publicstringName{get;set;}
publicstringSex{get;set;}
}
publicclassITestController:Controller
{
publicPersonGetPerson()
{
returnnewPerson{Name="abc",Sex="f"};
}
publicasyncTask
{
awaitTask.Delay(1000);
returnnewList
newPerson{Name="abc",Sex="f"},
newPerson{Name="efg",Sex="m"}
};
}
}
ActionResult< T >泛型類
當我們設計restful webapi系統的時候習慣使用POCO做為返回值。比如我們設計一個獲取Person的api。通過 /person/001 url獲取001號person。
[Route("[controller]")]
publicclassPersonController:Controller
{
IPersonRepository_repository;
PersonController(IPersonRepositoryrepository)
{
_repository=repository;
}
[HttpGet("{id}")]
publicPersonGet(stringid)
{
return_repository.Get(id);
}
}
這個方法看起來好像沒什么問題，但其實有個小問題。如果repository.Get方法沒有根據id查找到數據，那么將會返回null。如果null做為Action的返回值，最后框架會轉換為204的http status code。
204表示No Content 。做為restful api，204的語義在這里會有問題，這里比較適合的status code是404 NOT FOUND 。那么我們來改一下：
[HttpGet("{id}")]
publicPersonGet(stringid)
{
varperson=_repository.Get(id);
if(person==null)
{
Response.StatusCode=404;
}
returnperson;
}
現在如果查找不到person數據，則系統會返回404 Not Found 。
但是這看起來顯然不夠優雅，因為ControllerBase內置了NotFoundResult NotFound() 方法。這使用這個方法代碼看起來更加清晰明了。繼續改：
[HttpGet("{id}")]
publicPersonGet(stringid)
{
varperson=_repository.Get(id);
if(person==null)
{
returnNotFound();
}
returnperson;
}
很不幸，這段代碼VS會提示錯誤。因為返回值類型不一致。方法簽名的返回值是Person，但是方法內部一會返回NotFoundResult，一會返回Person。
解決這個問題就該ActionResult< T >出場了。我們繼續改一下：
[HttpGet("{id}")]
publicActionResult
{
varperson=_repository.Get(id);
if(person==null)
{
returnNotFound();
}
returnperson;
}
現在VS已經不會報錯了，運行一下也可以正常工作。但仔細想想也很奇怪，為什么返回值類型改成了ActionResult< Person >就不報錯了呢?明明返回值類型跟方法簽名還是不一致啊?
深入ActionResult< T >
接上面的問題，讓我們看一下ActionResult的內部：
看到這里就明白了原來ActionResult< T >里面內置了2個implicit operator方法。implicit operator用于聲明隱式類型轉換。
publicstaticimplicitoperatorActionResult
表示ActionResult類型可以轉換為ActionResult< TValue >類型。
publicstaticimplicitoperatorActionResult
表示TValue類型可以轉換為ActionResult< TValue >類型。
因為有了這2個方法，當ActionResult或者TValue類型往ActionResult< T >賦值的時候會進行一次自動的類型轉換。所以VS這里不會報錯。
總結
大部分時候Action的返回值可以使用ActionResult/IActionResult
設計restful api的時候可以直接使用POCO類作為返回值
如果要設計既支持POCO類返回值或者ActionResult類為返回值的action可以使用ActionResult< T >作為返回值
ActionResult< T >之所以能夠支持兩種類型的返回值類型，是因為使用了implicit operator內置了2個隱式轉換的方法
到此這篇關于ASP.NET Core中的Action的返回值類型實現的文章就介紹到這了,更多相關ASP.NET Core Action的返回值類型內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家!
原文鏈接：https://www.cnblogs.com/kklldog/p/aspnetcore-actionresult.html
