使用 Spring 创建“Hello， World”RESTful Web 服务的过程

时间：2022-12-22 16:12:45

使用 Spring 创建“Hello， World”RESTful Web 服务的过程

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

您将构建什么

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

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

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

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

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

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

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

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或以后
  • 格拉德尔 4+​或梅文 3.2+
  • 您也可以将代码直接导入到 IDE 中：
  • 弹簧工具套件 （STS）
  • 智能理念
  • VSCode

如何完成本指南

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

要从头开始，请继续从 Spring 初始化开始.

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

  • 下载​并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-rest-service-cors.git
  • 光盘成gs-rest-service-cors/initial
  • 跳转到创建资源表示类.

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

从 Spring 初始化开始

你可以使用这个预初始化项目，然后单击生成以下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

  1. 导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项，并为您完成大部分设置。
  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
  3. 单击“依赖关系”，然后选择“Spring Web”。
  4. 单击生成。
  5. 下载生成的 ZIP 文件，该文件是配置了您选择的 Web 应用程序的存档。

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

您也可以从 Github 分叉项目，然后在 IDE 或其他编辑器中打开它。

添加依赖项​​httpclient​​

测试（在）需要Apache库。​​complete/src/test/java/com/example/restservicecors/GreetingIntegrationTests.java​​​​httpclient​​

要将 Apache 库添加到 Maven，请添加以下依赖项：​​httpclient​​

<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>3.0.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>

要将 Apache 库添加到 Gradle，请添加以下依赖项：​​httpclient​​

testImplementation 'org.apache.httpcomponents:httpclient'

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

plugins {
  id 'org.springframework.boot' version '3.0.0'
  id 'io.spring.dependency-management' version '1.1.0'
  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 服务了。

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

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

{
    "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;
  }
}

弹簧使用杰克逊·​库，用于自动将类型的实例封送到 JSON 中。​​Greeting​​

创建资源控制器

在Spring构建RESTful Web服务的方法中，HTTP请求由控制器处理。这些组件很容易通过@Controller注释，以及以下清单 （from ） 中显示的 通过返回类的新实例来处理请求：​​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));
  }

}

这个控制器简洁明了，但引擎盖下有很多事情要做。我们一步一步地分解它。

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

前面的示例使用批注，该批注充当 的快捷方式。我们在这种情况下使用是因为它便于测试。Spring 仍将拒绝源与 CORS 配置不匹配的 GET 请求。浏览器不需要发送 CORS 预检请求，但如果我们想触发预检，我们可以在正文中使用并接受一些 JSON。​​@GetMapping​​​​@RequestMapping(method = RequestMethod.GET)​​​​GET​​​​@PostMapping​​

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

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

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

为此，{RestController}[] 注解假定每个方法都继承​​@RestController​​@ResponseBody默认情况下的语义。因此，返回的对象数据将直接插入到响应正文中。

由于Spring的HTTP消息转换器支持，该对象自然而然地转换为JSON。因为​​Greeting​​杰克逊在类路径上，春天的MappingJackson2HttpMessageConverter自动选择将实例转换为 JSON。​​Greeting​​

启用 CORS

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

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

控制器方法 CORS 配置

为了使 RESTful Web 服务在其响应中包含 CORS 访问控制标头，您必须向处理程序方法添加注释，如以下清单 （from ） 所示：​​@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));

此注释仅为此特定方法启用跨源资源共享。默认情况下，它允许所有源、所有标头和注释中指定的 HTTP 方法。此外，还使用了 30 分钟。您可以通过指定以下批注属性之一的值来自定义此行为：​​@CrossOrigin​​​​@RequestMapping​​​​maxAge​​

  • ​​origins​​
  • ​​methods​​
  • ​​allowedHeaders​​
  • ​​exposedHeaders​​
  • ​​allowCredentials​​
  • ​​maxAge​​.

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

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

全局 CORS 配置

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

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

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

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

您可以组合全局级和控制器级 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 引导根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如，如果 在类路径上，则此注释会将应用程序标记为 Web 应用程序并激活关键行为，例如设置 .spring-webmvcDispatcherServlet
  • ​​@ComponentScan​​：告诉 Spring 在包中查找其他组件、配置和服务，让它找到控制器。com/example

该方法使用 Spring Boot 的方法启动应用程序。您是否注意到没有一行 XML？也没有文件。此 Web 应用程序是 100% 纯 Java，您无需处理配置任何管道或基础结构。​​main()​​​​SpringApplication.run()​​​​web.xml​​

构建可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar，可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。

如果使用 Gradle，则可以使用 .或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./gradlew bootRun​​​​./gradlew build​​

java -jar build/libs/gs-rest-service-cors-0.1.0.jar

如果使用 Maven，则可以使用 运行应用程序。或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./mvnw spring-boot:run​​​​./mvnw clean package​​

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 客户端来使用该服务。以下清单显示了此类客户端：

首先，创建一个名为 （from ） 的简单 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 服务。它由 加载，如以下清单 （from ） 所示：​​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 服务，稍作修改，以便在 localhost 端口 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 标头，则 ID 和内容将呈现到页面中。但是，如果 CORS 标头丢失（或对于客户端来说不足），则浏览器会使请求失败，并且值不会呈现到 DOM 中。

总结

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

标签：

相关文章