在Asp.net Core之前所有的Action回傳值都是ActionResult，Json(),File()等方法回傳的都是ActionResult的子類，并且Core把MVC跟WebApi合并之后Action的回傳值體系也有了很大的變化，
ActionResult類
ActionResult類是最常用的回傳值型別，基本沿用了之前Asp.net MVC的那套東西，使用它大部分情況都沒問題，比如用它來回傳視圖，回傳json，回傳檔案等等，如果是異步則使用Task，
public class TestController : Controller
{
public ActionResult Index()
{
return View();
}
public ActionResult MyFile()
{
return File(new byte[] { }, "image/jpg");
}
public ActionResult MyJson()
{
return Json(new { name = "json" });
}
public ActionResult Ok()
{
return Ok();
}
}
IActionResult介面
ActionResult類實作了IActionResult介面所以能用ActionResult的地方都可以使用IActionResult來替換，同樣異步的話使用Task包起來做為回傳值，
public class ITestController : Controller
{
public IActionResult Index()
{
return View();
}
public IActionResult MyFile()
{
return File(new byte[] { }, "image/jpg");
}
public IActionResult MyJson()
{
return Json(new { name = "json" });
}
public IActionResult HttpOk()
{
return Ok();
}
public async Task<IActionResult> AsyncCall()
{
await Task.Delay(1000);
return Content("ok");
}
}
直接回傳POCO類
Asp.net Core的Controller的Action可以把POCO型別(其實不一定是POCO類，可以是任意型別，但是使用的時候一般都回傳viwemodel等POCO類)當做回傳值，不一定非要是ActionResult或者IActionResult，Asp.net Core框架會幫我們自動序列化回傳給前端，默認使用json序列化，同樣異步的話使用Task包起來做為回傳值，
public class Person
{
public string Name { get; set; }
public string Sex { get; set; }
}
public class ITestController : Controller
{
public Person GetPerson()
{
return new Person { Name = "abc", Sex = "f" };
}
public async Task<List<Person>> GetPersons()
{
await Task.Delay(1000);
return new List<Person> {
new Person { Name = "abc", Sex = "f" },
new Person { Name = "efg", Sex = "m" }
};
}
}
ActionResult< T >泛型類
當我們設計restful webapi系統的時候習慣使用POCO做為回傳值，比如我們設計一個獲取Person的api，通過 /person/001 url獲取001號person，
[Route("[controller]")]
public class PersonController : Controller
{
IPersonRepository _repository;
PersonController(IPersonRepository repository)
{
_repository = repository;
}
[HttpGet("{id}")]
public Person Get(string id)
{
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}")]
public Person Get(string id)
{
var person = _repository.Get(id);
if (person == null)
{
Response.StatusCode = 404;
}
return person;
}
現在如果查找不到person資料，則系統會回傳404 Not Found ，
但是這看起來顯然不夠優雅，因為ControllerBase內置了NotFoundResult NotFound() 方法，這使用這個方法代碼看起來更加清晰明了，繼續改：
[HttpGet("{id}")]
public Person Get(string id)
{
var person = _repository.Get(id);
if (person == null)
{
return NotFound();
}
return person;
}
很不幸，這段代碼VS會提示錯誤，因為回傳值型別不一致，方法簽名的回傳值是Person，但是方法內部一會回傳NotFoundResult，一會回傳Person，
解決這個問題就該ActionResult< T >出場了，我們繼續改一下：
[HttpGet("{id}")]
public ActionResult<Person> Get(string id)
{
var person = _repository.Get(id);
if (person == null)
{
return NotFound();
}
return person;
}
現在VS已經不會報錯了，運行一下也可以正常作業，但仔細想想也很奇怪，為什么回傳值型別改成了ActionResult< Person >就不報錯了呢？明明回傳值型別跟方法簽名還是不一致啊？
深入ActionResult< T >
接上面的問題，讓我們看一下ActionResult的內部：
看到這里就明白了原來ActionResult< T >里面內置了2個implicit operator方法，implicit operator用于宣告隱式型別轉換，
public static implicit operator ActionResult<TValue>(ActionResult result);
表示ActionResult型別可以轉換為ActionResult< TValue >型別，
public static implicit operator ActionResult<TValue>(TValue value)
表示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個隱式轉換的方法
關注我的公眾號一起玩轉技術
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/42912.html
標籤：.NET Core