跨域共享CORS詳解及Gin配置跨域

時間  2020-11-29
標籤 html 前端 git github web json 後端 api 跨域 瀏覽器 欄目 HTML 简体版
原文   原文鏈接

跨域簡介

當兩個域具備相同的協議(如http), 相同的端口(如80)，相同的host，那麼咱們就能夠認爲它們是相同的域（協議，域名，端口都必須相同）。
跨域就指着協議，域名，端口不一致，出於安全考慮，跨域的資源之間是沒法交互的(例如通常狀況跨域的JavaScript沒法交互，固然有不少解決跨域的方案)html

解決跨域幾種方案

/*
    CORS 普通跨域請求：只服務端設置Access-Control-Allow-Origin便可，
    前端無須設置，若要帶cookie請求：先後端都須要設置。
		
    JSONP 缺點：只能使用get 請求
    document.domain 僅限主域相同，子域不一樣的跨域應用場景。
    window.name
    websockets
*/

跨域資源共享CORS

CORS是一個W3C標準，全稱是"跨域資源共享"（Cross-origin resource sharing）。前端

它容許瀏覽器向跨源服務器，發出XMLHttpRequest請求，從而克服了AJAX只能同源使用的限制。git

Cors簡介

CORS須要瀏覽器和服務器同時支持。目前，全部瀏覽器都支持該功能，IE瀏覽器不能低於IE10。github

整個CORS通訊過程，都是瀏覽器自動完成，不須要用戶參與。對於開發者來講，CORS通訊與同源的AJAX通訊沒有差異，代碼徹底同樣。瀏覽器一旦發現AJAX請求跨源，就會自動添加一些附加的頭信息，有時還會多出一次附加的請求，但用戶不會有感受。web

所以，實現CORS通訊的關鍵是服務器。只要服務器實現了CORS接口，就能夠跨源通訊。json

兩種請求

瀏覽器將CORS請求分紅兩類：簡單請求（simple request）和非簡單請求（not-so-simple request）。後端

知足如下兩大條件,屬於簡單請求api

/*
    （1) 請求方法是如下三種方法之一：
        HEAD
        GET
        POST
    （2）HTTP的頭信息不超出如下幾種字段：
        Accept
        Accept-Language
        Content-Language
        Last-Event-ID
        Content-Type：只限於三個值application/x-www-form-urlencoded、multipart/form-data、text/plain
*/

這是爲了兼容表單（form），由於歷史上表單一直能夠發出跨域請求。AJAX 的跨域設計就是，只要表單能夠發，AJAX 就能夠直接發。跨域

凡是不一樣時知足上面兩個條件，就屬於非簡單請求。瀏覽器

瀏覽器對這兩種請求的處理，是不同的。

簡單請求

基本流程

對於簡單請求，瀏覽器直接發出CORS請求。具體來講，就是在頭信息之中，增長一個Origin字段。

下面是一個例子，瀏覽器發現此次跨源AJAX請求是簡單請求，就自動在頭信息之中，添加一個Origin字段。

/*
    GET /cors HTTP/1.1
    Origin: http://api.bob.com
    Host: api.alice.com
    Accept-Language: en-US
    Connection: keep-alive
    User-Agent: Mozilla/5.0...
*/

上面的頭信息中，Origin字段用來講明，本次請求來自哪一個源（協議 + 域名 + 端口）。服務器根據這個值，決定是否贊成此次請求。

若是Origin指定的源，不在許可範圍內，服務器會返回一個正常的HTTP迴應。瀏覽器發現，這個迴應的頭信息沒有包含Access-Control-Allow-Origin字段（詳見下文），就知道出錯了，從而拋出一個錯誤，被XMLHttpRequest的onerror回調函數捕獲。注意，這種錯誤沒法經過狀態碼識別，由於HTTP迴應的狀態碼有多是200。

若是Origin指定的域名在許可範圍內，服務器返回的響應，會多出幾個頭信息字段。

/*
    Access-Control-Allow-Origin: http://api.bob.com
    Access-Control-Allow-Credentials: true
    Access-Control-Expose-Headers: FooBar
    Content-Type: text/html; charset=utf-8
*/

上面的頭信息之中，有三個與CORS請求相關的字段，都以Access-Control-開頭。

1 . Access-Control-Allow-Origin

該字段是必須的,他的值要麼是請求Origin字段的值,要麼是一個*, 表示接受任意域名的請求.

2 . Access-Control-Allow-Credentials

該字段可選。它的值是一個布爾值，表示是否容許發送Cookie。默認狀況下，Cookie不包括在CORS請求之中。設爲true，即表示服務器明確許可，Cookie能夠包含在請求中，一塊兒發給服務器。這個值也只能設爲true，若是服務器不要瀏覽器發送Cookie，刪除該字段便可.

