mvc 控制器中怎样调用 web.api中的方法_软件运维

mvc 控制器中怎样调用 web.api中的方法

调用控制器方法代码：

<%using (Html.BeginForm("RequestForm", "Home"))

{%>

FirstName:<%=Html.TextBox("FirstName")%> 颤迅

LastName:<%=Html.TextBox("LastName")%>

<%} %>

</脊尘p>

</fieldset>

2、在HomeController中定义如下方法,用于接收View传来的数据

public ActionResult RequestForm()

{

Person person = new Person()

person.FirstName = Request.Form["FirstName"]

person.LastName = Request.Form["LastName"]

return View(person)

}

Visual Studio为我们提供了专门用于创建ASP.NET Web API应用的项目模板，借助于此项目模板提供的向导，我们可以“一键式”创建一个完整的ASP.NET Web API项目。在项目创建过程中，Visual Studio会自动为我们添加必要的程序集引用和配置，甚至会为我们自动生成相关的代码，总之一句话：这种通过向导生成的项目在被创建之后其本身就是一个可执行的应用。

对于IDE提供的这种旨在提高生产效率的自动化机制，我个人自然是推崇的，但是我更推荐读者朋友们去了解一下这些自动化机制具体为我们做了什么？做这些的目的何在？哪些是必需的，哪些又是不必要的？正是基于这样的目的，在接下来演示的实例中，我们将摒弃Visual Studio为我们提供的向导，完全在创建的空项目中编写我们的程序。这些空项目体现在如右图所示的解决方案结构中。

如右图所示，整个解决方案一共包含6个项目，上面介绍的作为“联系人管理器”的单页Web应用对应着项目WebApp，下面的列表给出了包括它在内的巧陪所有项目的类型和扮演的角色。

·Common：这是一个空的类库项目，仅仅定义了表示联系人的数据类型而已。之所以将数据类型定义在独立的项目中，只要是考虑到它会被多个项目孝毁蠢（WebApi和ConsoleApp）所使用。

WebApi：这是一个空的类库项目，表现为HttpController类型的Web API就定义在此项目中，它具有对Common的项目引用。

WebHost：这是一个空的ASP.NET Web应用，它实现了针对ASP.NET Web API的Web Host寄宿，该项目具有针对WebApi的项目引用。

SelfHost：这是一个空的控制台应用，旨在模拟ASP.NET Web API的Self Host寄宿模式，它同样具有针对WebApi的项目引用。

WebApp：这是一个空的ASP.NET Web应用，代表“联系人管理器”的网页就存在于该项目之中，至于具体的联系人管理功能，自然通过以Ajax的形式调用Web API来完成。

ConsoleApp：这是一个空的控制台应用，我们用它来模拟如何利用客户端代理来实现对Web API的远程调用，它具有针对Common的项目引用。

二、定义Web API

在正式定义Web API之前，我们需要在项目Common中定义代表联系人的数据类型Contact。简单起见，我们仅仅为Contact定义了如下几个简单的属性，它们分别代表联系人的ID、姓名、联系电话、电子邮箱和联系地址。

1: public class Contact

2: {

3: public string Id { getset}

4: public string Name { getset}

5: public string PhoneNo { getset}

6: public string EmailAddress { getset}

7: public string Address { getset}

8: }

表现为HttpController的Web API定义在WebApi项目之中，我们一般将ApiController作为继承的基类。ApiController定义在“System.Web.Http.dll”程序集中，我们可以在目录“%ProgramFiles%\Microsoft ASP.NET\ASP.NET Web Stack 5\Packages\”中找到这个程序集。具余肢体来说，该程序集存在于子目录“Microsoft.AspNet.WebApi.Core.5.0.0\lib\net45”中。

Web API体现在如下所示的ContactsController类型中。在该类型中，我们定义了Get、Post、Put和Delete这4个Action方法，它们分别实现了针对联系人的查询、添加、修改和删除 *** 作。Action方法Get具有一个表示联系人ID的可缺省参数，如果该参数存在则返回对应的联系人，否则返回整个联系人列表。由于ASP.NET Web API默认实现了Action方法与HTTP方法的映射，所以方法名也体现了它们各自所能处理请求必须采用的HTTP方法。

1: public class ContactsController: ApiController

