Vapor文档学习卅四: HTTP -CORS

CORS(Cross-Origin Resource Sharing),跨原始资源共享。Vapor默认使用CORSMiddleware实现了一定程度的跨资源共享。
“CORS是允许真正开放性跨域访问的规范。如果你的服务器提供了公共资源,请在通用的JavaScript驱动的浏览器中借助CORS进行访问。”--https://enable-cors.org/
如果要了解更多关于Middleware的知识,请参考Middleware章节。

CORS.png

图片作者: Wikipedia

Basic

首先将CORS的middleware添加到Droplet中:

# Insert CORS before any other middlewares
drop.middleware.insert(CORSMiddleware(), at: 0)

注意:确保在任何其他middleware之前插入CORSmiddleware,如AbortMiddleware或类似的。 否则,正确的header可能不会添加到响应中。

CORSMiddleware的默认配置能够满足多数用户使用,配置值如下:

  • Allowed Origin
    • 请求中原始header的值
  • Allowed Method
  • GET,POST, PUT, OPTIONS, DELETE, PATCH
  • Allowed Headers
  • Accept, Authorization, Content-Type, Origin, X-Requested-With

Advanced

所有设置和预设可以由高级用户自定义。 有两种方式可以进行自定义设置:1,通过代码创建和配置CORSConfiguration对象;2,将配置置于Vapor的JSON配置文件中。
有关如何设置这两个选项,请参见以下内容。

Configuration

CORSConfiguration结构体是用来配置CORSMiddleware的。下面是对其进行实例化:

let configuration = CORSConfiguration(allowedOrigin: .custom("https://vapor.codes"),
                                          allowedMethods: [.get, .post, .options],
                                          allowedHeaders: ["Accept", "Authorization"],
                                          allowCredentials: false,
                                          cacheExpiration: 600,
                                          exposedHeaders: ["Cache-Control", "Content-Language"])

配置完成之后可以添加CORSMiddleware了:

drop.middleware.insert(CORSMiddleware(configuration: configuration), at: 0)

注意:如果想了解更多可以配置的值,请查看CORSConfiguration的源码。

JSON Config

另外,CORSMiddleware可以使用由Config文件夹中包含的.json文件进行配置。 你需要在项目的Config文件夹中创建一个名为cors.jsonCORS.json的文件,并添加所需的键值(配置项)。
示例:

{
    "allowedOrigin": "origin",
    "allowedMethods": "GET,POST,PUT,OPTIONS,DELETE,PATCH",
    "allowedHeaders": ["Accept", "Authorization", "Content-Type", "Origin", "X-Requested-With"]
}

注意:allowedOriginallowedMethodsallowedHeaders是必须配置的。 如果不存在,则会在实例化middleware时抛出异常。
另外,allowCredentials(Bool),cacheExpiration(Int)和exposedHeaders([String])是可选的配置。

然后可以通过接收Config的初始化方法重载配置信息,并将middleware添加到Droplet中。

let drop = Droplet()

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

推荐阅读更多精彩内容