3 . Access-Control-Expose-Headers

該字段可選。CORS請求時，XMLHttpRequest對象的getResponseHeader()方法只能拿到6個基本字段：Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。若是想拿到其餘字段，就必須在Access-Control-Expose-Headers裏面指定。上面的例子指定，getResponseHeader('FooBar')能夠返回FooBar字段的值。

withCredentials屬性

上面說到，CORS請求默認不發送Cookie和HTTP認證信息。若是要把Cookie發到服務器，一方面要服務器贊成，指定Access-Control-Allow-Credentials字段。

// Access-Control-Allow-Credentials: true

另外一方面，開發者必須在AJAX請求中打開withCredentials屬性。

// var xhr = new XMLHttpRequest();
// xhr.withCredentials = true;

不然，即便服務器贊成發送Cookie，瀏覽器也不會發送。或者，服務器要求設置Cookie，瀏覽器也不會處理。

可是，若是省略withCredentials設置，有的瀏覽器仍是會一塊兒發送Cookie。這時，能夠顯式關閉withCredentials。

// xhr.withCredentials = false;

須要注意的是，若是要發送Cookie，Access-Control-Allow-Origin就不能設爲星號，必須指定明確的、與請求網頁一致的域名。同時，Cookie依然遵循同源政策，只有用服務器域名設置的Cookie纔會上傳，其餘域名的Cookie並不會上傳，且（跨源）原網頁代碼中的document.cookie也沒法讀取服務器域名下的Cookie。

非簡單請求

預檢請求

非簡單請求是那種對服務器有特殊要求的請求，好比請求方法是PUT或DELETE，或者Content-Type字段的類型是application/json。

非簡單請求的CORS請求，會在正式通訊以前，增長一次HTTP查詢請求，稱爲"預檢"請求（preflight）。

瀏覽器先詢問服務器，當前網頁所在的域名是否在服務器的許可名單之中，以及可使用哪些HTTP動詞和頭信息字段。只有獲得確定答覆，瀏覽器纔會發出正式的XMLHttpRequest請求，不然就報錯。

下面是一段瀏覽器的JavaScript腳本。

var url = 'http://api.alice.com/cors';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();

上面代碼中，HTTP請求的方法是PUT，而且發送一個自定義頭信息X-Custom-Header。

瀏覽器發現，這是一個非簡單請求，就自動發出一個"預檢"請求，要求服務器確承認以這樣請求。下面是這個"預檢"請求的HTTP頭信息。

OPTIONS /cors HTTP/1.1
Origin: http://api.bob.com
Access-Control-Request-Method: PUT
Access-Control-Request-Headers: X-Custom-Header
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...

"預檢"請求用的請求方法是OPTIONS，表示這個請求是用來詢問的。頭信息裏面，關鍵字段是Origin，表示請求來自哪一個源。

除了Origin字段，"預檢"請求的頭信息包括兩個特殊字段

/*
  （1）Access-Control-Request-Method
  該字段是必須的，用來列出瀏覽器的CORS請求會用到哪些HTTP方法，上例是PUT。

  （2）Access-Control-Request-Headers
  該字段是一個逗號分隔的字符串，指定瀏覽器CORS請求會額外發送的頭信息字段，上例是X-Custom-Header。
*/

預檢請求的迴應

服務器收到"預檢"請求之後，檢查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段之後，確認容許跨源請求，就能夠作出迴應。

HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:39 GMT
Server: Apache/2.0.61 (Unix)
Access-Control-Allow-Origin: http://api.bob.com
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Content-Type: text/html; charset=utf-8
Content-Encoding: gzip
Content-Length: 0
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
Content-Type: text/plain

上面的HTTP迴應中，關鍵的是Access-Control-Allow-Origin字段，表示http://api.bob.com能夠請求數據。該字段也能夠設爲星號，表示贊成任意跨源請求。

Access-Control-Allow-Origin: *

若是服務器否認了"預檢"請求，會返回一個正常的HTTP迴應，可是沒有任何CORS相關的頭信息字段。這時，瀏覽器就會認定，服務器不一樣意預檢請求，所以觸發一個錯誤，被XMLHttpRequest對象的onerror回調函數捕獲。控制檯會打印出以下的報錯信息。

XMLHttpRequest cannot load http://api.alice.com.
Origin http://api.bob.com is not allowed by Access-Control-Allow-Origin.

服務器迴應的其餘CORS相關字段以下。

/*
    Access-Control-Allow-Methods: GET, POST, PUT
    Access-Control-Allow-Headers: X-Custom-Header
    Access-Control-Allow-Credentials: true
    Access-Control-Max-Age: 1728000
*/
字段說明

