詳解SpringBoot應(yīng)用跨域訪問解決方案
一、什么是跨域訪問
說到跨域訪問,必須先解釋一個名詞:同源策略。所謂同源策略就是在瀏覽器端出于安全考量,向服務(wù)端發(fā)起請求必須滿足:協(xié)議相同、Host(ip)相同、端口相同的條件,否則訪問將被禁止,該訪問也就被稱為跨域訪問。
雖然跨域訪問被禁止之后,可以在一定程度上提高了應(yīng)用的安全性,但也為開發(fā)帶來了一定的麻煩。比如:我們開發(fā)一個前后端分離的易用,頁面及js部署在一個主機的nginx服務(wù)中,后端接口部署在一個tomcat應(yīng)用容器中,當(dāng)前端向后端發(fā)起請求的時候一定是不符合同源策略的,也就無法訪問。那么我們?nèi)绾谓鉀Q這個問題?就是本文需要向大家說明的內(nèi)容。
二、跨域訪問的解決方案有哪些?
2.1.第一類方案:前端解決方案
雖然瀏覽器對于不符合同源策略的訪問是禁止的,但是仍然存在例外的情況,如以下資源引用的標(biāo)簽不受同源策略的限制:
- html的script標(biāo)簽
- html的link標(biāo)簽
- html的img標(biāo)簽
- html的iframe標(biāo)簽:對于使用jsp、freemarker開發(fā)的項目,這是實現(xiàn)跨域訪問最常見的方法,
除了基于HTML本身的特性實現(xiàn)跨域訪問,我們還可以使用jsonp、window的postMessage實現(xiàn)跨域訪問。這些都是前端實現(xiàn)跨域訪問的方式。
2.2.第二類方案:使用代理
實際上對跨域訪問的支持在服務(wù)端實現(xiàn)起來更加容易,最常用的方法就是通過代理的方式,如:
- nginx或haproxy代理跨域
- nodejs中間件代理跨域
其實實現(xiàn)代理跨域的邏輯非常簡單:就是在不同的資源服務(wù):js資源、html資源、css資源、接口數(shù)據(jù)資源服務(wù)的前端搭建一個中間層,所有的瀏覽器及客戶端訪問都通過代理轉(zhuǎn)發(fā)。所以在瀏覽器、客戶端看來,它們訪問的都是同一個ip、同一個端口的資源,從而符合同源策略實現(xiàn)跨域訪問。
2.3 第三類方案:CORS
跨域資源共享(CORS):通過修改Http協(xié)議header的方式,實現(xiàn)跨域。說的簡單點就是,通過設(shè)置HTTP的響應(yīng)頭信息,告知瀏覽器哪些情況在不符合同源策略的條件下也可以跨域訪問,瀏覽器通過解析Http協(xié)議中的Header執(zhí)行具體判斷。具體的Header如下:
CROS跨域常用header
- Access-Control-Allow-Origin: 允許哪些ip或域名可以跨域訪問
- Access-Control-Max-Age: 表示在多少秒之內(nèi)不需要重復(fù)校驗該請求的跨域訪問權(quán)限
- Access-Control-Allow-Methods: 表示允許跨域請求的HTTP方法,如:GET,POST,PUT,DELETE
- Access-Control-Allow-Headers: 表示訪問請求中允許攜帶哪些Header信息,如:
Accept
、Accept-Language
、Content-Language
、Content-Type
三、SpringBoot下實現(xiàn)CORS的四種方式
為大家介紹四種實現(xiàn)CORS的方法,兩種是全局配置,兩種是局部接口生效的配置。一般來說,SpringBoot項目采用其中一種方式實現(xiàn)CORS即可。
3.1.使用CorsFilter進(jìn)行全局跨域配置
- @Configuration
- public class GlobalCorsConfig {
- @Bean
- public CorsFilter corsFilter() {
- CorsConfiguration config = new CorsConfiguration();
- //開放哪些ip、端口、域名的訪問權(quán)限,星號表示開放所有域
- config.addAllowedOrigin("*");
- //是否允許發(fā)送Cookie信息
- config.setAllowCredentials(true);
- //開放哪些Http方法,允許跨域訪問
- config.addAllowedMethod("GET","POST", "PUT", "DELETE");
- //允許HTTP請求中的攜帶哪些Header信息
- config.addAllowedHeader("*");
- //暴露哪些頭部信息(因為跨域訪問默認(rèn)不能獲取全部頭部信息)
- config.addExposedHeader("*");
- //添加映射路徑,“/**”表示對所有的路徑實行全局跨域訪問權(quán)限的設(shè)置
- UrlBasedCorsConfigurationSource configSource = new UrlBasedCorsConfigurationSource();
- configSource.registerCorsConfiguration("/**", config);
- return new CorsFilter(configSource);
- }
- }
3.2. 重寫WebMvcConfigurer的addCorsMappings方法(全局跨域配置)
- @Configuration
- public class GlobalCorsConfig {
- @Bean
- public WebMvcConfigurer corsConfigurer() {
- return new WebMvcConfigurer() {
- @Override
- public void addCorsMappings(CorsRegistry registry) {
- registry.addMapping("/**") //添加映射路徑,“/**”表示對所有的路徑實行全局跨域訪問權(quán)限的設(shè)置
- .allowedOrigins("*") //開放哪些ip、端口、域名的訪問權(quán)限
- .allowCredentials(true) //是否允許發(fā)送Cookie信息
- .allowedMethods("GET","POST", "PUT", "DELETE") //開放哪些Http方法,允許跨域訪問
- .allowedHeaders("*") //允許HTTP請求中的攜帶哪些Header信息
- .exposedHeaders("*"); //暴露哪些頭部信息(因為跨域訪問默認(rèn)不能獲取全部頭部信息)
- }
- };
- }
- }
3.3.使用CrossOrigin注解(局部跨域配置)
- 將CrossOrigin注解加在Controller層的方法上,該方法定義的RequestMapping端點將支持跨域訪問
- 將CrossOrigin注解加在Controller層的類定義處,整個類所有的方法對應(yīng)的RequestMapping端點都將支持跨域訪問
- @RequestMapping("/cors")
- @ResponseBody
- @CrossOrigin(origins = "http://localhost:8080", maxAge = 3600)
- public String cors( ){
- return "cors";
- }
3.4 使用HttpServletResponse設(shè)置響應(yīng)頭(局部跨域配置)
這種方式略顯麻煩,不建議在SpringBoot項目中使用。
- @RequestMapping("/cors")
- @ResponseBody
- public String cors(HttpServletResponse response){
- //使用HttpServletResponse定義HTTP請求頭,最原始的方法也是最通用的方法
- response.addHeader("Access-Control-Allow-Origin", "http://localhost:8080");
- return "cors";
- }
四、實現(xiàn)與測試
在SpringBoot 項目外 隨便定義一個HTML,并寫代碼觸發(fā)如下的ajax代碼。(觸發(fā)過程我就不寫了,定義一個按鈕加一個監(jiān)聽函數(shù)即可)。以下是跨域AJAX請求驗證的核心代碼:
- $.ajax({
- url: 'http://localhost:8090/cors',
- type: "POST",
- xhrFields: {
- withCredentials: true //允許發(fā)送Cookie信息
- },
- success: function (data) {
- alert("跨域請求配置成功")
- },
- error: function (data) {
- alert("跨域請求配置失敗")
- }
- })
- 跨域請求配置成功表示:我們的跨域配置生效,ajax請求可以正確訪問服務(wù)端接口。
- 跨域請求配置失敗表示:我們的跨域配置未生效,請參照檢查第三節(jié)檢查各項配置是否正確。