查看: 2066|回复: 0

[ASP.NET教程] asp.net MVC下使用rest的方法

发表于 2018-1-3 08:00:01

前言

最近做了下个MVC的项目,需要用到rest接口,与java写的应用程序通信,包括数据的接收和发送,那么我将用实用的角度来全面的讲解一下它的使用方法

一、创建rest服务

首先创建一个asp.net Web应用程序(我这里用的是Visual Studio 2013,它已经内置了Web API2)。

在出来的模板中选择Empty(空项目),并勾选WebAPI。点击确定后,就创建了一个空的WebAPI服务。

此时只有一个空项目,还没有任何功能,在进行下一步之前,首先我们来看一下REST的基本操作模型,大致可以分为如下四种:

  • POST — 创建资源
  • GET — 检索资源
  • PUT — 更新资源
  • DELETE — 删除资源

非常经典的CRUD模型。在Web API中实现这样一个的模型是非常简单的,直接使用向导建一个Controller即可

如果用传统的向导,记得把向导后面的那个1给去掉:

默认的模板内容如下:

  1. public class ValuesController : ApiController
  2. {
  3. // GET api/<controller>
  4. publicIEnumerable<string> Get()
  5. {
  6. returnnewstring[] { "value1", "value2" };
  7. }
  8. // GET api/<controller>/5
  9. publicstring Get(int id)
  10. {
  11. return"value";
  12. }
  13. // POST api/<controller>
  14. publicvoid Post([FromBody]string value)
  15. {
  16. }
  17. // PUT api/<controller>/5
  18. publicvoid Put(int id, [FromBody]string value)
  19. {
  20. }
  21. // DELETE api/<controller>/5
  22. publicvoid Delete(int id)
  23. {
  24. }
  25. }
复制代码

这其实已经帮我们实现了一个最基本的服务了,这样别人就可以访问我们的服务中的方法

二、调用其它应用程序的rest服务

1、RestClient类

为了便于使用,我们需要封装客房端的rest类,话不多说,我们直接上这个类的代码:

  1. using System;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using System.Linq;
  5. using System.Net;
  6. using System.Text;
  7. using System.Web;
  8. namespace OilDigital.A2_A27.Web
  9. {
  10. public class RestClient
  11. {
  12. public string EndPoint { get; set; } //请求的url地址
  13. public HttpVerb Method { get; set; } //请求的方法
  14. public string ContentType { get; set; } //格式类型:我用的是application/json,text/xml具体使用什么,看需求吧
  15. public string PostData { get; set; } //传送的数据,当然了我使用的是json字符串
  16. public RestClient()
  17. {
  18. EndPoint = "";
  19. Method = HttpVerb.GET;
  20. ContentType = "application/x-www-form-urlencoded";
  21. PostData = "";
  22. }
  23. public RestClient(string endpoint)
  24. {
  25. EndPoint = endpoint;
  26. Method = HttpVerb.GET;
  27. ContentType = "application/json";
  28. PostData = "";
  29. }
  30. public RestClient(string endpoint, HttpVerb method)
  31. {
  32. EndPoint = endpoint;
  33. Method = method;
  34. ContentType = "application/json";
  35. PostData = "";
  36. }
  37. public RestClient(string endpoint, HttpVerb method, string postData)
  38. {
  39. EndPoint = endpoint;
  40. Method = method;
  41. ContentType = "application/json";
  42. PostData = postData;
  43. }
  44. public RestClient(string endpoint, HttpVerb method, string postData, string contentType)
  45. {
  46. EndPoint = endpoint;
  47. Method = method;
  48. ContentType = contentType;
  49. PostData = postData;
  50. }
  51. public string MakeRequest()
  52. {
  53. return MakeRequest("");
  54. }
  55. public string MakeRequest(string parameters)
  56. {
  57. var request = (HttpWebRequest)WebRequest.Create(EndPoint + parameters);
  58. request.Method = Method.ToString();
  59. request.ContentType = ContentType;
  60. if (!string.IsNullOrEmpty(PostData) && Method == HttpVerb.POST)//如果传送的数据不为空,并且方法是post
  61. {
  62. var encoding = new UTF8Encoding();
  63. var bytes = Encoding.GetEncoding("iso-8859-1").GetBytes(PostData);//编码方式按自己需求进行更改,我在项目中使用的是UTF-8
  64. request.ContentLength = bytes.Length;
  65. using (var writeStream = request.GetRequestStream())
  66. {
  67. writeStream.Write(bytes, 0, bytes.Length);
  68. }
  69. }
  70. if (!string.IsNullOrEmpty(PostData) && Method == HttpVerb.PUT)//如果传送的数据不为空,并且方法是put
  71. {
  72. var encoding = new UTF8Encoding();
  73. var bytes = Encoding.GetEncoding("iso-8859-1").GetBytes(PostData);//编码方式按自己需求进行更改,我在项目中使用的是UTF-8
  74. request.ContentLength = bytes.Length;
  75. using (var writeStream = request.GetRequestStream())
  76. {
  77. writeStream.Write(bytes, 0, bytes.Length);
  78. }
  79. }
  80. using (var response = (HttpWebResponse)request.GetResponse())
  81. {
  82. var responseValue = string.Empty;
  83. if (response.StatusCode != HttpStatusCode.OK)
  84. {
  85. var message = String.Format("Request failed. Received HTTP {0}", response.StatusCode);
  86. throw new ApplicationException(message);
  87. }
  88. // grab the response
  89. using (var responseStream = response.GetResponseStream())
  90. {
  91. if (responseStream != null)
  92. using (var reader = new StreamReader(responseStream))
  93. {
  94. responseValue = reader.ReadToEnd();
  95. }
  96. }
  97. return responseValue;
  98. }
  99. }
  100. }
  101. public enum HttpVerb
  102. {
  103. GET, //method 常用的就这几样,当然你也可以添加其他的 get:获取 post:修改 put:写入 delete:删除
  104. POST,
  105. PUT,
  106. DELETE
  107. }
  108. }
