1. 技术文章
  2. ASP.NET 5系列教程(七)完结篇-解读代码

ASP.NET 5系列教程(七)完结篇-解读代码

由 两盒软妹~` 提交于 2019-11-27 02:23:46

在本文中，我们将一起查看TodoController 类代码。

[Route] 属性定义了Controller的URL 模板：

[Route("")]

 

所有符合该模板类型的HTTP 请求都会被路由到该controller。在本例中， 路由的命名规范为对应Controller 的前缀，对于TodoController 类，路由模板为 “api/todo”。

HTTP 方法

[HttpGet]、[HttpPost]和[HttpDelete] 属性定义为 controller 动作对应的HTTP 方法 （另外也有[HttpPut] 和 [HttpPatch] 属性，在本示例中没有使用。）

[HttpGet]
 IEnumerable<TodoItem> GetAll() {}
 
[HttpGet("", Name = "")]
 IActionResult GetById (int id) {}
 
[HttpPost]
 void CreateTodoItem([FromBody] TodoItem item) {}
 
[HttpDelete("")]
 IActionResult DeleteItem(int id) {}

 

GetById 和DeleteItem 方法中的参数可以增加路由的传递信息。所以，路由模板更加完善的写法为“api/[controller]/{id:int}”。

在 “{id:int}” 中，id是变量，而 “:int” 代表参数为整型。以下为URLs实例：

http://localhost/api/todo/1
http://localhost/api/todo/42

不能写为：

http://localhost/api/todo/abc

 

注意 GetById 和 DeleteItem 方法同样拥有命名为id的参数。framework 会自动传递实参值到Controller中。例如，如果URL为http://localhost/api/todo/42，id的值则为42，这个过程为参数绑定。

CreateTodoItem 方法代表了另一个参数绑定：

[HttpPost]
 void CreateTodoItem([FromBody] TodoItem item) {}

 

[FromBody] 属性指定framework 从Request中反序列化TodoItem 参数。

以下是request和controller 动作的对应列表：

Request

Controller Action

GET /api/todo

GetAll

POST /api/todo

CreateTodoItem

GET /api/todo/1

GetById

DELETE /api/todo/1

DeleteItem

GET /api/todo/abc

none – returns 404

PUT /api/todo

none – returns 404

最后两个例子由于其他用途返回404 错误。例如 'GET /api/todo/abc'， 'abc' 实参是GetById 方法中要求的整型数据类型。

Action 返回值

TodoController 类展示了多种 controller action的返回值方法。

GetAll 方法返回了一个CLR 对象。

[HttpGet]
 IEnumerable<TodoItem> GetAll()
{
     _items;
}

返回对象的序列化信息被存储到Response消息中。默认格式为JSON，客户端同样可以接收XML数据格式：

 http://localhost:5000/api/todo HTTP/1.1
 
User-Agent: Fiddler
 
Host: localhost:5000
 
Accept: application/xml

Response:

HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8
Server: Microsoft-HTTPAPI/2.0
: Thu, 30 Oct 2014 22:40:10 GMT
Content-Length: 228
 
<ArrayOfTodoItem xmlns:i="" xmlns=""><TodoItem><Id>1</Id><IsDone></IsDone><Title>First Item</Title></TodoItem></ArrayOfTodoItem>

 

GetById 方法返回了一个IActionResult 接口：

[HttpGet("", Name = "")]
 IActionResult GetById (int id)
{
    var item = _items.FirstOrDefault(x => x.Id == id);
     (item == null)
    {
         HttpNotFound();
    }
 
      ObjectResult(item);
}

 

如果有URL中对应的id，则这个方法会返回ObjectResult 。返回 ObjectResult 和返回CLR 模型相同。而方法中规定返回类型为IActionResult。因此，该方法可以返回不同的类型。

如果没有对应ID，则返回HttpNotFound，页面会抛出404 错误。

最后， CreateTodoItem 方法展示如何直接在方法中设置返回值：

[HttpPost]
 void CreateTodoItem([FromBody] TodoItem item)
{
    // (some code  shown here)
 
    Context.Response.StatusCode = 201;
    Context.Response.Headers[""] = url;
}

 

这种方法的缺陷是很难进行单元测试。（关于测试相关讨论，可以参考Unit Testing Controllers in ASP.NET Web API）。

依赖注入

MVC 6 内置了依赖注入功能。下面，让我们创建一个包含ToDo列表的repository 类。

首先，为repository定义一个接口：

 System.Collections.Generic;
 
 TodoApi.Models
{
      ITodoRepository
    {
        IEnumerable<TodoItem> AllItems { ; }
        void Add(TodoItem item);
        TodoItem GetById(int id);
        bool TryDelete(int id);
    }
}

 

之后定义具体实现方法。

 System;
 System.Collections.Generic;
 System.Linq;
 
 TodoApi.Models
{
      TodoRepository : ITodoRepository
    {
         List<TodoItem> _items =  List<TodoItem>();
 
         IEnumerable<TodoItem> AllItems
        {
get
            {
                 _items;
            }
        }
 
         TodoItem GetById(int id)
        {
             _items.FirstOrDefault(x => x.Id == id);
        }
 
         void Add(TodoItem item)
        {
            item.Id = 1 + _items.Max(x => (int?)x.Id) ?? 0;
            _items.Add(item);
        }
 
         bool TryDelete(int id)
        {
            var item = GetById(id);
             (item == null)
            {
                 ;
            }
            _items.Remove(item);
             ;
        }
    }
}

 

使用构造函数注入repository 到 controller：

[Route("")]
  TodoController : Controller
{
    // Remove this code:
    //  List<TodoItem> _items =  List<TodoItem>()
    //{
    //     TodoItem { Id = 1, Title = "" }
    //};
 
    // Add this code:
      ITodoRepository _repository;
 
     TodoController(ITodoRepository repository)
    {
        _repository = repository;
    }

 

然后更新controller 方法到repository：

[HttpGet]
 IEnumerable<TodoItem> GetAll()
{
     _repository.AllItems;
}
[HttpGet("", Name = "")]
 IActionResult GetById(int id)
{
    var item = _repository.GetById(id);
     (item == null)
    {
         HttpNotFound();
    }
 
      ObjectResult(item);
}
 
[HttpPost]
 void CreateTodoItem([FromBody] TodoItem item)
{
     (!ModelState.IsValid)
    {
        Context.Response.StatusCode = 400;
    }
else
    {
        _repository.Add(item);
 
         url = Url.RouteUrl("",  { id = item.Id }, Request.Scheme, Request.Host.ToUriComponent());
        Context.Response.StatusCode = 201;
        Context.Response.Headers[""] = url;
    }
}
 
[HttpDelete("")]
 IActionResult DeleteItem(int id)
{
     (_repository.TryDelete(id))
    {
          HttpStatusCodeResult(204); // 201 No Content
    }
else
    {
         HttpNotFound();
    }
}

 

我们需要注册repository到依赖注入系统才能使其启作用。在Startup 类中，添加以下代码：

 void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    //  code
    services.AddSingleton<ITodoRepository, TodoRepository>();
}

 

应用运行时， 一旦controller被创建，framework 自动注入TodoRepository 到controller中，它将作用于整个应用的生命周期。

在IIS外独立部署应用

默认情况下，当你点击F5，应用会在IIS Express中运行。你可以在工具栏中看到IIS Express 图标。

clip_image001

 

ASP.NET 5.0 可以部署到不同的服务器中，在本节中，我们将使用可运行在IIS外的WebListener。

注意：将应用部署在IIS中仍有诸多的优势，例如安全性、进度管理等。

在project.json 文件，添加Microsoft.AspNet.Server.WebListener 包：

"": {
    "": "",
    "": "",
    "": "",
// New:
    "": ""
},

 

接下来添加以下选项到project.json。

{
// Other sections not shown
 
    "": {
        "": ""
    }
}

 

“commands” 中包含了可以传递给K 运行时的预定义指令列表。在这个例子中， “web” 是指令名称，它可以是任意实际指令名称值。

Microsoft.AspNet.Hosting 程序集用于部署ASP.NET 5.0 应用。

· --server 标记用于声明服务器，在这个例子中为WebListener。

· --server.urls 标记提供需要监听的URL。

保存project.json 文件。在Solution Explorer中，右键点击工程选择Properties。在 Properties 栏，点击Debug。在Debug target 下，更改 “IIS Express” 为 “web”。

clip_image001[5]

 

点击F5运行App。Visual Studio 这时会运行启动WebListener 的控制台应用。

clip_image001[7]

打开浏览器，输入http://localhost:5000。你可以看到欢迎界面。

如果需要使用IIS，在上一步骤中更改Debug Target 为 “IIS Express”即可。

这篇文章为本系列文章的最后一篇，感谢大家的关注。本系列的所有教程旨在帮助大家更好的理解ASP.NET 5，以便更好的进行开发。同时，也可以借助一些开发工具来助力开发过程。ComponentOne Studio for ASP.NET 是ASP.NET平台上的一整套完备的开发工具包，用于在各种浏览器中创建和设计具有现代风格的Web应用程序。

这篇文章为本系列文章的最后一篇，感谢大家的关注。

原文链接：http://www.asp.net/vnext/overview/aspnet-vnext/create-a-web-api-with-mvc-6

 

目录：

 

标签
ASP.NET
5
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!