ASP.NET Core中的Controller使用示例
ASP.NET CORE出現(xiàn)之前我們實(shí)現(xiàn)的Controller,MVC都繼承自Controller基類,WebApi的話繼承自ApiController?,F(xiàn)在ASP.NET CORE把MVC跟WebApi合并了,已經(jīng)不再區(qū)分MVC或者WebApi。ASP.NET CORE的Controller繼承結(jié)構(gòu)也發(fā)生了變化。我們看其他示例的時(shí)候會(huì)發(fā)現(xiàn)有些繼承自Controller有些繼承自ControllerBase。事實(shí)上ControllerBase是Controller的基類。也就是說如果你繼承自Controller,其實(shí)就是繼承了ControllerBase。那什么時(shí)候該選擇直接繼承ControllerBase呢?
ControllerBase
我們先看看ControllerBase的元數(shù)據(jù):

很長并沒有截全。可以看到ControllerBase是個(gè)抽象類,并且實(shí)現(xiàn)了大量的虛方法。這些虛方法大都是對(duì)應(yīng)了Http的狀態(tài)碼。
比如:
public virtual OkResult Ok(); //http status 200 public virtual NotFoundResult NotFound(); //http status 404 public virtual ForbidResult Forbid(); //http status 403 public virtual CreatedResult Created(Uri uri, [ActionResultObjectValue] object value); // http status 201 ...還有很多很多...
顯然這是為Restful Api設(shè)計(jì)的基類,所以當(dāng)你要設(shè)計(jì)一個(gè)Restful(web api)接口的時(shí)候可以選擇繼承自ControllerBase,它已經(jīng)可以滿足你的需求。
Controller
查看下Controller的元數(shù)據(jù):

Controller也是一個(gè)抽象類,繼承自ControllerBase,并且繼承了幾個(gè)接口。很明顯Controller比ControllerBase多的內(nèi)容主要是一些跟MVC打交道的東西。
比如:Viewbag、Viewdata屬性,Json、View方法等:
public dynamic ViewBag { get; }
public ViewDataDictionary ViewData { get; set; }
public virtual JsonResult Json(object data);
public virtual ViewResult View();
...
所以如果你是需要實(shí)現(xiàn)一個(gè)MVC系統(tǒng),想要使用cshtml模板跟razor試圖引擎渲染頁面則需要繼承Controller。
POCO Controller
除了繼承Controller、ControllerBase之外,ASP.NET CORE框架可以讓你的POCO類直接變成Controller。
使用“Controller”后綴
下面的代碼,TestController可以正常工作嗎?
[Route("api/[controller]")]
public class TestController
{
[HttpGet]
public string Get()
{
return "TestController";
}
}
運(yùn)行一下:

雖然TestController類并沒有繼承自任何類,但是他確實(shí)可以在ASP.NET CORE框架內(nèi)正常工作。ASP.NET CORE框架默認(rèn)會(huì)查找后綴為“Controller”的類,并把它當(dāng)做真正的Controller使用,在路由系統(tǒng)最終匹配Controller的時(shí)候它也會(huì)被嘗試匹配。
使用ControllerAttribute
如果你的控制器類有什么特別需求,連類名都不想加入“Controller”的后綴,那么還有一種方法就是使用ControllerAttribute。
[Controller]
[Route("api/[controller]")]
public class POCO
{
[HttpGet]
public string Get()
{
return "POCOController";
}
}
運(yùn)行一下:

POCO類并沒有繼承自任何類,并且也沒有“Controller”后綴命名,但是因?yàn)樗粯?biāo)記了ControllerAttribute同樣會(huì)被ASP.NET CORE框架認(rèn)為是一個(gè)Controller。在路由系統(tǒng)最終匹配Controller的時(shí)候它也會(huì)被嘗試匹配。
使用NonControllerAttribute
如果你的一個(gè)類名恰巧包含“Controller”的后綴,但你并不想ASP.NET CORE框架發(fā)現(xiàn)它,你可以在類上加上NonControllerAttribute。這樣ASP.NET CORE框架就會(huì)忽略它。
改一下剛才的TestController,加上[NonController]:
[NonController]
[Route("api/[controller]")]
public class TestController
{
[HttpGet]
public string Get()
{
return "TestController";
}
}
運(yùn)行一下:

/api/test已經(jīng)匹配不到controller了。
總結(jié)
- 設(shè)計(jì)restful(web api)接口的時(shí)候可以繼承ControllerBase
- 設(shè)計(jì)MVC系統(tǒng)的時(shí)候可以繼承Controller
- 當(dāng)一個(gè)POCO類名稱包含"Controller"后綴或添加ControllerAttribute的時(shí)候框架會(huì)認(rèn)為這是一個(gè)控制器
- 當(dāng)一個(gè)類不想被框架當(dāng)做控制器的時(shí)候可以添加NonControllerAttribute
到此這篇關(guān)于ASP.NET Core中的Controller使用示例的文章就介紹到這了,更多相關(guān)ASP.NET Core Controller內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
asp.net為網(wǎng)頁動(dòng)態(tài)添加description描述信息的方法
這篇文章主要介紹了asp.net為網(wǎng)頁動(dòng)態(tài)添加description描述信息的方法,涉及asp.net動(dòng)態(tài)操作網(wǎng)頁元素的相關(guān)技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-04-04
asp.net利用后臺(tái)實(shí)現(xiàn)直接生成html分頁的方法
這篇文章主要介紹了asp.net利用后臺(tái)實(shí)現(xiàn)直接生成html分頁的方法,比較簡潔實(shí)用,需要的朋友可以參考下2014-08-08
.NET Core中使用Redis與Memcached的序列化問題詳析
這篇文章主要介紹了.NET Core中使用Redis與Memcached的序列化問題的相關(guān)內(nèi)容,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧。2018-03-03
asp.net core web api項(xiàng)目添加自定義中間件的實(shí)現(xiàn)
ASP.NET Core Web API項(xiàng)目中可以通過自定義中間件來對(duì)請(qǐng)求進(jìn)行時(shí)間戳校驗(yàn),本文就來介紹一下項(xiàng)目添加自定義中間件的實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下2025-01-01

