通过微软的cors类库,让ASP.NET Web API 支持 CORS
前言:因为公司项目需要搭建一个Web API 的后端,用来传输一些数据以及文件,之前有听过Web API的相关说明,但是真正实现的时候,感觉还是需要挺多知识的,正好今天有空,整理一下这周关于解决CORS的问题,让自己理一理相关的知识。
ASP.NET Web API支持CORS方式,据我目前在网上搜索,有两种方式
- 通过扩展CorsMessageHandle实现: http://www.cnblogs.com/artech/p/cors-4-asp-net-web-api-04.html
- 通过微软的 AspNet.WebApi.Cors 类库实现 http://www.asp.net/web-api/overview/security/enabling-cross-origin-requests-in-web-api#intro
本文主要是利用AspNet.WebApi.Cors 类库实现CORS,因为在选择的过程中,发现扩展的CorsMessageHandle会有一些限制,因为真正项目的HTTP Request 是Rang Request.
你需要了解的一些知识
- Web API 2.0 http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api
- 同源策略与JSONP http://www.cnblogs.com/artech/p/cors-4-asp-net-web-api-01.html
- CORS http://www.cnblogs.com/artech/p/cors-4-asp-net-web-api-02.html
1.创建Web API (myservice.azurewebsites.net)
这个简单放上图:
1.1
1.2
1.3
1.4
1.5
1.6将下面的code替代原来的TestController
using System.Net.Http; using System.Web.Http;namespace WebService.Controllers {public class TestController : ApiController{public HttpResponseMessage Get(){return new HttpResponseMessage(){Content = new StringContent("GET: Test message")};}public HttpResponseMessage Post(){return new HttpResponseMessage(){Content = new StringContent("POST: Test message")};}public HttpResponseMessage Put(){return new HttpResponseMessage(){Content = new StringContent("PUT: Test message")};}} }
1.7 可以测试创建的Web API是否可以正常工作
2.创建Client端(myclilent.azurewebsites.net)
这也是可以简单上图:
2.1
2.2
2.3 找到 Client端的 Views/Home/Index.cshtml,用下面代码替代
<div><select id="method"><option value="get">GET</option><option value="post">POST</option><option value="put">PUT</option></select><input type="button" value="Try it" onclick="sendRequest()" /><span id='value1'>(Result)</span> </div>@section scripts { <script>var serviceUrl = 'http://myservice.azurewebsites.net/api/test'; // Replace with your URI.function sendRequest() {var method = $('#method').val();$.ajax({type: method,url: serviceUrl}).done(function (data) {$('#value1').text(data);}).error(function (jqXHR, textStatus, errorThrown) {$('#value1').text(jqXHR.responseText || textStatus);});} </script> }
2.4用例外一个域名发布网站,然后进入Index 页面,选择 GET,POST,PUT 等,点击 Try it 按钮,就会发送请求到Web API, 因为Web API没有开启CORS,而通过AJAX请求,浏览器会提示 错误
3.Web API支持CORS
3.1打开VS,工具->库程序包管理器->程序包管理器控制台 ,输入下列命令:Install-Package Microsoft.AspNet.WebApi.Cors -Version 5.0.0
注意 :目前Nuget 上面最新的版本是5.2.0 ,但是我测试,下载的时候,会有一些关联的类库不是最新的,System.Net.Http.Formatting 要求是5.2,我在网上找不带这dll,因此建议安装 :Microsoft.AspNet.WebApi.Cors 5.0就OK了。
Nuget 科普link: http://www.cnblogs.com/dubing/p/3630434.html
3.2 打开 WebApiConfig.Register 添加 config.EnableCors()
using System.Web.Http; namespace WebService {public static class WebApiConfig{public static void Register(HttpConfiguration config){// New code config.EnableCors();config.Routes.MapHttpRoute(name: "DefaultApi",routeTemplate: "api/{controller}/{id}",defaults: new { id = RouteParameter.Optional });}} }
3.3 添加[EnableCors] 特性 到 TestController
using System.Net.Http; using System.Web.Http; using System.Web.Http.Cors;namespace WebService.Controllers {[EnableCors(origins: "http://myclient.azurewebsites.net", headers: "*", methods: "*")]public class TestController : ApiController{// Controller methods not shown... } }
3.4回到Client端,这时再次发送请求,会提示成功信息,证明CORS已经实现了。
4.为[EnableCors]设置到 Action, Controller, Globally
4.1Action
public class ItemsController : ApiController {public HttpResponseMessage GetAll() { ... }[EnableCors(origins: "http://www.example.com", headers: "*", methods: "*")]public HttpResponseMessage GetItem(int id) { ... }public HttpResponseMessage Post() { ... }public HttpResponseMessage PutItem(int id) { ... } }
4.2Controller
[EnableCors(origins: "http://www.example.com", headers: "*", methods: "*")] public class ItemsController : ApiController {public HttpResponseMessage GetAll() { ... }public HttpResponseMessage GetItem(int id) { ... }public HttpResponseMessage Post() { ... }[DisableCors]public HttpResponseMessage PutItem(int id) { ... } }
4.3Globally
public static class WebApiConfig {public static void Register(HttpConfiguration config){var cors = new EnableCorsAttribute("www.example.com", "*", "*");config.EnableCors(cors);// ... } }
5.[EnableCors]工作原理
要理解CORS成功的原理,我们可以来查看一下
跨域的请求
GET http://myservice.azurewebsites.net/api/test HTTP/1.1
Referer: http://myclient.azurewebsites.net/
Accept: */*
Accept-Language: en-US
Origin: http://myclient.azurewebsites.net
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)
Host: myservice.azurewebsites.net
当发送请求的时候,浏览器会将“Origin”的请求头发送给 服务端,如果服务端允许跨域请求,那么响应回来的请求头,添加“Access-Control-Allow-Origin”,以及将请求过来的 域名 的value添加到 Access-Control-Allow-Origin,浏览器接收到这个 请求头,则会显示返回的数据,否则,即使服务端成功返回数据,浏览器也不会接收
服务器的响应
HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Type: text/plain; charset=utf-8 Access-Control-Allow-Origin: http://myclient.azurewebsites.net Date: Wed, 05 Jun 2013 06:27:30 GMT Content-Length: 17GET: Test message
6.自定义CORS Policy Providers
6.1除了使用自带的[EnableCors]特性外,我们可以自定义自己的[EnableCors]。首先是要继承Attribute 和 ICorsPolicyProvider 接口
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false)] public class MyCorsPolicyAttribute : Attribute, ICorsPolicyProvider {private CorsPolicy _policy;public MyCorsPolicyAttribute(){// Create a CORS policy._policy = new CorsPolicy{AllowAnyMethod = true,AllowAnyHeader = true};// Add allowed origins._policy.Origins.Add("http://myclient.azurewebsites.net");_policy.Origins.Add("http://www.contoso.com");}public Task<CorsPolicy> GetCorsPolicyAsync(HttpRequestMessage request){return Task.FromResult(_policy);} }
实现后,可以添加自己定义的[MyCorsPolicy]
[MyCorsPolicy] public class TestController : ApiController {.. //
6.2或者你也可以从配置文件中读取 允许的域名
public class CorsPolicyFactory : ICorsPolicyProviderFactory {ICorsPolicyProvider _provider = new MyCorsPolicyProvider();public ICorsPolicyProvider GetCorsPolicyProvider(HttpRequestMessage request){return _provider;} } public static class WebApiConfig {public static void Register(HttpConfiguration config){config.SetCorsPolicyProviderFactory(new CorsPolicyFactory());config.EnableCors();// ... } }
转载于:https://www.cnblogs.com/xhhha/p/3837277.html
通过微软的cors类库,让ASP.NET Web API 支持 CORS相关推荐
- ASP.NET Web API自身对CORS的支持:从实例开始
在<通过扩展让ASP.NET Web API支持W3C的CORS规范>中我们通过自定义的HttpMessageHandler为ASP.NET Web API赋予了跨域资源共享的能力,具体来 ...
- ASP.NET Web API自身对CORS的支持: CORS授权检验的实施
通过<EnableCorsAttribute特性背后的故事>我们知道:由CorsPolicyProvider提供的CorsPolicy表示目标Action采用的资源授权策略,ASP.NET ...
- ASP.NET Web API 记录请求响应数据到日志的一个方法
原文:ASP.NET Web API 记录请求响应数据到日志的一个方法 原文:http://blog.bossma.cn/dotnet/asp-net-web-api-log-request-resp ...
- ASP.NET Web API 简介
本周早些时候,我写过一篇关于 ASP. NET MVC 4 测试版的博文.ASP. NET MVC 4 是一个重大的更新,它带来了一堆出色的新功能.我最兴奋的改进之一是为创建"Web ApI ...
- jquery ajax跨域asp,jQuery跨域调用Asp.Net Web API
Asp.Net Web API是一个轻量级的Web服务,当Web API和Web程序不是部署在同一域的时候,要使用jQuery来实现调用API的接口就存在跨域的问题.下面介绍两种方式来解决jQuery ...
- 关于操作 ASP.NET Web API的实例
WCF的野心造成了它的庞大复杂,HTTP的单纯造就了它的简单优美.为了实现分布式Web应用,我们不得不将两者凑合在一起 -- WCF服务以HTTP绑定宿主于IIS. 于是有了让人晕头转向的配置.让人郁 ...
- 《ASP.NET Web API 2框架揭秘》
<ASP.NET Web API 2框架揭秘> 基本信息 作者: 蒋金楠 出版社:电子工业出版社 ISBN:9787121235368 上架时间:2014-7-5 出版日期:2014 年7 ...
- ASP NET Web API 2框架揭秘
ASP.NET Web API2框架揭秘(.NET领域再现力作顶级专家精讲微软全新轻量级通信平台) 蒋金楠 著 ISBN 978-7-121-23536-8 2014年7月出版 定价:108.00 ...
- Asp.Net Web API 2第一课——入门
前言 Http不仅仅服务于Web Pages.它也是一个创建展示服务和数据的API的强大平台.Http是简单的.灵活的.无处不在的.你能想象到几乎任何的平台都会有HTTP服务库.HTTP服务可以涉及到 ...
最新文章
- oracle 取系统当前年份_oracle查询以当前年份为准的近些年数据
- 2022年想成为软件测试工程师,这个学习路线收藏起来
- uboot学习之BL3的流程
- Java设计模式 - 适配器模式
- python基础教程: os.stat() 和 stat模块详解
- operator-sdk安装脚本整理
- 运维:Windows 系统安全日志中登录类型介绍
- [react] 在React中怎么引用sass或less?
- 【python毕业设计】Django框架实现学生信息管理系统
- java 2d划线 刷子_月光软件站 - 编程文档 - Java - Java图形设计中,利用Bresenham算法实现直线线型,线宽的控制(NO 2D GRAPHICS)...
- 2019 年编写现代 JavaScript 代码的5个小技巧
- 【Java基础】final关键字总结
- maya对象属性_了解每粒子属性和每对象属性
- Centos上禁用 rpcbind 111端口
- 阶段3 3.SpringMVC·_03.SpringMVC常用注解_8 SessionAttributes注解
- 视频教程-java项目实战之欢乐斗地主游戏开发教程 毕业项目课程设计带源码-Java
- 360公司 2020秋招 技术综合E卷 在线考试 编程题 第一题 表面积(web前端)
- Transact-SQL语言基础语句
- 使用 Windows XP 的外观风格
- WCF服务三:svc文件详解
热门文章
- Facebook如何向十亿人推荐东西
- 【MDCC 2015】开源选型之Android三大图片缓存原理、特性对比
- 重写 View 的 Touch 方法,实现一个酷炫的九宫格图片
- 《C Primer Plus》读书笔记——存储类、链接和内存管理
- http://www.cnblogs.com/qtqq/p/5271164.html
- 1.3 计划需求控制
- 解决oracle ORA-01078,LRM-00109故障一例!
- Windows server 2003下Oracle10g安装图解
- 5月30日,社区活动:SharePoint技术峰会
- 局域网通过专线上网的维护经验点滴