ASP.NET Core MVC 中的 [Controller] 和 [NonController]

前言

我们知道，在 MVC 应用程序中，有一部分约定的内容。其中关于 Controller 的约定是这样的。

• 每个 Controller 类的名字以 Controller 结尾，并且放置在 Controllers 目录中。
• Controller 使用的视图是在 Views 主目录的一个子目录中，这个子目录是根据控制器名称（后面减去Controller后缀）来命名的。

明白了以上约定之后，就来一起看看下面吧。

Controller VS NonController 中内置的约定

在 ASP.NET Core MVC 中已经统一了 MVC 和 Web Api 及 Web Pages， 他们具有相同的 Controller ，并且在 RC2 之后的版本中，ASP.NET Core MVC 支持了 POCO Controller，所以你在做一个 Web Api 的 Controller 的时候不需要再继承自 Controller 基类。

POCO Controller 即 public 的，非抽象的，没有任何继承，不实现任何接口的 Controller 类，类似于 POCO Class，仅仅是以 Controller 结尾而已。

到这里，有些同学可能会问了，在 POCO Controller 中如果我想获取 HTTP 上下文的一些东西应该怎么获取呢？ 嗯？。。。 这确实是个问题。。。。怎么办呢？ 老实的继承基类 Controller 吧，因为 Vnext 中的 POCO Controller 属性注入已经被取消了。

如果你创建了一个 POCO Controller ，那么他们的名字必须以 Controller 结尾，只有这样他们才是一个有效的 Controller，不然的话，MVC 不会认为你这是一个 Controller 对象。即使你具有 Route 之类的标记也不可以。

所以，在创建一个 MVC Controller 的时候，就有两个先决条件:

• -- 继承自 Controller 基类
• -- 或者使用一个以 Controller 结尾的名字

下面是创建两种 Controller 的一个 Web Api Controller示例：

[Route("api/[controller]")]
public class FooController : Controller
{
    [HttpGet]
    public string Get()
    {
        return "foo";
    }
}
 
[Route("api/[controller]")]
public class BarController
{
    [HttpGet]
    public string Get()
    {
        return "bar";
    }
}

现在有同学可能会问了，第一个既然已经继承了 Controller 基类，再在定义 Controller 的时候还要加 Controller 后缀不是多此一举么？这样写可不可以呢？

[Route("api/[controller]")]
public class Foo : Controller
{
    [HttpGet]
    public string Get()
    {
        return "foo";
    }
}

好吧，这样子也是正确的。为什么呢？这是因为继承的基类 Controller 已经被打上了 ControllerAttribute 的标记，打上了这个标记之后，在构建扫描的时候就会被认为是一个 Controller，也就是说整个继承树已经被认为是一个有效的 MVC Controller 了。

那么，有同学又问了，这样可不可以呢？

[Route("api/[controller]")]
public class Bar
{
    [HttpGet]
    public string Get()
    {
        return "bar";
    }
}

这样子是不行的，因为这是一个 POCO Controller，没有任何标记使 MVC 框架会认为这是一个有效的Controller，这个时候，如果 如果想让框架认为这是一个有效的 Controller，可以通过添加 ControllerAttribute 的方式：

[Controller]
[Route("api/[controller]")]
public class Bar
{
    [HttpGet]
    public string Get()
    {
        return "bar";
    }
}

这个时候，MVC 框架就会认为这是个有效的 Controller 了。

同样的，这样的代码也是有效的，因为基类已经有了 ControllerAttribute 标记 ：

[Controller]
public class ApiBase {}
 
[Route("api/[controller]")]
public class Bar : ApiBase
{
    [HttpGet]
    public string Get()
    {
        return "bar";
    }
}

还有一种可能性，就是当你有一个类，它恰好是以 Controller 结尾，但是实际上并不是一个 Controller 类怎么办呢？ 这个时候，你就需要添加一个 NonControllerAttribute 标记，来声明当前的类并不是一个 MVC 的 Controller 类，从而避免在构建的时候，框架会认错。

[NonController]
public class DemoController
{
    // 非 action 代码
}

有一点需要注意的是，NonControllerAttribute 标记比 ControllerAttribute 具有更高的优先级，所以当一个 Controller 同时具有这两个标记的时候，会以 NonControllerAttribute 为准。

实际上，只要是整个 Controller 继承树中有一个 Controller 被标记为 NonControllerAttribute 的时候，整个继承树的 Controller 均会被认为是无效的 Controller 了。

---

本文地址：http://www.cnblogs.com/savorboard/p/dontnet-controller.html
作者博客：Savorboard
欢迎转载，请在明显位置给出出处及链接