复制代码

2、RestClient类使用

有了这个类后我们就很方便的去调用别人的rest服务了,使用方法如下:

①,基本的调用:

  1. var client = new RestClient();
  2. string endPoint = @"http:\\myRestService.com\api\";
  3. var client = new RestClient(endPoint);
  4. var json = client.MakeRequest();
复制代码

②,如果你想带入参数

  1. var json = client.MakeRequest("?param=0");
复制代码

③,使用最多的方式

  1. var client = new RestClient();
  2. client.EndPoint = @"http:\\myRestService.com\api\"; ;
  3. client.ContentType = "application/json";
  4. client.Method = HttpVerb.POST;
  5. client.PostData = "{postData: value}";
  6. var json = client.MakeRequest();
复制代码

三、我自己项目中的使用

1、首先我测试了一下,我调用我自己的rest服务的带参的get方法,当然我这里传的参数直接写在url的后面在,参数形式是string,所以接收的get方法的形参也要改成string,这样你就

可以接收到传过去的参数了。当然别人应用程序也是可以调的。只要把url给他就行了。

  1. /// <summary>
  2. /// 从接口中获取当前用户所有信息
  3. /// </summary>
  4. /// <param name="userId">用户ID</param>
  5. /// <returns>json对象</returns>
  6. public string GetCurrentUserInfo()
  7. {
  8. string userId = GetCurrentUserId();
  9. string endPoint = "http://localhost:100/Api/RestService/"+userId;
  10. var client = new RestClient(endPoint);
  11. var userInfo = client.MakeRequest();
  12. return userInfo;
  13. }
复制代码

2、接下来,我要开始试用java写的应用程序下的rest服务了,我通过我传过去的用户ID获取到了用户的所有信息,当然我在项目中使用了缓存技术,还将返回回来的json字符串转换成了json对象,以便我后面好用linq对其进行操作,关于linq to json 可以参考我的linq专题相关文章 ,我在项目中的代码是酱子的:

  1. /// <summary>
  2. /// 从接口中获取用户所有信息
  3. /// </summary>
  4. /// <param name="userId">用户ID</param>
  5. /// <returns></returns>
  6. public static JObject CacheUser()
  7. {
  8. try
  9. {
  10. string currentUser = GetCurrentUserId();
  11. if (HttpRuntime.Cache.Get("user$" + GetCurrentUserId()) == null)
  12. {
  13. string endPoint = "http://66.66.66.666:6666/DASBASE/restServices/dataCollectionService/getUserPermissions";
  14. string postData = "jsonData={\"userCode\": \"kfry\",\"systemId\": \"1E1A7AC94BFC41D4BEBED8942EB69689\"}";
  15. var client = new RestClient(endPoint, HttpVerb.POST, postData, "application/x-www-form-urlencoded");
  16. var u = client.MakeRequest();
  17. JObject userInfo = JObject.Parse(u);
  18. //插入缓存
  19. HttpRuntime.Cache.Insert("user$" + currentUser, userInfo, null, System.DateTime.UtcNow.AddMinutes(30), TimeSpan.Zero);
  20. }
  21. return (JObject)HttpRuntime.Cache.Get("user$" + GetCurrentUserId());
  22. }
  23. catch (Exception ex)
  24. {
  25. throw new ApplicationException("获取用户信息出错:"+ex.Message);
  26. }
  27. }
复制代码

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。



回复

使用道具 举报