2: {

3: static List<Contact>contacts

4: static int counter = 2

6: static ContactsController()

7: {

8: contacts = new List<Contact>()

9: contacts.Add(new Contact { Id = "001", Name = "张三",

10: PhoneNo = "0512-12345678", EmailAddress = "zhangsan@gmail.com",

11: Address = "江苏省苏州市星湖街328号" })

12: contacts.Add(new Contact { Id = "002", Name = "李四",

13: PhoneNo = "0512-23456789", EmailAddress = "lisi@gmail.com",

14: Address = "江苏省苏州市金鸡湖大道328号" })

15: }

16:

17: public IEnumerable<Contact>Get(string id = null)

18: {

19: return from contact in contacts

20: where contact.Id == id || string.IsNullOrEmpty(id)

21: select contact

22: }

23:

24: public void Post(Contact contact)

25: {

26: Interlocked.Increment(ref counter)

27: contact.Id = counter.ToString("D3")

28: contacts.Add(contact)

29: }

30:

31: public void Put(Contact contact)

32: {

33: contacts.Remove(contacts.First(c =>c.Id == contact.Id))

34: contacts.Add(contact)

35: }

36:

37: public void Delete(string id)

38: {

39: contacts.Remove(contacts.First(c =>c.Id == id))

40: }

41: }

简单起见，我们利用一个静态字段（contacts）表示存储的联系人列表。当ContactsController类型被加载的时候，我们添加了两个ID分别为“001”和“002”的联系人记录。至于实现联系人CRUD *** 作的Action方法，我们也省略了必要的验证，对于本书后续的演示的实例，我们基本上也会采用这种“简写”的风格。

1 控制器基类ApiControllerBase

[csharp] view plaincopy

///

/// Controller的基类，用于实现适合业务场景的基础功能

///

[BasicAuthentication]

public abstract class ApiControllerBase : ApiController

{

}

2 权限属性BaseAuthenticationAttribute

[csharp] view plaincopy

///

/// 基本验证Attribtue，用以Action的权限处理

///

public class BasicAuthenticationAttribute : ActionFilterAttribute

{

///

/// 检查用户是否有该Action执行的毁宴基 *** 作权限

///

public override void OnActionExecuting(HttpActionContext actionContext)

{

//检验用户ticket信息，用户ticket信息来自调用发起方

if (actionContext.Request.Headers.Authorization != null)

{

//解密用户ticket,并校验用户名密码是否匹配

var encryptTicket = actionContext.Request.Headers.Authorization.Parameter

if (ValidateUserTicket(encryptTicket))

base.OnActionExecuting(actionContext)

else

actionContext.Response = new HttpResponseMessage(HttpStatusCode.Unauthorized)

}

else

{

//检纤谨查web.config配置是否要求权限校验

bool isRquired = (WebConfigurationManager.AppSettings["WebApiAuthenticatedFlag"].ToString() == "true")

if (isRquired)

{

//如果请求Header不包含ticket，则判断祥磨是否是匿名调用

var attr = actionContext.ActionDescriptor.GetCustomAttributes().OfType()

bool isAnonymous = attr.Any(a =>a is AllowAnonymousAttribute)

//是匿名用户，则继续执行；非匿名用户，抛出“未授权访问”信息

if (isAnonymous)

base.OnActionExecuting(actionContext)

else

actionContext.Response = new HttpResponseMessage(HttpStatusCode.Unauthorized)

}

else

{

base.OnActionExecuting(actionContext)

}

///

/// 校验用户ticket信息

///

private bool ValidateUserTicket(string encryptTicket)

{

var userTicket = FormsAuthentication.Decrypt(encryptTicket)

var userTicketData = userTicket.UserData

string userName = userTicketData.Substring(0, userTicketData.IndexOf(":"))

string password = userTicketData.Substring(userTicketData.IndexOf(":") + 1)

//检查用户名、密码是否正确，验证是合法用户

//var isQuilified = CheckUser(userName, password)

return true

}

3 api服务Controller实例

[csharp] view plaincopy

public class ProductController : ApiControllerBase

{

[HttpGet]

public object Find(string id)

{

return ProductServiceInstance.Find(2)

}

// GET api/product/5

[HttpGet]

[AllowAnonymous]

public Product Get(string id)

{

var headers = Request.Headers

var p = ProductServiceInstance.GetById(long.Parse(id))

if (p == null)

{

throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.BadRequest)

Content = new StringContent("id3 not found"), ReasonPhrase = "product id not exist." })

}

return p

}

4. 其它配置说明

1）、 Mvc前端Web.Config 配置

[html] view plaincopy

<system.web>

</assemblies>

</compilation>

</authentication>

</system.web>

machineKey节点配置，是应用于对用户ticket数据加密和解密。

2）、WebApi服务端Web.Config配置

[html] view plaincopy

<system.web>

</system.web>

machineKey节点配置，是应用于对用户ticket数据加密和解密。

欢迎分享，转载请注明来源：内存溢出

原文地址: http://outofmemory.cn/yw/8190569.html

mvc 控制器中怎样调用 web.api中的方法

发表评论

评论列表（0条）