.NET Core API CORS

最近参与一个前后端分离的项目,后端基于 .NET Core 2.1 开发,在进行前后端对接的过程中,被跨域问题折腾得有点脾气了,这里把经验和大家分享一下。

GET/POST 请求

在服务端不做任何调整的情况下,前端发起 AJAX 请求,如:

$.ajax({
  type: 'get',
  url: 'http://localhost:5000',
  success: function (result) {
    $('#result').html(result);
  }
});
get/post result

200 !!!好像很正常的样子,看似没毛病。但会发现 Response 内屁都没有,然后回到浏览器 Console 查看会有一个错误信息,提示不支持跨域访问,凉凉。

not allowed access

JSONP

在遇到跨域问题时很容易想到 JSONP 的解决方式,但也只限于 GET 请求,POST 据说比较艰难,我自己也没试用,这里就不测试了。

$.ajax({
  type: 'get',
  url: 'http://localhost:5000/home/jsonpTest',
  data: {
    name: 'beck'
  },
  dataType: "jsonp",
  jsonpCallback: "jsonpCallback",
  success: function (result) {
    $('#result').html(result.Data);
  }
});
jsonp result

那么现在问题来了,JSONP 和 GET 请求毕竟有自身的一些限制,如果非要 POST 怎么办?那就选择 CORS 吧 !

CORS

CORS (Cross-Origin Resource Sharing, 跨源资源共享) 是W3C出的一个标准,其思想是使用自定义的 HTTP 头部让浏览器与服务器进行沟通,从而决定请求或响应是应该成功,还是应该失败。CORS 与 JSONP 都可以做到跨源资源共享,但与 JSONP 不同,CORS 可以支持除 GET 方式以外所有类型的 HTTP 请求。

在介绍实现方式之前先简单了解部分 CORS 相关的理论,不然可能对遇到的问题会有点懵,特别其中的 OPTIONS 请求,明明设置的是 GET、POST 方式,怎么就多出一个 OPTIONS 请求?

CORS 请求分简单请求和复杂请求:

简单请求

同时满足以下条件的归类为简单请求:

  1. 请求方式是 HEAD 、GET、POST中的一种;

  2. HTTP的头信息不超出 Accept、Accept-Language、Content-
    Language、Last-Event-ID、Content-Type 字段;

  3. Content-Type 只限于 application/x-www-form-urlencoded、multipart/form-data、text/plain 三个之一;

简单请求只需要服务端设置 Access-Control-Allow-Origin 允许请求来源地址即可,我们可以在 .NET Core API 项目的 Startup.cs 中进行如下调整:

public void ConfigureServices(IServiceCollection services)
{
  // 添加支持跨域请求
  services.AddCors(); 
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  // 设置允许的请求来源,我本地请求发起方所在地址是 http://localhost:53894 
  app.UseCors(options => options.WithOrigins("http://localhost:53894")); 
}

前端发起 GET 或 POST 请求:

$.ajax({
  type: 'post',
  url: 'http://localhost:5000/home/fromFormTest',
  data: {
    name: 'beck'
  },
  success: function (result) {
    $('#result').html(result.data);
  }
});
cors simple request

复杂请求

不满足简单请求条件的统一归类为复杂请求,复杂请求会在正式通信之前增加一次 OPTIONS 请求,称为 "预检" 请求,通过预检请求中的返回头信息,判断当前请求是否被允许。

我们可以设置 contentType 为 application/json,此请求就变成了复杂请求:

$.ajax({
  type: 'post',
  url: 'http://localhost:5000/home/fromBodyTest',
  contentType: 'application/json',
  data: JSON.stringify({
    name: 'beck'
  }),
  success: function (result) {
    $('#result').html(result.data);
  }
});

如果 API 项目中的 Startup.cs 保持上面的调整后不变,会看到 OPTIONS 请求中Response Headers 信息并没有出现允许请求的源地址 Access-Control-Allow-Origin ,这就代表预检失败了,继续凉凉。

options request failed

这是因为在预检请求的返回头中还必须要设置 Access-Control-Request-Method 和 Access-Control-Request-Headers。app.UseCors 是支持设置某些头信息或者某些请求类型,这些在使用时看实际情况而定。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  // 设置允许的请求来源地址、头信息、请求类型
  app.UseCors(options => options
    .WithOrigins("http://localhost:53894")
    .AllowAnyHeader()
    .AllowAnyMethod()
  );
}
options request success

预检通过之后,会发起 POST 请求:

post request success

Cookie

如果请求需要携带 Cookie 到服务端,那还需要稍微做一些调整,如下:

Startup.cs 增加 AllowCredentials 配置:

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  // 设置允许的请求来源地址、头信息、请求类型、Cookie
  app.UseCors(options => options
    .WithOrigins("http://localhost:53894")
    .AllowAnyHeader()
    .AllowAnyMethod()
    .AllowCredentials()
  );
}

AJAX 请求中也需要增加 withCredentials 设置:

setCookie('name', 'test');
$.ajax({
  type: 'post',
  url: 'http://localhost:5000/home/fromBodyTest',
  contentType: 'application/json',
  data: JSON.stringify({
    name: 'beck'
  }),
  xhrFields: {
    withCredentials: true
  },
  success: function (result) {
    $('#result').html(result.data);
  }
});

通过以上代码简单的修改,就实现了 CORS 。在实际的内网或生产环境,可能会从运维层面通过 Nginx 或者其他的设置做到不修改代码也能完美支持。

参考资料

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 161,326评论 4 369
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,228评论 1 304
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,979评论 0 252
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,489评论 0 217
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,894评论 3 294
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,900评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,075评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,803评论 0 205
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,565评论 1 249
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,778评论 2 253
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,255评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,582评论 3 261
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,254评论 3 241
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,151评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,952评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,035评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,839评论 2 277

推荐阅读更多精彩内容