一.同源策略
1.一個源的定義
如果兩個頁面的協議,端口(如果有指定)和域名都相同,則兩個頁面具有相同的源。
舉個例子:
下表給出了相對http://a.xyz.com/dir/page.html
同源檢測的示例:
URL | 結果 | 原因 |
---|---|---|
http://a.xyz.com/dir2/other.html | 成功 | |
http://a.xyz.com/dir/inner/another.html | 成功 | |
https://a.xyz.com/secure.html | 失敗 | 不同協議 ( https和http ) |
http://a.xyz.com:81/dir/etc.html | 失敗 | 不同端口 ( 81和80) |
http://a.opq.com/dir/other.html | 失敗 | 不同域名 ( xyz和opq) |
2.同源策略是什麼
-
同源策略是瀏覽器的一個安全功能,同源就是指
協議、域名、端口號相同
,不同源的客戶端腳本在沒有明確授權的情況下,不能讀寫對方資源。所以xyz.com
下的js腳本採用ajax
讀取abc.com
裏面的文件數據是會被拒絕的。 -
同源策略限制了從同一個源加載的文檔或腳本如何與來自另一個源的資源進行交互。這是一個用於隔離潛在惡意文件的重要安全機制。
3.不受同源策略限制的
-
頁面中的鏈接,重定向以及表單提交是不會受到同源策略限制的。
-
跨域資源的引入是可以的。但是js不能讀寫加載的內容。如嵌入到頁面中的
<script src="..."></script>,<img>,<link>,<iframe>
等。
二.CORS
1.CORS是什麼
CORS是一個W3C標準,全稱是"跨域資源共享"(Cross-origin resource sharing)。
- 它允許瀏覽器向跨源(協議 + 域名 + 端口)服務器,發出XMLHttpRequest請求,從而克服了AJAX只能同源使用的限制。
- CORS需要
瀏覽器和服務器同時支持
。它的通信過程,都是瀏覽器自動完成,不需要用戶參與。對於開發者來說,CORS通信與同源的AJAX/Fetch通信沒有差別,代碼完全一樣。- 瀏覽器一旦發現請求跨源,就會自動添加一些附加的頭信息,有時還會多出一次附加的請求,但用戶不會有感覺。
因此,
實現CORS通信的關鍵是服務器
。只要服務器實現了CORS接口,就可以跨源通信。
2.簡單請求與複雜請求
瀏覽器將CORS請求分成兩類:簡單請求(simple request)
和非簡單請求(not-so-simple request)
。
-
瀏覽器發出
CORS簡單請求
,只需要在頭信息之中增加一個Origin字段
。 -
瀏覽器發出
CORS非簡單請求
,會在正式通信之前,增加一次OPTIONS查詢請求,稱爲"預檢"請求(preflight
)。瀏覽器先詢問服務器,當前網頁所在的域名是否在服務器的許可名單之中
,以及可以使用哪些HTTP動詞和頭信息字段
。只有得到肯定答覆,瀏覽器纔會發出正式的XMLHttpRequest請求,否則就報錯
。
1.簡單請求與複雜請求區別
簡單請求: 只要同時滿足以下兩大條件,就屬於簡單請求。
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 就可以直接發。
複雜請求 : 凡是不同時滿足上面簡單請求兩個條件,就屬於非簡單請求。
2. 簡單請求實例
對於簡單請求,瀏覽器直接發出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-開頭
。
-
Access-Control-Allow-Origin
必填字段。它的值要麼是請求時Origin
字段的值,要麼是一個*
,表示接受任意域名的請求。 -
Access-Control-Allow-Credentials
選填字段。它的值是一個布爾值,表示是否允許發送Cookie。默認情況下,Cookie不包括在CORS請求之中。設爲true
,即表示服務器明確許可,Cookie可以包含在請求中,一起發給服務器。這個值也只能設爲true
,如果服務器不要瀏覽器發送Cookie,刪除該字段即可。 -
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。
3.複雜請求實例
最常見的情況,當我們使用put和delete請求
時,瀏覽器會先發送option(預檢)請求
下面是一段瀏覽器的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字段,"預檢"請求的頭信息包括兩個特殊字段。
Access-Control-Request-Method:
該字段是必須的,用來列出瀏覽器的CORS請求會用到哪些HTTP方法,上例是PUT。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
該字段必需,它的值是逗號分隔的一個字符串,表明服務器支持的所有跨域請求的方法。注意,返回的是所有支持的方法,而不單是瀏覽器請求的那個方法。這是爲了避免多次"預檢"請求。 -
Access-Control-Allow-Headers
如果瀏覽器請求包括Access-Control-Request-Headers
字段,則Access-Control-Allow-Headers
字段是必需的。它也是一個逗號分隔的字符串,表明服務器支持的所有頭信息字段,不限於瀏覽器在"預檢"中請求的字段。 -
Access-Control-Allow-Credentials
該字段與簡單請求時的含義相同。選填字段。它的值是一個布爾值,表示是否允許發送Cookie。默認情況下,Cookie不包括在CORS請求之中。設爲true,即表示服務器明確許可,Cookie可以包含在請求中,一起發給服務器。這個值也只能設爲true,如果服務器不要瀏覽器發送Cookie,刪除該字段即可。 -
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
上面頭信息中,Access-Control-Allow-Origin
字段是每次迴應都必定包含的。
3.詳解CROS響應頭
Access-Control-Allow-Origin:必填
。表示允許哪個域的請求
,它的值要麼是請求時Origin字段的具體值,要麼是一個*,表示接受任意域名的請求。
Access-Control-Allow-Methods:必填
。它的值是逗號分隔的一個具體的字符串或者*,表示服務器支持的所有跨域請求的類型(get/post等)
。注意,返回的是所有支持的方法,而不單是瀏覽器請求的那個方法。這是爲了避免多次"預檢"請求。
Access-Control-Expose-Headers:選填
。CORS請求時,XMLHttpRequest
對象的getResponseHeader()
方法只能拿到6個基本字段:Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma
。如果想拿到其他字段,就必須在Access-Control-Expose-Headers
裏面指定。
Access-Control-Allow-Credentials: 選填
。它的值是一個布爾值,表示是否允許發送Cookie.默認情況下,不發生Cookie,即:false
。對服務器有特殊要求的請求,比如請求方法是PUT或DELETE,或者Content-Type
字段的類型是application/json
,這個值只能設爲true。如果服務器不要瀏覽器發送Cookie,刪除該字段即可。
Access-Control-Max-Age:選填
,用來指定本次預檢請求的有效期,單位爲秒。在有效期間,不用發出另一條預檢請求。
順便提一下: 如果在開發中,發現每次發起請求都是兩條
,一次OPTIONS,一次正常請求
,!!!注意是每次!!!,那麼就需要配置Access-Control-Max-Age,避免每次都發出預檢請求。
三.基於配置類@Configuration方式
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class CorsConfig implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowedMethods("GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS")
.allowCredentials(true)
.maxAge(3600)
.allowedHeaders("*");
}
}
這種方式是全局配置的,網上也大都是這種解決辦法,但是很多都是基於舊的spring版本,比如:
Spring Boot如何解決前端的Access-Control-Allow-Origin跨域問題
文中WebMvcConfigurerAdapter在spring5.0
已經被標記爲Deprecated,點開源碼可以看到
/**
* An implementation of {@link WebMvcConfigurer} with empty methods allowing
* subclasses to override only the methods they're interested in.
*
* @author Rossen Stoyanchev
* @since 3.1
* @deprecated as of 5.0 {@link WebMvcConfigurer} has default methods (made
* possible by a Java 8 baseline) and can be implemented directly without the
* need for this adapter
*/
@Deprecated
public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {}
像這種過時的類或者方法,spring的作者們一定會在註解上面說明原因,並告訴你新的該用哪個,這是非常優秀的編碼習慣,點贊!
spring5最低支持到jdk1.8,所以註釋中明確表明,你可以直接實現WebMvcConfigurer接口,無需再用這個適配器,因爲jdk1.8支持接口中存在default-method。
四.基於過濾器方式
import org.springframework.context.annotation.Configuration;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebFilter(filterName = "CorsFilter ")
@Configuration
public class CorsFilter implements Filter {
@Override
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
HttpServletResponse response = (HttpServletResponse) res;
response.setHeader("Access-Control-Allow-Origin","*");
response.setHeader("Access-Control-Allow-Credentials", "true");
response.setHeader("Access-Control-Allow-Methods", "POST, GET, PATCH, DELETE, PUT");
response.setHeader("Access-Control-Max-Age", "3600");
response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
chain.doFilter(req, res);
}
}
這種辦法,是基於過濾器的方式,方式簡單明瞭,就是在response中寫入這些響應頭,好多文章都是第一種和第二種方式都叫你配置,其實這是沒有必要的,只需要一種即可。
五.基於@CrossOrigin註解方式
public class GoodsController {
@CrossOrigin(origins = "http://localhost:4000")
@GetMapping("goods-url")
public Response queryGoodsWithGoodsUrl(@RequestParam String goodsUrl) throws Exception {}
}
沒錯就是**@CrossOrigin**註解,點開註解
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CrossOrigin {}
從元註解@Target可以看出,註解可以放在method、class等上面,類似RequestMapping,也就是說,整個controller下面的方法可以都受控制,也可以單個方法受控制。
也可以得知,這個是最小粒度的cors控制辦法了,精確到單個請求級別。