添加控制器

作者 Rick Anderson

翻译 谢炀（Kiler)

Model-View-Controller (MVC) 架构模式将一个应用程序分离成三个主要的组件： M\odel、V\iew 以及 C\ontroller 。 MVC 模式帮助你创建可测试的应用程序，比传统的单块应用程序更加容易维护和更新。基于 MVC 的应用程序包含：

  • M\odels：应用程序中用来表示数据的类，并使用验证逻辑来执行该数据业务规则。通常，模型（Model）对象从数据库查询和存储 Model 状态。在本教程 Movie 模型（Model）从数据库查询电影数据用来显示或更新。更新后的数据写入 SQL Server 数据库。

  • V\iews：视图是显示用户界面（UI）的组件。通常，UI 用于显示模型（Model）数据。

  • C\ontrollers：一种类（Class），用于处理浏览器请求，查询模型（Model）数据，以及将指定视图模板作为响应返回给浏览器。在 MVC 应用程序中，视图（View）仅仅显示信息； 控制器（Controller）处理和响应用户的输入和交互。例如， 控制器（Controller）处理路由数据和查询字符串值，然后将这些值传递给模型（Model），模型（Model）可以使用这些值去查询数据库。

http://localhost:1234/Home/About 拥有路由数据 Home (控制器) 以及 About ( home 控制器中调用的 action 方法). http://localhost:1234/Movies/Edit/5 代表一个请求使用 movie 控制器编辑 ID=5 电影数据。我们在后面的教程中将会详细谈到路由数据。

MVC 模式帮助你创建一个分离不同方面的应用程序(输入逻辑，业务逻辑，以及 UI 逻辑)，同时这些元素之间是松耦合的。该模式指定在应用程序中的每一种逻辑应该位于何处。 UI 逻辑属于视图（View）。输入逻辑属于控制器（Controller）。业务逻辑属于模型（Model）。当你构建一个应用程序时，这样的分离帮助你管理应用程序的复杂性，因为它使你编写一个方面的代码时不会影响其他(方面)的代码。比如，你可以编写视图（View）代码而不需要依赖于业务逻辑代码。

我们会在本系列教程中涵盖所有这些概念，并告诉你如何使用它们构建一个简单的电影应用程序。下面的图片展示了 MVC 项目中的 Controllers 、 Views 文件夹。Models 文件夹会在后面的章节添加。

  • 在 解决方案资源管理器（Solution Explorer） 中，鼠标右键点击 Controllers > 添加（Add） > 新建项...（New Item...） > MVC 控制器类（MVC Controller Class）

  • 在 VS Code 中， 选择 资源管理器（EXPLORER） 图标右键 Controllers 目录，点击 新建文件（New File）

    右键菜单

  • 命名文件为 HelloWorldController.cs

替换 Controllers/HelloWorldController.cs 代码如下：

using Microsoft.AspNetCore.Mvc;
using System.Text.Encodings.Web;

namespace MvcMovie.Controllers
{
    public class HelloWorldController : Controller
    {
        // 
        // GET: /HelloWorld/

        public string Index()
        {
            return "This is my default action...";
        }

        // 
        // GET: /HelloWorld/Welcome/ 

        public string Welcome()
        {
            return "This is the Welcome action method...";
        }
    }
}

控制器（Controller）的每个 public 方法都可作为 HTTP 端点。在上面的例子中，两个方法都返回 string，注意方法的注释：

第一条注释指出这是一个通过在 URL 后添加 "/HelloWorld/" 调用的 HTTP GET 方法，。第二条指出这是一个通过在 URL 后添加 "/HelloWorld/Welcome/" 调用的 HTTP GET 方法 。之后的教程我们将使用基架引擎来生成 HTTP POST 方法。

运行应用程序并导航到 http://localhost:5000/HelloWorld

Index 方法返回一段字符串，系统将这段字符串转换为 HTML 返回给浏览器。

这是我的默认操作浏览器窗口显示的应用程序响应

MVC 调用的控制器（Controller）类 (以及它们的 Action 方法) 取决于传入的 URL 。MVC 的默认 URL 路由逻辑 采用类似下面规则格式来决定代码的调用：

