消費RESTful Web服務 · springboot官方文檔中文版

# 消費RESTful Web服務本指南將引導您完成創建使用RESTful Web服務的應用程序的過程。 ## 你會建立什么您將構建一個使用Spring的應用程序 `RestTemplate`在上檢索隨機的Spring Boot報價 [https://quoters.apps.pcfone.io/api/random](https://quoters.apps.pcfone.io/api/random) 。 ## 你需要什么 * 約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/consuming-rest/#scratch) 。要 **跳過基礎知識** ，請執行以下操作： * [下載](https://github.com/spring-guides/gs-consuming-rest/archive/master.zip) 并解壓縮本指南的源存儲庫，或使用對其進行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-consuming-rest.git](https://github.com/spring-guides/gs-consuming-rest.git)` * 光盤進入 `gs-consuming-rest/initial` * 繼續前進以 [獲取REST資源](https://spring.io/guides/gs/consuming-rest/#initial) 。 **完成后** ，您可以根據中的代碼檢查結果 `gs-consuming-rest/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=consuming-rest&name=consuming-rest&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.consuming-rest&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/>  </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](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=consuming-rest&name=consuming-rest&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.consuming-rest&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() } ~~~ 這些構建文件可以很簡單，因為 `spring-boot-starter-web` 包括構建Web應用程序所需的一切，包括使用JSON所需的Jackson類。 ### 手動初始化（可選）如果要手動初始化項目而不是使用前面顯示的鏈接，請按照以下步驟操作： 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中完成此過程。 ## 提取REST資源完成項目設置后，您可以創建一個使用RESTful服務的簡單應用程序。 RESTful服務已通過站起來 [https://quoters.apps.pcfone.io/api/random](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`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/client/RestTemplate.html). `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來源的報價。您需要添加： * 記錄器，用于將輸出發送到日志（在此示例中為控制臺）。 * 一個 `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`。或者，您可以通過使用以下命令構建JAR文件： `./gradlew build` 然后運行JAR文件，如下所示： ~~~ java -jar build/libs/gs-consuming-rest-0.1.0.jar ~~~ 如果您使用Maven，則可以通過使用以下命令運行該應用程序 `./mvnw spring-boot:run`。或者，您可以使用以下命令構建JAR文件： `./mvnw clean package` 然后運行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.'}} ~~~ 如果您看到讀取錯誤， 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客戶端。