asp.net MVC下使用rest的方法

发布时间 - 2026-01-11 03:17:19    点击率:

前言

最近做了下个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服务  # 的是  # 我在  # 应用程序  # 为空  # 自己的  # 我要  # 成了  # 还没  # 你就  # 最多  # 也要  # 给他  # 其他的  # 我这  # 你想  # 要把  # 相关文章  # 我用  # 对其  # 这样一个 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel Blade模板引擎语法_Laravel Blade布局继承用法  如何获取免费开源的自助建站系统源码?  装修招标网站设计制作流程,装修招标流程?  C#如何调用原生C++ COM对象详解  高防服务器租用指南:配置选择与快速部署攻略  网站建设要注意的标准 促进网站用户好感度!  如何用腾讯建站主机快速创建免费网站?  Laravel广播系统如何实现实时通信_Laravel Reverb与WebSockets实战教程  齐河建站公司:营销型网站建设与SEO优化双核驱动策略  手机怎么制作网站教程步骤,手机怎么做自己的网页链接?  Laravel如何使用Scope本地作用域_Laravel模型常用查询逻辑封装技巧【手册】  网站广告牌制作方法,街上的广告牌,横幅,用PS还是其他软件做的?  教你用AI润色文章,让你的文字表达更专业  高端网站建设与定制开发一站式解决方案 中企动力  ,怎么在广州志愿者网站注册?  Laravel怎么实现验证码(Captcha)功能  Laravel如何获取当前用户信息_Laravel Auth门面获取用户ID  详解Nginx + Tomcat 反向代理 如何在高效的在一台服务器部署多个站点  如何快速搭建高效WAP手机网站吸引移动用户?  网站建设保证美观性,需要考虑的几点问题!  如何在新浪SAE免费搭建个人博客?  如何用已有域名快速搭建网站?  Laravel如何创建自定义Facades?(详细步骤)  Windows11怎样设置电源计划_Windows11电源计划调整攻略【指南】  Java Adapter 适配器模式(类适配器,对象适配器)优缺点对比  如何用IIS7快速搭建并优化网站站点?  详解免费开源的.NET多类型文件解压缩组件SharpZipLib(.NET组件介绍之七)  Win11怎么更改系统语言为中文_Windows11安装语言包并设为显示语言  香港服务器网站测试全流程:性能评估、SEO加载与移动适配优化  Laravel用户密码怎么加密_Laravel Hash门面使用教程  个人摄影网站制作流程,摄影爱好者都去什么网站?  如何彻底卸载建站之星软件?  原生JS获取元素集合的子元素宽度实例  详解Huffman编码算法之Java实现  高端企业智能建站程序:SEO优化与响应式模板定制开发  韩国服务器如何优化跨境访问实现高效连接?  北京网站制作的公司有哪些,北京白云观官方网站?  弹幕视频网站制作教程下载,弹幕视频网站是什么意思?  Laravel如何设置定时任务(Cron Job)_Laravel调度器与任务计划配置  Android自定义控件实现温度旋转按钮效果  LinuxShell函数封装方法_脚本复用设计思路【教程】  深圳网站制作的公司有哪些,dido官方网站?  购物网站制作费用多少,开办网上购物网站,需要办理哪些手续?  Laravel观察者模式如何使用_Laravel Model Observer配置  php json中文编码为null的解决办法  大连网站制作公司哪家好一点,大连买房网站哪个好?  Laravel请求验证怎么写_Laravel Validator自定义表单验证规则教程  百度输入法ai组件怎么删除 百度输入法ai组件移除工具  如何快速辨别茅台真假?关键步骤解析  网站页面设计需要考虑到这些问题