消费RESTful Web服务_Spring 中文网

本指南将引导您完成创建使用RESTful Web服务的应用程序的过程。

你会建立什么

您将RestTemplate在https://quoters.apps.pcfone.io/api/random上构建一个使用Spring检索随机Spring Boot报价的应用程序。

你需要什么

约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-consuming-rest.git
光盘进入 gs-consuming-rest/initial
继续前进以获取REST资源。

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

从Spring Initializr开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（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>consuming-rest</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>consuming-rest</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以生成具有所需依赖项的新项目（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()
}

这些构建文件非常简单，因为它spring-boot-starter-web包含构建Web应用程序所需的一切，包括使用JSON所需的Jackson类。

手动初始化（可选）

如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：

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

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

提取REST资源

完成项目设置后，您可以创建一个使用RESTful服务的简单应用程序。

RESTful服务已通过https://quoters.apps.pcfone.io/api/random站起来。它随机获取有关Spring Boot的报价，并将其作为JSON文档返回。

如果您通过网络浏览器或curl请求该URL，则会收到一个类似于以下内容的JSON文档：

{
   type: "success",
   value: {
      id: 10,
      quote: "Really loving Spring Boot, makes stand alone Spring apps easy."
   }
}

通过浏览器或curl获取时，这足够容易，但并不是很有用。

使用REST Web服务的一种更有用的方法是以编程方式。为了帮助您完成此任务，Spring提供了一个名为的便捷模板类RestTemplate。RestTemplate使与大多数RESTful服务的交互成为一线咒语。而且它甚至可以将该数据绑定到自定义域类型。

首先，您需要创建一个域类来包含所需的数据。以下清单显示了Quote该类，您可以将其用作域类：

src/main/java/com/example/consumingrest/Quote.java

package com.example.consumingrest;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties(ignoreUnknown = true)
public class Quote {

  private String type;
  private Value value;

  public Quote() {
  }

  public String getType() {
    return type;
  }

  public void setType(String type) {
    this.type = type;
  }

  public Value getValue() {
    return value;
  }

  public void setValue(Value value) {
    this.value = value;
  }

  @Override
  public String toString() {
    return "Quote{" +
        "type='" + type + '\'' +
        ", value=" + value +
        '}';
  }
}

这个简单的Java类具有一些属性和匹配的getter方法。它@JsonIgnoreProperties在Jackson JSON处理库中带有注释，以指示应忽略此类型中未绑定的任何属性。

要将数据直接绑定到自定义类型，您需要指定变量名称，使其与从API返回的JSON文档中的键完全相同。如果您的变量名称和JSON文档中的密钥不匹配，则可以使用@JsonProperty注释来指定JSON文档的确切密钥。（此示例将每个变量名与一个JSON键匹配，因此在这里您不需要该注释。）

您还需要一个附加的类来嵌入内部引号本身。该Value级满足了这一需求，并在下面的列表（在所示src/main/java/com/example/consumingrest/Value.java）：

package com.example.consumingrest;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties(ignoreUnknown = true)
public class Value {

  private Long id;
  private String quote;

  public Value() {
  }

  public Long getId() {
    return this.id;
  }

  public String getQuote() {
    return this.quote;
  }

  public void setId(Long id) {
    this.id = id;
  }

  public void setQuote(String quote) {
    this.quote = quote;
  }

  @Override
  public String toString() {
    return "Value{" +
        "id=" + id +
        ", quote='" + quote + '\'' +
        '}';
  }
}

这使用相同的批注，但映射到其他数据字段。

完成申请

Initalizr使用main()方法创建一个类。以下清单显示了Initializr创建的类（位于src/main/java/com/example/consumingrest/ConsumingRestApplication.java）：

package com.example.consumingrest;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ConsumingRestApplication {

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

}

现在，您需要向ConsumingRestApplication该类中添加其他一些内容，以使其显示来自我们RESTful源的引文。您需要添加：

记录器，用于将输出发送到日志（在此示例中为控制台）。
A RestTemplate，它使用Jackson JSON处理库来处理传入的数据。
在启动时CommandLineRunner运行RestTemplate（因此获取我们的报价）的A。

以下清单显示了完成的ConsumingRestApplication课程（位于src/main/java/com/example/consumingrest/ConsumingRestApplication.java）：

package com.example.consumingrest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class ConsumingRestApplication {

	private static final Logger log = LoggerFactory.getLogger(ConsumingRestApplication.class);

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

	@Bean
	public RestTemplate restTemplate(RestTemplateBuilder builder) {
		return builder.build();
	}

	@Bean
	public CommandLineRunner run(RestTemplate restTemplate) throws Exception {
		return args -> {
			Quote quote = restTemplate.getForObject(
					"https://quoters.apps.pcfone.io/api/random", Quote.class);
			log.info(quote.toString());
		};
	}
}

运行应用程序

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

如果您使用Gradle，则可以使用来运行该应用程序./gradlew bootRun。或者，您可以使用来构建JAR文件./gradlew build，然后运行JAR文件，如下所示：

java -jar build / libs / gs-using-rest-0.1.0.jar

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

java -jar target / gs-using-rest-0.1.0.jar

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

您应该看到类似于以下内容的输出，但带有随机引号：

2019-08-22 14：06：46.506信息42940 --- [main] cecConsumingRestApplication：Quote {type ='success'，value = Value {id = 1，quote ='Spring开发人员。'}}

如果看到读为的错误，Could not extract response: no suitable HttpMessageConverter found for response type [class com.example.consumingrest.Quote]则可能是因为您所在的环境无法连接到后端服务（如果可以访问JSON，则会发送JSON）。也许您是公司代理的幕后黑手。尝试将http.proxyHost和http.proxyPort属性设置为适合您的环境的值。

概括

恭喜你！您刚刚使用Spring Boot开发了一个简单的REST客户端。

也可以看看

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

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

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