为RESTful Web服务启用跨源请求

本指南将引导您完成使用Spring创建“ Hello，World” RESTful Web服务的过程，该服务在响应中包括跨域资源共享（CORS）的标头。您可以在此博客文章中找到有关Spring CORS支持的更多信息。

你会建立什么

您将构建一个服务，该服务在接受HTTP GET请求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服务中描述的服务略有不同，因为它使用Spring Framework CORS支持来添加相关的CORS响应标头。

你需要什么

约15分钟
最喜欢的文本编辑器或IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还可以将代码直接导入到IDE中：
- 弹簧工具套件（STS）
- IntelliJ IDEA

如何完成本指南

像大多数Spring入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用代码。

要从头开始，请继续进行“从Spring Initializr开始”。

要跳过基础知识，请执行以下操作：

下载并解压缩本指南的源存储库，或使用Git对其进行克隆：git clone https://github.com/spring-guides/gs-rest-service-cors.git
光盘进入 gs-rest-service-cors/initial
继续创建资源表示形式类。

完成后，您可以根据中的代码检查结果gs-rest-service-cors/complete。

从Spring Initializr开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（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/> <!-- lookup parent from repository -->
	</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以生成具有所需依赖项的新项目（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()
}

手动初始化（可选）

如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：

导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。
单击Dependencies，然后选择Spring Web。
点击生成。
下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。

如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。

添加`httpclient`依赖

测试（中的complete/src/test/java/com/example/restservicecors/GreetingIntegrationTests.java）需要Apachehttpclient库。

要将Apachehttpclient库添加到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/> <!-- lookup parent from repository -->
	</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>

要将Apachehttpclient库添加到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注释轻松标识，并且GreetingController以下清单（从中src/main/java/com/example/restservicecors/GreetingController.java）中显示的内容通过返回该类的新实例来处理GET请求：/greetingGreeting

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则使用of 。

方法主体的实现创建并返回一个新Greeting对象，该id属性的值基于的下一个值，counter而的值content基于查询参数或默认值。它还name通过使用Greeting格式化给定的格式template。

传统的MVC控制器和RESTful Web服务控制器之间的主要区别在于创建HTTP响应主体的方式。RESTful Web服务控制器填充并返回一个Greeting对象，而不是依赖于视图技术来执行问候语数据到HTML的服务器端渲染。对象数据作为JSON直接写入HTTP响应。

为此，{RestController} [ @RestController]注释假定每个方法@ResponseBody默认都继承了语义。因此，将返回的对象数据直接插入到响应主体中。

得益于Spring的HTTP消息转换器支持，该Greeting对象自然可以转换为JSON。由于Jackson在类路径中，因此MappingJackson2HttpMessageConverter会自动选择Spring的将Greeting实例转换为JSON。

启用CORS

您可以从单个控制器或全局控制器中启用跨域资源共享（CORS）。以下主题描述了如何执行此操作：

控制器方法CORS配置
全局CORS配置

控制器方法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注释中指定的所有来源，所有标头和HTTP方法。另外，使用maxAge30分钟。您可以通过指定以下注释属性之一的值来自定义此行为：

origins
methods
allowedHeaders
exposedHeaders
allowCredentials
maxAge。

在此示例中，我们仅允许http://localhost:8080发送跨域请求。

您也可以@CrossOrigin在控制器类级别添加注释，以在此类的所有处理程序方法上启用CORS。

全局CORS配置

除了（或作为替代）细粒度的基于注释的配置，您还可以定义一些全局CORS配置。这类似于使用a，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在浏览器中访问以下内容：

{"id":1,"content":"Hello, World!"}

name通过访问提供查询字符串参数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客户端来使用该服务。以下清单显示了这样的客户端：

首先，创建一个名为hello.js（from complete/public/hello.js）的简单Javascript文件，其内容如下：

$(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。它由加载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>

从本质上讲，这是在使用jQuery消费RESTful Web服务中创建的REST客户端，对其进行了稍作修改以在服务在端口8080的本地主机上运行时使用该服务。有关如何开发此客户端的更多详细信息，请参见该指南。

要启动客户端在本地主机上运行的端口8080，请运行以下Maven命令：

./mvnw spring-boot:run

如果使用Gradle，则可以使用以下命令：

./gradlew bootRun

应用启动后，在浏览器中打开http：// localhost：8080，您将在其中看到以下内容：

要测试CORS行为，您需要从其他服务器或端口启动客户端。这样做不仅避免了两个应用程序之间的冲突，而且还确保了从与服务不同的来源提供客户端代码。要启动在本地主机上运行的应用程序在端口9000（以及已经在端口8080上运行的应用程序），请运行以下Maven命令：

./mvnw spring-boot:run -Dserver.port=9000

如果使用Gradle，则可以使用以下命令：

./gradlew bootRun --args="--server.port=9000"

应用启动后，在浏览器中打开http：// localhost：9000，您将在其中看到以下内容：

如果响应中包含正确的CORS标头，则将从REST服务检索的模型数据呈现到DOM中。

如果服务响应包含CORS标头，则ID和内容将呈现到页面中。但是，如果缺少CORS标头（或对于客户端而言不足），则浏览器将使请求失败，并且不会将值呈现到DOM中。

概括

恭喜你！您刚刚开发了一个RESTful Web服务，其中包括与Spring的跨域资源共享。

也可以看看

以下指南也可能会有所帮助：

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。

为RESTful Web服务启用跨源请求

你会建立什么

你需要什么

如何完成本指南

从Spring Initializr开始

手动初始化（可选）

添加httpclient依赖

创建资源表示形式类

创建一个资源控制器

启用CORS

控制器方法CORS配置

全局CORS配置

创建应用程序类

建立可执行的JAR

测试服务

概括

也可以看看

添加`httpclient`依赖