[Spring官方教程] - 调用远程的RESTful服务

本指南将引导你完成创建一个消费RESTful网络服务的应用程序的过程。

你将建造什么

你将建立一个应用程序,使用Spring的RestTemplate来检索一个随机的Spring Boot报价,https://quoters.apps.pcfone.io/api/random

你需要什么

从Spring Initializr开始

如果您使用Maven,请访问 Spring Initializr来生成一个具有所需依赖性(Spring Web)的新项目。

下面列出了选择Maven时创建的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.5.2</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>consuming-rest-initial</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>consuming-rest-initial</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)的新项目。

下面的列表显示了当你选择Gradle时创建的build.gradle文件。

plugins {
	id 'org.springframework.boot' version '2.5.2'
	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应用所需要的一切,包括你需要的Jackson类来处理JSON。

手动初始化(可选)

如果你想手动初始化项目,而不是使用前面显示的链接,请按照下面的步骤进行。

  1. 导航到https://start.spring.io。这个服务拉入你的应用程序所需的所有依赖项,并为你做大部分的设置。
  2. 2.选择Gradle或Maven以及你想使用的语言。本指南假设你选择了Java。
  3. 3.点击依赖项,选择Spring Web
    1. 单击生成
  4. 下载生成的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网络服务。为了帮助你完成这项任务,Spring提供了一个方便的模板类,叫做RestTemplateRestTemplate使得与大多数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方法。它被Jackson JSON处理库中的@JsonIgnoreProperties 所注解,以表明任何未在此类型中绑定的属性应被忽略。

要直接将你的数据绑定到你的自定义类型,你需要指定变量名称与从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源的报价。你需要添加。

  • 一个记录器,用来发送输出到日志(在这个例子中,是控制台)。
  • 一个RestTemplate,它使用Jackson JSON处理库来处理传入的数据。
  • 一个CommandLineRunner',在启动时运行RestTemplate’(并因此获取我们的报价)。

下面的列表显示了完成的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来运行该应用程序。或者,你可以通过使用./gradlew build来构建JAR文件,然后运行JAR文件,如下所示。

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

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

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

这里描述的步骤创建了一个可运行的JAR。你也可以建立一个经典的WAR文件

你应该看到与下面类似的输出,但有一个随机的引号。

2019-08-22 14:06:46.506  INFO 42940 --- [           main] c.e.c.ConsumingRestApplication           : Quote{type='success', value=Value{id=1, quote='Working with Spring Boot is like pair-programming with the Spring developers.'}}

如果你看到一个错误,内容是:“无法提取响应:没有为响应类型[class com.example.consumerrest.Quote]找到合适的HttpMessageConverter”,那么你有可能处在一个无法连接到后端服务(如果你能接触到它,它就会发送JSON)的环境。也许你是在一个企业的代理后面。试着将http.proxyHosthttp.proxyPort系统属性设置为适合你环境的值。

总结

祝贺你!你刚刚使用Spring Boot开发了一个简单的REST客户端。你刚刚通过使用Spring Boot开发了一个简单的REST客户端。

另见

以下指南也可能有所帮助。

想写一个新的指南或对现有的指南做出贡献?请查看我们的[贡献指南](https://github.com/spring-guides/getting-started-guides/wiki)。


原文:Getting Started | Consuming a RESTful Web Service