用AI赚第一桶💰低成本搭建一套AI赚钱工具,源码可二开。 广告
# 为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/> <!-- 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](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/> <!-- 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> ~~~ 添加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的跨域资源共享。