asp.net MVC下使用rest的方法

前言

最近做了下个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给去掉：

默认的模板内容如下：

   public class ValuesController : ApiController
  {
    // GET api/<controller>
    publicIEnumerable<string> Get()
    {
      returnnewstring[] { "value1", "value2" };
    }

    // GET api/<controller>/5
    publicstring Get(int id)
    {
      return"value";
    }

    // POST api/<controller>
    publicvoid Post([FromBody]string value)
    {
    }

    // PUT api/<controller>/5
    publicvoid Put(int id, [FromBody]string value)
    {
    }

    // DELETE api/<controller>/5
    publicvoid Delete(int id)
    {
    }
  }

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

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

1、RestClient类

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

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Text;
using System.Web;

namespace OilDigital.A2_A27.Web
{
  public class RestClient
  {
    public string EndPoint { get; set; }  //请求的url地址 
    public HttpVerb Method { get; set; }  //请求的方法 
    public string ContentType { get; set; } //格式类型：我用的是application/json，text/xml具体使用什么，看需求吧 
    public string PostData { get; set; }  //传送的数据，当然了我使用的是json字符串 

    public RestClient()
    {
      EndPoint = "";
      Method = HttpVerb.GET;
      ContentType = "application/x-www-form-urlencoded";
      PostData = "";
    }
    public RestClient(string endpoint)
    {
      EndPoint = endpoint;
      Method = HttpVerb.GET;
      ContentType = "application/json";
      PostData = "";
    }
    public RestClient(string endpoint, HttpVerb method)
    {
      EndPoint = endpoint;
      Method = method;
      ContentType = "application/json";
      PostData = "";
    }

    public RestClient(string endpoint, HttpVerb method, string postData)
    {
      EndPoint = endpoint;
      Method = method;
      ContentType = "application/json";
      PostData = postData;
    }
    public RestClient(string endpoint, HttpVerb method, string postData, string contentType)
    {
      EndPoint = endpoint;
      Method = method;
      ContentType = contentType;
      PostData = postData;
    }

    public string MakeRequest()
    {
      return MakeRequest("");
    }

    public string MakeRequest(string parameters)
    {

      var request = (HttpWebRequest)WebRequest.Create(EndPoint + parameters);
      request.Method = Method.ToString();
      request.ContentType = ContentType;
      
      if (!string.IsNullOrEmpty(PostData) && Method == HttpVerb.POST)//如果传送的数据不为空，并且方法是post 
      {
        var encoding = new UTF8Encoding();   
        var bytes = Encoding.GetEncoding("iso-8859-1").GetBytes(PostData);//编码方式按自己需求进行更改，我在项目中使用的是UTF-8 
        request.ContentLength = bytes.Length;

        using (var writeStream = request.GetRequestStream())
        {
          writeStream.Write(bytes, 0, bytes.Length);
        }
      }

      if (!string.IsNullOrEmpty(PostData) && Method == HttpVerb.PUT)//如果传送的数据不为空，并且方法是put 
      {
        var encoding = new UTF8Encoding();
        var bytes = Encoding.GetEncoding("iso-8859-1").GetBytes(PostData);//编码方式按自己需求进行更改，我在项目中使用的是UTF-8 
        request.ContentLength = bytes.Length;

        using (var writeStream = request.GetRequestStream())
        {
          writeStream.Write(bytes, 0, bytes.Length);
        }

      }
      using (var response = (HttpWebResponse)request.GetResponse())
      {
        var responseValue = string.Empty;

        if (response.StatusCode != HttpStatusCode.OK)
        {
          var message = String.Format("Request failed. Received HTTP {0}", response.StatusCode);
          throw new ApplicationException(message);
        }

        // grab the response 
        using (var responseStream = response.GetResponseStream())
        {
          if (responseStream != null)
            using (var reader = new StreamReader(responseStream))
            {
              responseValue = reader.ReadToEnd();
            }
        }

        return responseValue;
      }
    }

  }
  public enum HttpVerb
  {
    GET,      //method 常用的就这几样，当然你也可以添加其他的  get：获取  post：修改  put：写入  delete：删除 
    POST,
    PUT,
    DELETE
  }


}

2、RestClient类使用

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

①，基本的调用：

var client = new RestClient();
string endPoint = @"http:\\myRestService.com\api\";
var client = new RestClient(endPoint);
var json = client.MakeRequest(); 

②，如果你想带入参数

var json = client.MakeRequest("?param=0");

③，使用最多的方式

var client = new RestClient();
client.EndPoint = @"http:\\myRestService.com\api\"; ;
client.ContentType = "application/json";
client.Method = HttpVerb.POST;
client.PostData = "{postData: value}";
var json = client.MakeRequest();

三、我自己项目中的使用

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

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

