入门·为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中：
- Spring Tool Suite (STS)
- IntelliJ IDEA

如何完成本指南

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

要从头开始 ，请继续使用Gradle构建。

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

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

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

用Gradle构建

首先，您设置一个基本的构建脚本。在使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含使用Gradle和Maven所需的代码。如果您都不熟悉，请参阅使用Gradle 构建Java项目或使用Maven构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

创建一个Gradle构建文件

以下是最初的Gradle构建文件。

build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.1.6.RELEASE")
    }
}

apply plugin: 'java'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-rest-service-cors'
    version =  '0.1.0'
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
}

Spring Boot gradle插件提供了许多方便的功能：

它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。
它搜索public static void main()标记为可运行类的方法。
它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

用Maven构建

首先，您设置一个基本的构建脚本。使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含了使用Maven所需的代码。如果您不熟悉Maven，请参阅使用Maven 构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

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>

    <groupId>org.springframework</groupId>
    <artifactId>gs-rest-service-cors</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <properties>
        <java.version>1.8</java.version>
    </properties>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Spring Boot Maven插件提供了许多方便的功能：

它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。
它搜索public static void main()标记为可运行类的方法。
它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

使用您的IDE进行构建

阅读如何将本指南直接导入Spring Tool Suite中。
在IntelliJ IDEA中阅读如何使用本指南。

创建资源表示形式类

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

通过考虑服务交互来开始该过程。

该服务将处理GET要求/greeting ，也可以加上name查询字符串中的参数。的GET请求应返回一个200 OK正文中的JSON表示问候语。它看起来应该像这样：

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

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

要建模问候表示，请创建一个资源表示类。为普通的旧Java对象提供字段，构造函数和访问器， id和content数据：

src/main/java/hello/Greeting.java

package hello;

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把手下面GET要求/greeting通过返回新的实例Greeting类：

src/main/java/hello/GreetingController.java

package hello;

import java.util.concurrent.atomic.AtomicLong;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

    private static final String template = "Hello, %s!";
    private final AtomicLong counter = new AtomicLong();

    @GetMapping("/greeting")
    public Greeting greeting(@RequestParam(required=false, defaultValue="World") String name) {
        System.out.println("==== in greeting ====");
        return new Greeting(counter.incrementAndGet(), String.format(template, name));
    }

}

该控制器简洁明了，但是内部却有很多事情要做。让我们将其逐步分解。

的@RequestMapping注释可确保HTTP请求/greeting映射到greeting()方法。

上面的示例使用@GetMapping用作快捷方式的注释@RequestMapping(method = RequestMethod.GET) 。

@RequestParam绑定查询字符串参数的值name进入name的参数greeting()方法。此查询字符串参数不是required ;如果请求中不存在，则defaultValue使用“世界”。

方法主体的实现创建并返回一个新的Greeting与对象id和content属性基于counter ，并格式化给定的name通过使用问候语template 。

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

为此， @ResponseBody上的注释greeting()方法告诉Spring MVC，它不需要通过服务器端视图层呈现问候对象，而是返回的问候对象是响应主体，应直接写出。

的Greeting对象必须转换为JSON。借助Spring的HTTP消息转换器支持，您无需手动进行此转换。因为杰克逊在课堂上， Spring 的MappingJackson2HttpMessageConverter自动选择以转换Greeting实例转换为JSON。

启用CORS

控制器方法CORS配置

为了使RESTful Web服务的响应中包含CORS访问控制标头，您只需添加一个@CrossOrigin对处理程序方法的注释：

src/main/java/hello/GreetingController.java

    @CrossOrigin(origins = "http://localhost:9000")
    @GetMapping("/greeting")
    public Greeting greeting(@RequestParam(required=false, defaultValue="World") String name) {
        System.out.println("==== in greeting ====");
        return new Greeting(counter.incrementAndGet(), String.format(template, name));
    }

这个@CrossOrigin注释仅针对此特定方法启用跨域请求。默认情况下，它允许所有来源，所有标头， @RequestMapping注释，并且使用30分钟的maxAge。您可以通过指定注释属性之一的值来自定义此行为： origins ， methods ， allowedHeaders ， exposedHeaders ， allowCredentials要么maxAge 。在此示例中，我们仅允许http://localhost:9000发送跨域请求。

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

全局CORS配置

作为基于注释的细粒度配置的替代方法，您还可以定义一些全局CORS配置。这类似于使用Filter基于解决方案的解决方案，但可以在Spring MVC中声明并与细粒度组合@CrossOrigin组态。默认情况下，所有来源和GET ， HEAD和POST允许使用方法。

src/main/java/hello/GreetingController.java

    @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));
    }

src/main/java/hello/Application.java

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

您可以轻松更改任何属性（例如allowedOrigins ，以及仅将此CORS配置应用于特定的路径模式。全局和控制器级别的CORS配置也可以组合使用。

使应用程序可执行

尽管可以将该服务打包为传统的WAR文件以部署到外部应用程序服务器，但是下面演示的更简单的方法创建了一个独立的应用程序。您将所有内容打包在一个可运行的JAR文件中，由一个好的旧Java驱动main()方法。在此过程中，您将使用Spring的支持将Tomcat Servlet容器作为HTTP运行时嵌入，而不是部署到外部实例。

src/main/java/hello/Application.java

package hello;

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 Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

@SpringBootApplication是一个方便注释，它添加了以下所有内容：

@Configuration ：将类标记为应用程序上下文的Bean定义的源。
@EnableAutoConfiguration ：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。例如，如果spring-webmvc在类路径上，此注释将应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet 。
@ComponentScan ：告诉Spring在其中寻找其他组件，配置和服务hello包，让它找到控制器。

的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属性从“您好，世界！”转到“您好，用户！“：

{"id":2,"content":"Hello, User!"}

此更改表明@RequestParam安排在GreetingController正在按预期工作。的name参数的默认值为“世界”，但始终可以通过查询字符串显式覆盖。

还要注意id属性已从更改为1至2 。这证明您正在反对同一个GreetingController跨多个请求的实例， counter字段在每个呼叫上都按预期递增。

现在要测试CORS标头是否已到位，并允许其他来源的Javascript客户端访问该服务，您需要创建一个Javascript客户端以使用该服务。

首先，创建一个简单的Javascript文件，名为hello.js具有以下内容：

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来使用位于http：// localhost：8080 / greeting的REST服务。它由加载index.html如下所示：

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）上运行的服务。有关如何开发此客户端的更多详细信息，请参阅该指南。

因为REST服务已经在本地主机（端口8080）上运行，所以您需要确保从其他服务器和/或端口启动客户端。这不仅可以避免两个应用程序之间的冲突，还可以确保从与服务不同的来源提供客户端代码。要启动在本地主机上运行的客户端，端口9000：

mvn spring-boot:run -Dserver.port=9000

客户端启动后，在浏览器中打开http：// localhost：9000 ，您将在其中看到：

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

如果服务响应包含CORS标头，则ID和内容将呈现到页面中。但是，如果缺少CORS标头（或未为客户端充分定义），则浏览器将使请求失败，并且这些值将不会呈现到DOM中：

摘要

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

也可以看看

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

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

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