上篇中简单介绍了一下WebApi,本章主要介绍一下Controller相关的知识。

在实际应用中,Controller是WebAPI的链接服务器和客户端的窗口。Controller的好坏影响整个系统的设计。Controller中是各种Action接口,对于Action接口,我们有必要对其接收的参数和返回值了解。

Action返回类型

WebAPI服务函数的返回值主要可以分为void、普通对象、HttpResponseMessag、IHttpActionResult 四种,这里简单的介绍一下。

Void类型

一般来说,Delete和Put类型的求情返回void类型的值,如:

public class DepartmentController : ApiController
{
        public void Delete(int id)
        {
            
        }
}

不过一个交互性好的接口,应该返回正确的Http status code,如返回200,对列子做修改:

public class DepartmentController : ApiController
{
    public HttpStatusCode Delete(int id)
  {
    return HttpStatusCode.OK;
  }
}    

普通对象

普通对象通常是由Get接口返回。例如:

public class CompanyController : ApiController
{
  public Company Get(int id)
   {
     return CompanyInfo;
   }
}

HttpResponseMessag

HttpResponseMessage是标准Http应答了,此时服务器并不做任何处理,可以直接将HttpResponseMessage发送给客户端。

1  public HttpResponseMessage Get()
2  {
3         var response = Request.CreateResponse(HttpStatusCode.OK);
4         response.Content = new StringContent("Success", Encoding.UTF8);
5             
6         return response;
7   }
View Code

IHttpActionResult

IHttpActionResult是Web API 2中引入的一个接口,IHttpActionResult是HttpResponseMessage的一个工厂类。IHttpActionResult是WebAPI中推荐的标准返回值,ApiController类中也提供了不少标准的工厂函数方便我们快速构建它们,如BadRequest,Conflict,Ok,NotFound等,一个简单的示例如下:

1         public IHttpActionResult Get(int id)
2         {
3             var dto = new ProductDataDTO();
4             dto = AutoMapper.Mapper.Map<ProductDataDTO>(ProductDataService.QueryProductData (id));
5             return Ok(dto);
6         }
View Code

Action参数类型

Get请求的参数,均在URI中给出,比较简单,不做过多说明。下面主要对POST请求的参数做一下说明。

POST请求

单一POST参数

单一的参数请求,需要使用[FromBody]标记参数,如下图所示:

[AcceptVerbs("POST")]
public string Post([FromBody]string data)
{
     return string.Format(@"Data:{1}",  data);
}

除了使用[FromBody]标记参数外,也可以使用dynamic关键字标记参数。

多个参数的POST请求

有了上面的经验,多个参数的例子,按照常理来说,应该如下所示:

 [AcceptVerbs("POST")]
public string Post([FromBody]string data, [FromBody]string name) { return string.Format(@"Name:{0},Data:{1}", name, data); }

但在实际调用中却报错,报错如下:

查了资料,原因是在一个接口中,被[FromBody]修饰的参数只能有一个。对此,我们可以将上面的两个参数封装为一个对象传递。如下:

public class Person
{
  public string name { set; get; }
  public string message { set; get; }
}

......


[AcceptVerbs("POST")]
public string TEST4([FromBody]Person data) {   return string.Format(@"Name:{0},Message:{1}", data.name, data.message); }

除此之外,还有另外一种方式实现,使用[FromURi]关键字,如下所示:

public string TEST2([FromUri]string data,[FromBody]string name)
{
  return string.Format(@"Name:{0},Data:{1}",name,data);
}

需要说明的是,在WebApi的接口参数中,在没有标记的情况下,参数默认是[FromUri]形式,Get请求的接口的参数都是FromUri,顾名思议是从Uri获取数据。一个接口可以有多个FromUri参数(这些参数一般都是简单参数),但是只能有一个FromBody的参数。

就刚才的例子而言,data数据在Uri中获取,而name数据则从body中获取。

传递对象

有了上面的例子,其实传递对象在上面已经讲过了,就是使用[FromBody]或dynamic标记参数。

传递不同的多个对象

这种情况,最近打算写这篇文章的时候,查找资料的时候,在其他人的博文中看到的,地址如下:http://www.cnblogs.com/babycool/p/3922738.html,里面提到了传递多个不同对象的情况,个人也尝试去试着调试,但是一直没有成功,也就不好做过多的说明。后来想了下,其实可以另辟蹊径解决这个方法,新建一个对象,将要传递的对象做了属性,这样来传递给后台接口。关于最后这种方式,大家感兴趣可以去看看原文。