/[Controller]/[ActionName]/[Parameters]

你可以在 Startup.cs 文件中设置路由规则。

app.UseMvc(routes =>
{
    routes.MapRoute(
        name: "default",
        template: "{controller=Home}/{action=Index}/{id?}");
});

当你运行应用程序且不提供任何 URL 段时，它将默认访问在上面模板中高亮行指定的 "Home" Controller 中的 "Index" Action 方法。

第一个 URL 段决定运行哪个控制器（Controller）。所以 localhost:5000/HelloWorld映射到 HelloWorldController 类。URL 段的第二部分决定类里的 Action 方法。所以 localhost:5000/HelloWorld/Index 将运行 HelloWorldController 中的 Index 方法。请注意，我们只需要浏览 localhost:5000/HelloWorld ，默认会调用 Index 方法。这是因为在没有指定方法名时， Index 是默认方法。URL 段的第三部分 ( id) 是路由数据。我们之后将在本教程中了解路由数据。

浏览 http://localhost:5000/HelloWorld/Welcome。 Welcome 方法运行并返回 "This is the Welcome action method..." 。对于这个 URL ， 控制器（Controller）是 HelloWorld ， Action 方法是 Welcome 。我们还没有使用 URL 中的 [Parameters] 部分。

这是浏览器窗口显示应用程序响应的 Welcome 操作方法的结果

让我们稍微修改一下例子，使我们能够通过 URL 传递一些参数信息到控制器（Controller）(例如， /HelloWorld/Welcome?name=Scott&numtimes=4 )。如下所示修改 Welcome 方法使其包含两个参数。请注意，代码利用 C# 的可选参数特性指明在没有传递参数的情况下， numTimes 参数默认为1。

// GET: /HelloWorld/Welcome/ 
// Requires using System.Text.Encodings.Web;
public string Welcome(string name, int numTimes = 1)
{
    return HtmlEncoder.Default.Encode($"Hello {name}, NumTimes is: {numTimes}");
}

上面的代码使用 HtmlEncoder.Default.Encode 来保护应用程序免受恶意输入(即 JavaScript)。同时也使用了 内插字符串。

运行你的应用程序并浏览：

http://localhost:5000/HelloWorld/Welcome?name=Rick&numtimes=4

(用你的端口替换 xxxx。) 你可以在 URL 中对 name 和 numtimes 尝试不同的值。 MVC 模型绑定 系统自动将地址栏里查询字符串中有名字的参数映射到你方法中的参数。查看 模型绑定获得更多的信息。

浏览器窗口显示应用程序响应 Hello Rick, NumTimes is: 4

在上面的示例中， URL 段 (Parameters) 没有被使用， name 和 numTimes 参数作为 查询字符串 被传递。 上面 URL 中的 ? (问号) 是一个分隔符，后面跟查询字符串。 & 字符分割查询字符串。

用下面的代码替换 Welcome 方法：

public string Welcome(string name, int ID = 1)
{
    return HtmlEncoder.Default.Encode($"Hello {name}, ID: {ID}");
}

运行应用程序然后输入 URL ： http://localhost:xxx/HelloWorld/Welcome/3?name=Rick

浏览器窗口显示应用程序响应 Hello Rick, ID: 3

这次第三个 URL 段匹配上了路由参数 id。 Welcome 方法包含一个与 MapRoute 内的 URL 模板相匹配的 id 参数。跟随的 ? ( id?) 表示 id 参数是可选的。

app.UseMvc(routes =>
{
    routes.MapRoute(
        name: "default",
        template: "{controller=Home}/{action=Index}/{id?}");
});

在这些例子中，控制器（Controller）一直在做 MVC 中的 "VC" 部分，就是视图（View）和控制器（Controller）部分的工作。这个控制器（Controller）直接返回 HTML 。一般来说你不想让控制器（Controller） 直接返回 HTML ，因为这让编码和维护变得非常麻烦。所以，我们通常会使用一个单独的 Razor 视图模板文件来帮助生成 HTML 响应。 我们将在下一个教程中介绍这部分。

上一节 - 入门 下一节 - 添加视图