为 RESTful Web 服务启用跨源请求

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

你将建造什么

您将构建一个服务，该服务接受 HTTP GET 请求并以http://localhost:8080/greeting问候语的 JSON 表示形式进行响应，如以下清单所示：

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

您可以使用查询字符串中的可选参数自定义问候语name，如以下清单所示：

COPYhttp://localhost:8080/greeting?name=User

参数name值会覆盖默认值World并反映在响应中，如下清单所示：

COPY{"id":1,"content":"Hello, User!"}

此服务与构建 RESTful Web 服务中描述的服务略有不同，因为它使用 Spring Framework CORS 支持来添加相关的 CORS 响应标头。

你需要什么

约15分钟
最喜欢的文本编辑器或 IDE
Java 17或更高版本
Gradle 7.5+或Maven 3.5+
您还可以将代码直接导入到 IDE 中：

如何完成本指南

与大多数 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初始化开始

您可以使用此预初始化项目并单击“生成”来下载 ZIP 文件。该项目配置为适合本教程中的示例。

手动初始化项目：

导航到https://start.spring.io。该服务会提取应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假设您选择 Java。
单击依赖项并选择Spring Web。
单击“生成”。
下载生成的 ZIP 文件，该文件是根据您的选择配置的 Web 应用程序的存档。

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

您还可以从 Github 分叉该项目并在 IDE 或其他编辑器中打开它。

添加`httpclient5`依赖项

测试（在参考资料中complete/src/test/java/com/example/restservicecors/GreetingIntegrationTests.java）需要 Apachehttpclient5库。

要将 Apachehttpclient5库添加到 Maven，请添加以下依赖项：

COPY<dependency>
  <groupId>org.apache.httpcomponents.client5</groupId>
  <artifactId>httpclient5</artifactId>
  <scope>test</scope>
</dependency>

以下清单显示了完成的pom.xml文件：

COPY<?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>3.2.0</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>rest-service-cors-complete</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>rest-service-cors-complete</name>
	<description>Demo project for Spring Boot</description>
	<properties>
		<java.version>17</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.apache.httpcomponents.client5</groupId>
			<artifactId>httpclient5</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>

要将 Apachehttpclient5库添加到 Gradle，请添加以下依赖项：

COPYtestImplementation 'org.apache.httpcomponents.client5:httpclient5'

以下清单显示了完成的build.gradle文件：

COPYplugins {
	id 'org.springframework.boot' version '3.2.0'
	id 'io.spring.dependency-management' version '1.1.4'
	id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	testImplementation 'org.apache.httpcomponents.client5:httpclient5'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

test {
	useJUnitPlatform()
}

创建资源表示类

现在您已经设置了项目和构建系统，您可以创建 Web 服务。

从考虑服务交互开始这个过程。

该服务将处理GET对的请求，可以选择在查询字符串中/greeting包含一个参数。name该GET请求应返回200 OK正文中包含 JSON 的响应来表示问候语。它应该类似于以下列表：

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

该id字段是问候语的唯一标识符，并且content是问候语的文本表示形式。

要对问候表示进行建模，请创建一个资源表示类。id提供一个普通的旧 Java 对象，其中包含和数据的字段、构造函数和访问器content，如以下清单（来自src/main/java/com/example/restservicecors/Greeting.java）所示：

COPYpackage 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

COPYpackage 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:9000")
	@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在这种情况下使用是因为它方便测试。Spring 仍会拒绝源与 CORS 配置不匹配的 GET 请求。浏览器不需要发送 CORS 预检请求，但@PostMapping如果我们想触发预检检查，我们可以在正文中使用并接受一些 JSON。

@RequestParamname将查询字符串参数的值绑定到方法name的参数中greeting()。此查询字符串参数不是required。如果请求中不存在，则使用defaultValueof 。World

方法主体的实现创建并返回一个新Greeting对象，其属性值id基于的下一个值，counter并且的值content基于查询参数或默认值。它还name使用问候语来格式化给定的内容template。

传统 MVC 控制器和前面所示的 RESTful Web 服务控制器之间的主要区别在于创建 HTTP 响应正文的方式。此 RESTful Web 服务控制器填充并返回一个对象，而不是依赖视图技术在服务器端将问候数据呈现为 HTML Greeting。对象数据以 JSON 形式直接写入 HTTP 响应。

为了实现这一点，@RestController注释假定每个方法@ResponseBody默认继承语义。因此，返回的对象数据直接插入到响应主体中。

由于Spring的HTTP消息转换器支持，Greeting对象自然地转换为JSON。由于Jackson位于类路径上，因此MappingJackson2HttpMessageConverter会自动选择 Spring 将实例转换Greeting为 JSON。

启用 CORS

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

控制器方法 CORS 配置

为了使 RESTful Web 服务在其响应中包含 CORS 访问控制标头，您必须@CrossOrigin向处理程序方法添加注释，如以下清单（来自src/main/java/com/example/restservicecors/GreetingController.java）所示：

COPY	@CrossOrigin(origins = "http://localhost:9000")
	@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注释仅启用此特定方法的跨域资源共享。默认情况下，它允许注释中指定的所有来源、所有标头和 HTTP 方法@RequestMapping。另外，maxAge使用30分钟的时间。您可以通过指定以下注释属性之一的值来自定义此行为：

origins
originPatterns
methods
allowedHeaders
exposedHeaders
allowCredentials
maxAge。

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

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

全局 CORS 配置

除了（或作为替代）基于注释的细粒度配置之外，您还可以定义一些全局 CORS 配置。这与使用 a 类似Filter，但可以在 Spring MVC 中声明并与细粒度@CrossOrigin配置相结合。默认情况下，允许所有来源和GET、HEAD、和方法。POST

以下清单（来自参考资料src/main/java/com/example/restservicecors/GreetingController.java）显示了类greetingWithJavaconfig中的方法GreetingController：

COPY	@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方法和方法（在控制器级 CORS 配置greeting中使用）的区别在于路由（而不是）和起源的存在。/greeting-javaconfig/greeting@CrossOrigin

以下清单（来自参考资料src/main/java/com/example/restservicecors/RestServiceCorsApplication.java）显示了如何在应用程序类中添加 CORS 映射：

COPY	public WebMvcConfigurer corsConfigurer() {
		return new WebMvcConfigurer() {
			@Override
			public void addCorsMappings(CorsRegistry registry) {
				registry.addMapping("/greeting-javaconfig").allowedOrigins("http://localhost:9000");
			}
		};
	}

您可以轻松更改任何属性（例如allowedOrigins示例中的属性），以及将此 CORS 配置应用于特定路径模式。

您可以组合全局和控制器级别的 CORS 配置。

创建应用程序类

Spring Initializr 为您创建一个简单的应用程序类。以下清单（来自initial/src/main/java/com/example/restservicecors/RestServiceCorsApplication.java）显示了初始类：

COPYpackage 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）显示了如何执行此操作：

COPY	@Bean
	public WebMvcConfigurer corsConfigurer() {
		return new WebMvcConfigurer() {
			@Override
			public void addCorsMappings(CorsRegistry registry) {
				registry.addMapping("/greeting-javaconfig").allowedOrigins("http://localhost:9000");
			}
		};
	}

以下清单显示了已完成的应用程序类：

COPYpackage 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:9000");
			}
		};
	}

}

