ASP.NET Core中的Action的返回值類型

在Asp.net Core之前所有的Action返回值都是ActionResult，Json(),File()等方法返回的都是ActionResult的子類。並且Core把MVC跟WebApi合併之後Action的返回值體系也有了很大的變化。

ActionResult類

ActionResult類是最常用的返回值類型。基本沿用了之前Asp.net MVC的那套東西，使用它大部分情況都沒問題。比如用它來返回視圖，返回json，返回文件等等。如果是異步則使用Task。

<code>    
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();
        }
    }
/<code>

IActionResult接口

ActionResult類實現了IActionResult接口所以能用ActionResult的地方都可以使用IActionResult來替換。同樣異步的話使用Task包起來做為返回值。

<code>   
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 
AsyncCall
(
)

        {
            
await
 Task.Delay( 
1000
);

            
return
 Content(
"ok"
);
        }
    }
/<code>

直接返回POCO類

Asp.net Core的Controller的Action可以把POCO類型(其實不一定是POCO類，可以是任意類型，但是使用的時候一般都返回viwemodel等POCO類)當做返回值，不一定非要是ActionResult或者IActionResult。Asp.net Core框架會幫我們自動序列化返回給前端，默認使用json序列化。同樣異步的話使用Task包起來做為返回值。

<code>   
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> GetPersons()
        {
            
await
 Task.Delay(
1000
);

            
return
 
new
 List {
            
new
 Person { Name = 
"abc"
, Sex = 
"f"
 },
            
new
 Person { Name = 
"efg"
, Sex = 
"m"
 }
            };
        }
    }
/<code>

ActionResult< T >泛型類

當我們設計restful webapi系統的時候習慣使用POCO做為返回值。比如我們設計一個獲取Person的api。通過 /person/001 url獲取001號person。

<code>    [ ]
    
public
 
class
 
PersonController
 : 
Controller
    {
        IPersonRepository _repository;
        PersonController(IPersonRepository repository) 
        {
            _repository = repository;
        }

        [ ]
       
public
 Person 
Get
(
string
 id
)

        {
            
return
 _repository.Get(id);
        }
    }
/<code>

這個方法看起來好像沒什麼問題，但其實有個小問題。如果repository.Get方法沒有根據id查找到數據，那麼將會返回null。如果null做為Action的返回值，最後框架會轉換為204的http status code。

204表示No Content 。做為restful api，204的語義在這裡會有問題，這裡比較適合的status code是404 NOT FOUND 。那麼我們來改一下：

<code>        [ ]
       
public
 Person 
Get
(
string
 id
)

        {
            
var
 person = _repository.Get(id);
            
if
 (person == 
null
)
            {
                Response.StatusCode = 
404
;
            }

            
return
 person;
        }
/<code>

現在如果查找不到person數據，則系統會返回404 Not Found 。

但是這看起來顯然不夠優雅，因為ControllerBase內置了NotFoundResult NotFound() 方法。這使用這個方法代碼看起來更加清晰明瞭。繼續改：

<code>        [ ]
       
public
 Person 
Get
(
string
 id
)

        {
            
var
 person = _repository.Get(id);
            
if
 (person == 
null
)
            {
                
return
 NotFound();
            }
            
return
 person;
        }
/<code>

很不幸，這段代碼VS會提示錯誤。因為返回值類型不一致。方法簽名的返回值是Person，但是方法內部一會返回NotFoundResult，一會返回Person。

解決這個問題就該ActionResult< T >出場了。我們繼續改一下：

<code>        [ ]
       
public
 ActionResult 
Get
(
string
 id
)

        {
            
var
 person = _repository.Get(id);
            
if
 (person == 
null
)
            {
                
return
 NotFound();
            }

            
return
 person;
        }
/<code>

現在VS已經不會報錯了，運行一下也可以正常工作。但仔細想想也很奇怪，為什麼返回值類型改成了ActionResult< Person >就不報錯了呢？明明返回值類型跟方法簽名還是不一致啊？

深入ActionResult< T >

接上面的問題，讓我們看一下ActionResult的內部：

看到這裡就明白了原來ActionResult< T >裡面內置了2個implicit operator方法。implicit operator用於聲明隱式類型轉換。

<code>
public
 
static
 
implicit
 
operator
 ActionResult(ActionResult result); 
/<code>

表示ActionResult類型可以轉換為ActionResult< TValue >類型。

<code>
public
 
static
 
implicit
 
operator
 ActionResult(TValue 
value
)
/<code>

表示TValue類型可以轉換為ActionResult< TValue >類型。

因為有了這2個方法，當ActionResult或者TValue類型往ActionResult< T >賦值的時候會進行一次自動的類型轉換。所以VS這裡不會報錯。

總結

1. 大部分時候Action的返回值可以使用ActionResult/IActionResult
2. 設計restful api的時候可以直接使用POCO類作為返回值
3. 如果要設計既支持POCO類返回值或者ActionResult類為返回值的action可以使用ActionResult
   < T >作為返回值
4. ActionResult< T >之所以能夠支持兩種類型的返回值類型，是因為使用了implicit operator內置了2個隱式轉換的方法