springboot跨域請求 · springboot官方文檔中文版

# 為RESTful Web服務啟用跨源請求本指南將引導您完成使用Spring創建“ Hello，World” RESTful Web服務的過程，該服務在響應中包括跨域資源共享（CORS）的標頭。您可以在此找到有關Spring CORS支持的更多信息 [博客文章中](https://spring.io/blog/2015/06/08/cors-support-in-spring-framework) 。 ## 你會建立什么您將在以下位置構建一個接受HTTP GET請求的服務 `[http://localhost:8080/greeting](http://localhost:8080/greeting)` 并以問候語的JSON表示形式進行響應，如以下清單所示： ~~~ {"id":1,"content":"Hello, World!"} ~~~ 您可以使用可選的自定義問候語 `name` 查詢字符串中的參數，如以下清單所示： ~~~ http://localhost:8080/greeting?name=User ~~~ 這 `name` 參數值會覆蓋默認值 `World` 并反映在響應中，如以下清單所示： ~~~ {"id":1,"content":"Hello, User!"} ~~~ 該服務與描述的服務略有不同 [構建RESTful Web服務中](https://spring.io/guides/gs/rest-service/) ，因為它使用Spring Framework CORS支持來添加相關的CORS響應標頭。 ## 你需要什么 * 約15分鐘 * 最喜歡的文本編輯器或IDE * [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本 * [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi) * 您還可以將代碼直接導入到IDE中： * [彈簧工具套件（STS）](https://spring.io/guides/gs/sts) * [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/) ## 如何完成本指南像大多數Spring 一樣 [入門指南](https://spring.io/guides) ，您可以從頭開始并完成每個步驟，也可以繞過您已經熟悉的基本設置步驟。無論哪種方式，您最終都可以使用代碼。要 **從頭開始** ，請繼續進行“ [從Spring Initializr開始”](https://spring.io/guides/gs/rest-service-cors/#scratch) 。要 **跳過基礎知識** ，請執行以下操作： * [下載](https://github.com/spring-guides/gs-rest-service-cors/archive/master.zip) 并解壓縮本指南的源存儲庫，或使用對其進行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-rest-service-cors.git](https://github.com/spring-guides/gs-rest-service-cors.git)` * 光盤進入 `gs-rest-service-cors/initial` * 繼續 [創建資源表示形式類](https://spring.io/guides/gs/rest-service-cors/#initial) 。 **完成后** ，您可以根據中的代碼檢查結果 `gs-rest-service-cors/complete`. ## 從Spring Initializr開始如果您使用Maven，請訪問 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=rest-service-cors&name=rest-service-cors&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.rest-service-cors&dependencies=web) 以生成具有所需依賴項的新項目（Spring Web）。以下清單顯示了 `pom.xml` 選擇Maven時創建的文件： ~~~ <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.4.3</version> <relativePath/>  </parent> <groupId>com.example</groupId> <artifactId>rest-service-cors</artifactId> <version>0.0.1-SNAPSHOT</version> <name>rest-service-cors</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ~~~ 如果您使用Gradle，請訪問 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=rest-service-cors&name=rest-service-cors&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.rest-service-cors&dependencies=web) 以生成具有所需依賴項的新項目（Spring Web）。以下清單顯示了 `build.gradle` 選擇Gradle時創建的文件： ~~~ plugins { id 'org.springframework.boot' version '2.4.3' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' testImplementation 'org.springframework.boot:spring-boot-starter-test' } test { useJUnitPlatform() } ~~~ ### 手動初始化（可選）如果要手動初始化項目而不是使用前面顯示的鏈接，請按照以下步驟操作： 1. 導航到 [https://start.spring.io](https://start.spring.io) 。該服務提取應用程序所需的所有依賴關系，并為您完成大部分設置。 2. 選擇Gradle或Maven以及您要使用的語言。本指南假定您選擇了Java。 3. 單擊 **Dependencies，** 然后選擇 **Spring Web** 。 4. 點擊 **生成** 。 5. 下載生成的ZIP文件，該文件是使用您的選擇配置的Web應用程序的存檔。如果您的IDE集成了Spring Initializr，則可以從IDE中完成此過程。 ### 添加 `httpclient` 相依性測試（在 `complete/src/test/java/com/example/restservicecors/GreetingIntegrationTests.java`）需要Apache `httpclient` 圖書館。添加Apache `httpclient` 庫到Maven，添加以下依賴項： ~~~ <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <scope>test</scope> </dependency> ~~~ 以下清單顯示了成品 `pom.xml` 文件： ~~~ <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.4.3</version> <relativePath/>  </parent> <groupId>com.example</groupId> <artifactId>rest-service-cors</artifactId> <version>0.0.1-SNAPSHOT</version> <name>rest-service-cors</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ~~~ 添加Apache `httpclient`庫到Gradle，添加以下依賴項： ~~~ testImplementation 'org.apache.httpcomponents:httpclient' ~~~ 以下清單顯示了成品 `build.gradle` 文件： ~~~ plugins { id 'org.springframework.boot' version '2.4.3' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' testImplementation 'org.apache.httpcomponents:httpclient' testImplementation 'org.springframework.boot:spring-boot-starter-test' } test { useJUnitPlatform() } ~~~ ## 創建資源表示形式類現在您已經設置了項目和構建系統，您可以創建Web服務。通過考慮服務交互來開始該過程。該服務將處理 `GET` 要求 `/greeting`，還可以加上一個 `name`查詢字符串中的參數。這 `GET` 請求應返回一個 `200 OK`正文中使用JSON表示問候。它應類似于以下清單： ~~~ { "id": 1, "content": "Hello, World!" } ~~~ 這 `id` 字段是問候語的唯一標識符，并且 `content` 是問候語的文字表示。要建模問候表示，請創建資源表示類。為普通的Java對象提供字段，構造函數和訪問器，以用于 `id` 和 `content` 數據，如下清單（來自 `src/main/java/com/example/restservicecors/Greeting.java`）顯示： ~~~ package com.example.restservicecors; public class Greeting { private final long id; private final String content; public Greeting() { this.id = -1; this.content = ""; } public Greeting(long id, String content) { this.id = id; this.content = content; } public long getId() { return id; } public String getContent() { return content; } } ~~~ Spring使用 Jackson JSON 庫自動封送類型的實例 Greeting 轉換成JSON。 ## 創建一個資源控制器在Spring的構建RESTful Web服務的方法中，HTTP請求由控制器處理。這些組成部分很容易由 [`@Controller`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/stereotype/Controller.html) 注釋，以及 `GreetingController` 在下面的清單中顯示（來自 `src/main/java/com/example/restservicecors/GreetingController.java`）手柄 `GET` 要求 `/greeting` 通過返回一個新的實例 `Greeting` 班級： ~~~ package com.example.restservicecors; import java.util.concurrent.atomic.AtomicLong; import org.springframework.web.bind.annotation.CrossOrigin; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController public class GreetingController { private static final String template = "Hello, %s!"; private final AtomicLong counter = new AtomicLong(); @CrossOrigin(origins = "http://localhost:8080") @GetMapping("/greeting") public Greeting greeting(@RequestParam(required = false, defaultValue = "World") String name) { System.out.println("==== get greeting ===="); return new Greeting(counter.incrementAndGet(), String.format(template, name)); } } ~~~ 該控制器簡潔明了，但是內部卻有很多事情要做。我們將其逐步分解。這 `@RequestMapping` 注釋可確保HTTP請求 `/greeting` 映射到 `greeting()` 方法。前面的示例使用 @GetMapping 批注，用作快捷方式 @RequestMapping(method = RequestMethod.GET)。我們用 GET在這種情況下，因為它便于測試。如果原點與CORS配置不匹配，Spring仍將拒絕GET請求。瀏覽器不需要發送CORS預檢請求，但是我們可以使用 @PostMapping 并在主體中接受一些JSON（如果我們想觸發飛行前檢查）。 `@RequestParam` 綁定 `name` 查詢字符串參數到 `name` 的參數 `greeting()`方法。此查詢字符串參數不是 `required`。如果請求中不存在，則 `defaultValue` 的 `World` 用來。方法主體的實現創建并返回一個新的 `Greeting` 對象，其值 `id` 屬性基于 `counter` 和的價值 `content`基于查詢參數或默認值。它還格式化給定的 `name` 通過使用問候語 `template`. 傳統的MVC控制器和RESTful Web服務控制器之間的主要區別在于創建HTTP響應主體的方式。 RESTful Web服務控制器填充并返回一個 `Greeting`目的。對象數據作為JSON直接寫入HTTP響應。為此，{RestController} \[ `@RestController`\]注釋假定每個方法都繼承了 [`@ResponseBody`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/ResponseBody.html)默認情況下的語義。因此，將返回的對象數據直接插入到響應主體中。借助Spring的HTTP消息轉換器支持， `Greeting`對象自然轉換為JSON。因為 [杰克遜](https://wiki.fasterxml.com/JacksonHome) 在課堂上，春天的 [`MappingJackson2HttpMessageConverter`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/http/converter/json/MappingJackson2HttpMessageConverter.html) 自動選擇以轉換 `Greeting` 實例轉換為JSON。 ## 啟用CORS 您可以從單個控制器或全局控制器中啟用跨域資源共享（CORS）。以下主題描述了如何執行此操作： * [控制器方法CORS配置](https://spring.io/guides/gs/rest-service-cors/#controller-method-cors-configuration) * [全局CORS配置](https://spring.io/guides/gs/rest-service-cors/#global-cors-configuration) ### 控制器方法CORS配置為了使RESTful Web服務的響應中包含CORS訪問控制標頭，您必須添加一個 `@CrossOrigin` 注釋到處理程序方法，如下面的清單（從 `src/main/java/com/example/restservicecors/GreetingController.java`）顯示： ~~~ @CrossOrigin(origins = "http://localhost:8080") @GetMapping("/greeting") public Greeting greeting(@RequestParam(required = false, defaultValue = "World") String name) { System.out.println("==== get greeting ===="); return new Greeting(counter.incrementAndGet(), String.format(template, name)); ~~~ 這個 `@CrossOrigin`注釋僅針對此特定方法啟用跨域資源共享。默認情況下，它允許在 `@RequestMapping`注解。亦是 `maxAge`使用30分鐘。您可以通過指定以下注釋屬性之一的值來自定義此行為： * `origins` * `methods` * `allowedHeaders` * `exposedHeaders` * `allowCredentials` * `maxAge`. 在此示例中，我們僅允許 `[http://localhost:8080](http://localhost:8080)` 發送跨域請求。您也可以添加 @CrossOrigin 控制器類級別的注釋，也可以在此類的所有處理程序方法上啟用CORS。 ### 全局CORS配置除了（或作為替代）細粒度的基于注釋的配置，您還可以定義一些全局CORS配置。這類似于使用 `Filter` 但可以在Spring MVC中聲明并與細粒度組合 `@CrossOrigin`配置。默認情況下，所有來源和 `GET`, `HEAD`，和 `POST` 允許使用方法。以下清單（來自 `src/main/java/com/example/restservicecors/GreetingController.java`）顯示 `greetingWithJavaconfig` 中的方法 `GreetingController` 班級： ~~~ @GetMapping("/greeting-javaconfig") public Greeting greetingWithJavaconfig(@RequestParam(required = false, defaultValue = "World") String name) { System.out.println("==== in greeting ===="); return new Greeting(counter.incrementAndGet(), String.format(template, name)); ~~~ 兩者之間的區別 greetingWithJavaconfig 方法和 greeting方法（在控制器級別的CORS配置中使用）是路由（ /greeting-javaconfig 而不是 /greeting）和 @CrossOrigin 起源。以下清單（來自 `src/main/java/com/example/restservicecors/RestServiceCorsApplication.java`）展示了如何在應用程序類中添加CORS映射： ~~~ public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurer() { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/greeting-javaconfig").allowedOrigins("http://localhost:8080"); } }; } ~~~ 您可以輕松更改任何屬性（例如 `allowedOrigins` （在示例中），并將此CORS配置應用于特定的路徑模式。您可以結合全局和控制器級別的CORS配置。 ## 創建應用程序類 Spring Initializr為您創建一個準系統應用程序類。以下清單（來自 `initial/src/main/java/com/example/restservicecors/RestServiceCorsApplication.java`）顯示了該初始課程： ~~~ package com.example.restservicecors; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class RestServiceCorsApplication { public static void main(String[] args) { SpringApplication.run(RestServiceCorsApplication.class, args); } } ~~~ 您需要添加一種方法來配置如何處理跨域資源共享。以下清單（來自 `complete/src/main/java/com/example/restservicecors/RestServiceCorsApplication.java`）顯示了如何執行此操作： ~~~ @Bean public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurer() { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/greeting-javaconfig").allowedOrigins("http://localhost:8080"); } }; } ~~~ 以下清單顯示了完整的應用程序類： ~~~ package com.example.restservicecors; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @SpringBootApplication public class RestServiceCorsApplication { public static void main(String[] args) { SpringApplication.run(RestServiceCorsApplication.class, args); } @Bean public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurer() { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/greeting-javaconfig").allowedOrigins("http://localhost:8080"); } }; } } ~~~ `@SpringBootApplication` 是一個方便注釋，它添加了以下所有內容： * `@Configuration`：將類標記為應用程序上下文的Bean定義的源。 * `@EnableAutoConfiguration`：告訴Spring Boot根據類路徑設置，其他bean和各種屬性設置開始添加bean。例如，如果 `spring-webmvc` 在類路徑上，此注釋將應用程序標記為Web應用程序并激活關鍵行為，例如設置 `DispatcherServlet`. * `@ComponentScan`：告訴Spring在服務器中尋找其他組件，配置和服務 `com/example` 包，讓它找到控制器。這 `main()` 方法使用Spring Boot的 `SpringApplication.run()`啟動應用程序的方法。您是否注意到沒有一行XML？沒有 `web.xml`文件。該Web應用程序是100％純Java，因此您無需處理任何管道或基礎結構。 ### 建立可執行的JAR 您可以使用Gradle或Maven從命令行運行該應用程序。您還可以構建一個包含所有必需的依賴項，類和資源的可執行JAR文件，然后運行該文件。生成可執行jar使得在整個開發生命周期中，跨不同環境等等的情況下，都可以輕松地將服務作為應用程序進行發布，版本控制和部署。如果您使用Gradle，則可以通過使用以下命令運行該應用程序 `./gradlew bootRun`。或者，您可以通過使用以下命令構建JAR文件： `./gradlew build` 然后運行JAR文件，如下所示： ~~~ java -jar build/libs/gs-rest-service-cors-0.1.0.jar ~~~ 如果您使用Maven，則可以通過使用以下命令運行該應用程序 `./mvnw spring-boot:run`。或者，您可以使用以下命令構建JAR文件： `./mvnw clean package` 然后運行JAR文件，如下所示： ~~~ java -jar target/gs-rest-service-cors-0.1.0.jar ~~~ 此處描述的步驟將創建可運行的JAR。您還可以構建經典的WAR文件。顯示日志記錄輸出。該服務應在幾秒鐘內啟動并運行。 ## 測試服務現在服務已啟動，請訪問 `[http://localhost:8080/greeting](http://localhost:8080/greeting)` 在瀏覽器中，您應該看到： ~~~ {"id":1,"content":"Hello, World!"} ~~~ 提供一個 `name` 通過訪問查詢字符串參數 `[http://localhost:8080/greeting?name=User](http://localhost:8080/greeting?name=User)`。的價值 `content` 屬性更改自 `Hello, World!` 到 `Hello User!`，如以下清單所示： ~~~ {"id":2,"content":"Hello, User!"} ~~~ 此更改表明 `@RequestParam` 安排在 `GreetingController`可以正常工作。這 `name` 參數已賦予默認值 `World` 但始終可以通過查詢字符串顯式覆蓋。另外， `id` 屬性已從更改 `1` 到 `2`。這證明您正在反對同一個 `GreetingController` 跨多個請求的實例， `counter` 每次調用都按預期增加字段。現在，您可以測試CORS標頭是否存在，并允許其他來源的Javascript客戶端訪問該服務。為此，您需要創建一個Javascript客戶端來使用該服務。以下清單顯示了這樣的客戶端：首先，創建一個簡單的Javascript文件，名為 `hello.js` （從 `complete/public/hello.js`），其內容如下： ~~~ $(document).ready(function() { $.ajax({ url: "http://localhost:8080/greeting" }).then(function(data, status, jqxhr) { $('.greeting-id').append(data.id); $('.greeting-content').append(data.content); console.log(jqxhr); }); }); ~~~ 該腳本使用jQuery在以下位置使用REST服務 `[http://localhost:8080/greeting](http://localhost:8080/greeting)`。它由加載 `index.html`，如以下清單（來自 `complete/public/index.html`）顯示： ~~~ <!DOCTYPE html> <html> <head> <title>Hello CORS</title> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script> <script src="hello.js"></script> </head> <body> <div> <p class="greeting-id">The ID is </p> <p class="greeting-content">The content is </p> </div> </body> </html> ~~~ 從本質上講，這是在創建的REST客戶端使用jQuery消費RESTful Web服務中，對其進行了稍作修改以在服務在端口8080的本地主機上運行時使用該服務。有關如何開發此客戶端的更多詳細信息，請參見該指南。要啟動客戶端在本地主機上運行的端口8080，請運行以下Maven命令： ~~~ ./mvnw spring-boot:run ~~~ 如果使用Gradle，則可以使用以下命令： ~~~ ./gradlew bootRun ~~~ 應用啟動后，打開 [http：// localhost：8080](http://localhost:8080) 在瀏覽器中，您將在其中看到以下內容： ![如果響應中缺少CORS標頭，則瀏覽器將使請求失敗。沒有數據將被渲染到DOM中。](https://github.com/spring-guides/gs-rest-service-cors/raw/master/images/hello.png) 要測試CORS行為，您需要從其他服務器或端口啟動客戶端。這樣做不僅避免了兩個應用程序之間的沖突，而且還確保了從與服務不同的來源提供客戶端代碼。要啟動在本地主機上運行的應用程序在端口9000（以及已經在端口8080上運行的應用程序），請運行以下Maven命令： ~~~ ./mvnw spring-boot:run -Dserver.port=9000 ~~~ 如果使用Gradle，則可以使用以下命令： ~~~ ./gradlew bootRun --args="--server.port=9000" ~~~ 應用啟動后，打開 [http：// localhost：9000](http://localhost:9000) 在瀏覽器中，您將在其中看到以下內容： ![如果響應中包含正確的CORS標頭，則將從REST服務檢索的模型數據呈現到DOM中。](https://github.com/spring-guides/gs-rest-service-cors/raw/master/images/hello_fail.png) 如果服務響應包含CORS標頭，則ID和內容將呈現到頁面中。但是，如果缺少CORS標頭（或對于客戶端而言不足），則瀏覽器將使請求失敗，并且不會將值呈現到DOM中。 ## 概括恭喜你！您剛剛開發了一個RESTful Web服務，其中包括與Spring的跨域資源共享。