@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 目标/gs-rest-service-cors-0.1.0.jar

此处描述的步骤创建一个可运行的 JAR。您还可以构建经典的 WAR 文件。

显示记录输出。该服务应在几秒钟内启动并运行。

测试服务

现在服务已启动，http://localhost:8080/greeting在浏览器中访问您应该看到：

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

name通过访问提供查询字符串参数http://localhost:8080/greeting?name=User。该属性的值content从更改Hello, World!为Hello User!，如以下清单所示：

COPY{"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 文件，其中包含以下内容：

COPY$(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）所示：

COPY<!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>

要测试 CORS 行为，您需要从另一个服务器或端口启动客户端。这样做不仅可以避免两个应用程序之间的冲突，还可以确保客户端代码由与服务不同的源提供服务。

要在端口 9000 上启动在 localhost 上运行的客户端，请保持应用程序在端口 8080 上运行，并在另一个终端中运行以下 Maven 命令：

COPY./mvnw spring-boot:run -Dspring-boot.run.jvmArguments='-Dserver.port=9000'

如果你使用Gradle，你可以使用这个命令：

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

应用程序启动后，在浏览器中打开http://localhost:9000，您应该会看到以下内容，因为服务响应包含相关的 CORS 标头，因此 ID 和内容会呈现到页面中：

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

现在，停止在端口 9000 运行的应用程序，保持应用程序在端口 8080 运行，并在另一个终端中运行以下 Maven 命令：

COPY./mvnw spring-boot:run -Dspring-boot.run.jvmArguments='-Dserver.port=9001'

如果你使用Gradle，你可以使用这个命令：

COPY./gradlew bootRun --args="--server.port=9001"

应用程序启动后，在浏览器中打开http://localhost:9001，您应该会看到以下内容：

如果响应中缺少 CORS 标头（或对于客户端而言不足），浏览器将使请求失败。不会将任何数据渲染到 DOM 中。

在这里，浏览器使请求失败，并且值不会呈现到 DOM 中，因为 CORS 标头丢失（或对于客户端而言不足），因为我们只允许来自http://localhost:9000而不是http的跨源请求： //本地主机:9001。

概括

恭喜！您刚刚开发了一个 RESTful Web 服务，其中包括使用 Spring 进行跨源资源共享。

开始使用 | 为 RESTful Web 服务启用跨源请求

posted @ 2024-02-28 09:09 CharyGao 阅读(27) 评论(0) 收藏举报

刷新页面返回顶部

硅基文明

代码改变不了世界，但是改变世界需要代码。

为 RESTful Web 服务启用跨源请求

你将建造什么

你需要什么

如何完成本指南

从Spring初始化开始

添加`httpclient5`依赖项

创建资源表示类

创建资源控制器

启用 CORS

控制器方法 CORS 配置

全局 CORS 配置

创建应用程序类

构建可执行 JAR

测试服务

概括

硅基文明

代码改变不了世界，但是改变世界需要代码。

为 RESTful Web 服务启用跨源请求

你将建造什么

你需要什么

如何完成本指南

从Spring初始化开始

添加httpclient5依赖项

创建资源表示类

创建资源控制器

启用 CORS

控制器方法 CORS 配置

全局 CORS 配置

创建应用程序类

构建可执行 JAR

测试服务

概括

添加`httpclient5`依赖项