/// <summary>
    /// 从接口中获取当前用户所有信息
    /// </summary>
    /// <param name="userId">用户ID</param>
    /// <returns>json对象</returns>
    public string GetCurrentUserInfo()
    {
      string userId = GetCurrentUserId();
      string endPoint = "http://localhost:100/Api/RestService/"+userId;
      var client = new RestClient(endPoint);
      var userInfo = client.MakeRequest();
      return userInfo;
    }

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

/// <summary>
    /// 从接口中获取用户所有信息
    /// </summary>
    /// <param name="userId">用户ID</param>
    /// <returns></returns>
    public static JObject CacheUser()
    {

      try
      {
        string currentUser = GetCurrentUserId();
        if (HttpRuntime.Cache.Get("user$" + GetCurrentUserId()) == null)
        {
          string endPoint = "http://66.66.66.666:6666/DASBASE/restServices/dataCollectionService/getUserPermissions";
          string postData = "jsonData={\"userCode\": \"kfry\",\"systemId\": \"1E1A7AC94BFC41D4BEBED8942EB69689\"}";
          var client = new RestClient(endPoint, HttpVerb.POST, postData, "application/x-www-form-urlencoded");
          var u = client.MakeRequest();
          JObject userInfo = JObject.Parse(u);
          //插入缓存
          HttpRuntime.Cache.Insert("user$" + currentUser, userInfo, null, System.DateTime.UtcNow.AddMinutes(30), TimeSpan.Zero);
        }
        return (JObject)HttpRuntime.Cache.Get("user$" + GetCurrentUserId());
      }
      catch (Exception ex)
      {

        throw new ApplicationException("获取用户信息出错："+ex.Message);
      }
    }

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

# asp.net  # MVC使用rest  # mvc  # rest  # ASP.NET Core构建OData查询Restful API  # 使用ASP.NET Web API构建Restful API  # 使用ASP.Net WebAPI构建REST服务  # 的是  # 我在  # 应用程序  # 为空  # 自己的  # 我要  # 成了  # 还没  # 你就  # 最多  # 也要  # 给他  # 其他的  # 我这  # 你想  # 要把  # 相关文章  # 我用  # 对其  # 这样一个 

相关文章： 零服务器AI建站解决方案：快速部署与云端平台低成本实践  如何在Golang中指定模块版本_使用go.mod控制版本号  5种Android数据存储方式汇总  在线教育网站制作平台,山西立德教育官网？  零基础网站服务器架设实战：轻量应用与域名解析配置指南  C#怎么使用委托和事件 C# delegate与event编程方法  制作网站的公司有哪些,做一个公司网站要多少钱？  如何选择适合PHP云建站的开源框架？  东莞市网站制作公司有哪些,东莞找工作用什么网站好？  北京网站制作公司哪家好一点,北京租房网站有哪些？  广州网站设计制作一条龙,广州巨网网络科技有限公司是干什么的？  已有域名和空间，如何快速搭建网站？  香港服务器网站推广：SEO优化与外贸独立站搭建策略  建站主机是什么？如何选择适合的建站主机？  如何通过免费商城建站系统源码自定义网站主题与功能？  上海网站制作开发公司,上海买房比较好的网站有哪些？  C++如何使用std::optional？（处理可选值）  如何选择长沙网站建站模板？H5响应式与品牌定制哪个更优？  专业网站建设制作报价,网页设计制作要考什么证？  购物网站制作公司有哪些,哪个购物网站比较好？  如何快速搭建高效WAP手机网站？  历史网站制作软件,华为如何找回被删除的网站？  存储型VPS适合搭建中小型网站吗？  如何高效利用亚马逊云主机搭建企业网站？  建站之星备案是否影响网站上线时间？  网站制作的步骤包括,正确网址格式怎么写？  广平建站公司哪家专业可靠？如何选择？  如何构建满足综合性能需求的优质建站方案？  网站广告牌制作方法,街上的广告牌，横幅，用PS还是其他软件做的？  较简单的网站制作软件有哪些,手机版网页制作用什么软件？  内网网站制作软件,内网的网站如何发布到外网？  如何正确下载安装西数主机建站助手？  设计网站制作公司有哪些,制作网页教程？  如何选择香港主机高效搭建外贸独立站？  jQuery 常见小例汇总  如何通过可视化优化提升建站效果？  如何在腾讯云服务器上快速搭建个人网站？  建站之星后台管理系统如何操作？  如何基于云服务器快速搭建网站及云盘系统？  如何挑选高效建站主机与优质域名？  微信h5制作网站有哪些,免费微信H5页面制作工具？  如何快速配置高效服务器建站软件？  家庭建站与云服务器建站，如何选择更优？  如何在万网开始建站？分步指南解析  小型网站制作HTML,*游戏网站怎么搭建？  建站之星导航配置指南：自助建站与SEO优化全解析  代购小票制作网站有哪些,购物小票的简要说明？  Swift中循环语句中的转移语句 break 和 continue  如何挑选最适合建站的高性能VPS主机？  惠州网站建设制作推广,惠州市华视达文化传媒有限公司怎么样？