介绍asp.net MVC下使用rest的方法-猿码集

1. 什么是REST

REST(REpresentational State Transfer)是一种基于客户端和服务器之间的通信协议，它通过HTTP协议中的GET, POST, PUT, DELETE等请求方法来实现对资源的增删改查。它的设计思想是将资源的状态以URL方式暴露出来，客户端通过HTTP协议获取资源的状态信息，进行一些状态转换，将整个Web应用构建为"资源+动作"的模型。

在ASP.NET MVC中，可以利用RESTful API来创建一组API方法，实现与数据库进行交互的通信，使得客户端应用程序可以进行CRUD操作（增删改查）。

2. 使用REST实现CRUD操作

2.1 创建RESTful API

创建RESTful API需要借助于ASP.NET Web API，ASP.NET Web API是以控制器为基础的，可以让我们快速创建RESTful API应用程序。

首先，我们通过Visual Studio创建一个ASP.NET Web Application项目。


public class ProductsController : ApiController
{
    private readonly ProductRepository _repository = new ProductRepository();
    public IEnumerable<Product> GetAllProducts()
    {
        return _repository.GetAll();
    }
 
    public Product GetProduct(int id)
    {
        var product = _repository.Get(id);
        if (product == null)
            throw new HttpResponseException(HttpStatusCode.NotFound);
        return product;
    }
 
    public HttpResponseMessage PostProduct(Product product)
    {
        _repository.Add(product);
        var response = Request.CreateResponse(HttpStatusCode.Created, product);
        response.Headers.Location = new Uri(Url.Link("DefaultApi", new { id = product.Id }));
        return response;
    }
 
    public void PutProduct(int id, Product product)
    {
        product.Id = id;
        if (!_repository.Update(product))
            throw new HttpResponseException(HttpStatusCode.NotFound);
    }
 
    public void DeleteProduct(int id)
    {
        _repository.Remove(id);
    }
}

2.2 实现GET方法

GET方法用于读取资源，可以通过传递参数来指定需要读取的资源。

下面是实现GetAllProducts和GetProduct方法的代码，可以返回所有商品或者指定商品的基本信息：


public IEnumerable<Product> GetAllProducts()
{
    return _repository.GetAll();
}
 
public Product GetProduct(int id)
{
    var product = _repository.Get(id);
    if (product == null)
        throw new HttpResponseException(HttpStatusCode.NotFound);
    return product;
}

2.3 实现POST方法

POST方法用于创建新的资源，需要将资源的基本信息作为参数传递给API。

下面是实现PostProduct方法的代码，可以将传递的商品信息添加到数据库中，返回创建结果：


public HttpResponseMessage PostProduct(Product product)
{
    _repository.Add(product);
    var response = Request.CreateResponse(HttpStatusCode.Created, product);
    response.Headers.Location = new Uri(Url.Link("DefaultApi", new { id = product.Id }));
    return response;
}

2.4 实现PUT方法

PUT方法用于修改现有的资源，需要将资源的ID和修改后的基本信息作为参数传递给API。

下面是实现PutProduct方法的代码，可以将传递的商品信息更新到数据库中，返回操作结果：


public void PutProduct(int id, Product product)
{
    product.Id = id;
    if (!_repository.Update(product))
        throw new HttpResponseException(HttpStatusCode.NotFound);
}

2.5 实现DELETE方法

DELETE方法用于删除现有的资源，需要将资源的ID作为参数传递给API。

下面是实现DeleteProduct方法的代码，可以将指定ID商品删除，返回操作结果：


public void DeleteProduct(int id)
{
    _repository.Remove(id);
}

3. 使用rest api库

若是需要更加方便的使用RESTful API，可以考虑使用ASP.NET Web API中的rest api库，以简化API的创建和管理。

ASP.NET Web API中的rest api库包含了自动化的API路由功能，可以将API按照RESTful架构自动注册。我们可以使用Attribute Routing来显式地定义路由规则，以便更好地控制API行为。

3.1 安装rest api库

rest api库可以通过Nuget包管理器安装，直接搜索“Microsoft.AspNet.WebApi.Core”即可找到。

安装完成后，我们需要在WebApiConfig.cs中配置Attribute Routing规则：


public static void Register(HttpConfiguration config)
{
    // Attribute routing.
    config.MapHttpAttributeRoutes();
    // Convention-based routing.
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
    // Configure JSON formatter.
    config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
}

3.2 实现RESTful API

可以使用rest api库提供的[Route]和[HttpVerb]特性来配置API路由和HTTP请求方法。

下面是一个使用rest api库实现CRUD操作的例子：


[RoutePrefix("api/products")]
public class ProductsController : ApiController
{
    private readonly ProductRepository _repository = new ProductRepository();
    [HttpGet]
    [Route("")]
    public IHttpActionResult GetAllProducts()
    {
        var products = _repository.GetAll();
        if (products == null || !products.Any())
            return NotFound();
        return Ok(products);
    }
    [HttpGet]
    [Route("{id:int}")]
    public IHttpActionResult GetProduct(int id)
    {
        var product = _repository.Get(id);
        if (product == null)
            return NotFound();
        return Ok(product);
    }
    [HttpPost]
    [Route("")]
    public IHttpActionResult AddProduct(Product product)
    {
        if (!ModelState.IsValid)
            return BadRequest("Invalid data.");
        _repository.Add(product);
        return CreatedAtRoute("GetProductById", new { id = product.Id }, product);
    }
    [HttpPut]
    [Route("{id:int}")]
    public IHttpActionResult UpdateProduct(int id, Product product)
    {
        if (!ModelState.IsValid)
            return BadRequest("Invalid data.");
        product.Id = id;
        if (!_repository.Update(product))
            return NotFound();
        return Ok("Product updated successfully.");
    }
    [HttpDelete]
    [Route("{id:int}")]
    public IHttpActionResult DeleteProduct(int id)
    {
        _repository.Remove(id);
        return Ok("Product deleted successfully.");
    }
}

4. 总结

使用RESTful API可以让我们快速创建和管理Web应用程序中的API，针对不同的客户端应用程序提供不同的资源和服务。

在ASP.NET MVC项目中，我们可以利用ASP.NET Web API创建RESTful API，轻松实现对数据库的CRUD操作。同时，使用rest api库可以让我们更加方便地定义API路由和请求方法，提高开发效率和代码质量。

介绍asp.net MVC下使用rest的方法