1.Access-Control-Allow-Origin

首先，客戶端請求時要帶上一個Origin，用來講明，本次請求來自哪一個源（協議 + 域名 + 端口）。服務器根據這個值，決定是否贊成此次請求。而後服務端在返回時須要帶上這個字段，並把對方傳過來的值返回去。告知客戶端，容許此次請求。
這個字段也能夠設置爲*，即容許全部客戶端訪問。可是這樣作會和Access-Control-Allow-Credentials 起衝突。可能致使跨域請求失敗。

2.Access-Control-Allow-Credentials

這個字段是一個BOOL值，能夠容許客戶端攜帶一些校驗信息，好比cookie等。若是設置爲Access-Control-Allow-Origin：*，而該字段是true，而且客戶端開啓了withCredentials, 仍然不能正確訪問。須要把Access-Control-Allow-Origin的值設置爲客戶端傳過來的值。

3.Access-Control-Allow-Credentials

該字段與簡單請求時的含義相同。

4.Access-Control-Max-Age

該字段可選，用來指定本次預檢請求的有效期，單位爲秒。上面結果中，有效期是20天（1728000秒），即容許緩存該條迴應1728000秒（即20天），在此期間，不用發出另外一條預檢請求。

瀏覽器的正常請求和迴應

一旦服務器經過了"預檢"請求，之後每次瀏覽器正常的CORS請求，就都跟簡單請求同樣，會有一個Origin頭信息字段。服務器的迴應，也都會有一個Access-Control-Allow-Origin頭信息字段。

下面是"預檢"請求以後，瀏覽器的正常CORS請求。

/*
		PUT /cors HTTP/1.1
    Origin: http://api.bob.com
    Host: api.alice.com
    X-Custom-Header: value
    Accept-Language: en-US
    Connection: keep-alive
    User-Agent: Mozilla/5.0...
*/

上面頭信息的Origin字段是瀏覽器自動添加的。

下面是服務器正常的迴應。

/*
    Access-Control-Allow-Origin: http://api.bob.com
    Content-Type: text/html; charset=utf-8
*/
與JSONP的比較
/*
		CORS與JSONP的使用目的相同，可是比JSONP更強大。

		JSONP只支持GET請求，CORS支持全部類型的HTTP請求。JSONP的優點在於支持老式瀏覽器，
		以及能夠向不支持CORS的網站請求數據。
*/

開啓中間件進行跨域

安裝cors包
govendor fetch github.com/gin-contrib/cors
配置cors跨域
package main
import (
    "github.com/gin-gonic/gin"
    "strings"
    "fmt"
    "net/http"
)

func main() {
        r := gin.Default()
        r.Use(Cors()) //開啓中間件 容許使用跨域請求
        r.run()
}

func Cors() gin.HandlerFunc {
    return func(c *gin.Context) {
        method := c.Request.Method
        origin := c.Request.Header.Get("Origin") //請求頭部
        if origin != "" {
            //接收客戶端發送的origin （重要！）
            c.Writer.Header().Set("Access-Control-Allow-Origin", origin) 
            //服務器支持的全部跨域請求的方法
            c.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE,UPDATE") 
            //容許跨域設置能夠返回其餘子段，能夠自定義字段
            c.Header("Access-Control-Allow-Headers", "Authorization, Content-Length, X-CSRF-Token, Token,session")
            // 容許瀏覽器（客戶端）能夠解析的頭部 （重要）
            c.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers") 
            //設置緩存時間
            c.Header("Access-Control-Max-Age", "172800") 
            //容許客戶端傳遞校驗信息好比 cookie (重要)
            c.Header("Access-Control-Allow-Credentials", "true")                                                                                                                                                                                                                          
        }

        //容許類型校驗 
        if method == "OPTIONS" {
            c.JSON(http.StatusOK, "ok!")
        }

        defer func() {
            if err := recover(); err != nil {
                log.Printf("Panic info is: %v", err)
            }
        }()

        c.Next()
    }
}

Example

// 處理跨域請求,支持options訪問
func Cors() gin.HandlerFunc {
	return func(c *gin.Context) {
		method := c.Request.Method
 
		c.Header("Access-Control-Allow-Origin", "*")
		c.Header("Access-Control-Allow-Headers", "Content-Type,AccessToken,X-CSRF-Token, Authorization, Token")
		c.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS")
		c.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type")
		c.Header("Access-Control-Allow-Credentials", "true")
 
		//放行全部OPTIONS方法
		if method == "OPTIONS" {
			c.AbortWithStatus(http.StatusNoContent)
		}
		// 處理請求
		c.Next()
	}
}

CORS原理講解有部分借鑑於 阮一峯 寫的博客

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程