Spring国际认证指南｜为 RESTful Web 服务启用跨源请求

原创

IT胶囊

发布于 2022-04-18 11:42:28

1.6K0

发布于 2022-04-18 11:42:28

文章被收录于专栏：IT技能应用IT技能应用

原标题：Spring国际认证指南|了解如何使用 Spring 创建支持跨域资源共享 (CORS) 的 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 开始

您可以使用这个预先初始化的项目并单击 Generate 下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

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

如果您的 IDE 具有 Spring Initializr 集成，您可以从您的 IDE 完成此过程。你也可以从 Github 上 fork 项目并在你的 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.6.3</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>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.6.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的文本表示。

要对问候表示建模，请创建一个资源表示类。id为and数据提供一个带有字段、构造函数和访问器的普通 Java 对象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在这种情况下使用它是因为它便于测试。Spring 仍然会拒绝来源与 CORS 配置不匹配的 GET 请求。浏览器不需要发送 CORS 预检请求，但@PostMapping如果我们想触发预检，我们可以在正文中使用和接受一些 JSON。

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

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

传统 MVC 控制器和前面显示的 RESTful Web 服务控制器之间的一个关键区别是 HTTP 响应主体的创建方式。这个 RESTful Web 服务控制器不是依靠视图技术来执行服务器端将问候数据呈现为 HTML，而是填充并返回一个Greeting对象。对象数据作为 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 分钟的 a。您可以通过指定以下注释属性之一的值来自定义此行为：

origins
methods
allowedHeaders
exposedHeaders
allowCredentials
maxAge.

在这个例子中，我们只允许http://localhost:8080发送跨域请求。

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

全局 CORS 配置

除了（或作为替代）细粒度的基于注释的配置之外，您还可以定义一些全局 CORS 配置。这类似于使用 aFilter但可以在 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 目标/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 客户端，稍作修改以在 localhost 端口 8080 上运行时使用该服务。有关如何开发此客户端的更多详细信息，请参阅该指南。

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

./mvnw spring-boot:run复制

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

./gradlew bootRun复制

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

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

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

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

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

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

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

概括

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

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

spring