[Spring Guides] 使用Restful Web 服务

• 本指南将引导您完成 创建使用RESTful Web服务的应用程序 的过程。
• 您将构建一个使用Spring的RestTemplate的应用程序，以接收从http://gturnquist-quoters.cfapps.io/api/random取回随机的Spring Boot 引用。

使用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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

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

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

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
    </dependencies>


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

</project>

获取REST资源

用Maven构建完项目之后，便可以创建一个简单的应用程序来使用RESTful 服务。

一个RESTful服务已经在http://gturnquist-quoters.cfapps.io/api/random上建立起来了。它随机地获取有关Spring Boot的引用，并将其作为JSON文档返回。

如果您用Web浏览器请求该URL，您将收到一个如下所示的JSON文档：

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

但通过浏览器取得这些数据不是很有用，更有效的使用REST Web服务的方法是编程。为了帮助你完成这项任务，Spring提供了一个很方便的模板叫RestTemplate。它将JSON数据绑定到自定义域类型。

首先，创建一个包含所需数据的域类：

package hello;

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注释，表明任何未绑定在此类型中的属性都应被忽略。
• 为了让您直接将数据绑定到您的自定义类型，您需要指定与（从API返回的JSON数据中的）键完全相同的变量名称。
• 如果你的变量名JSON文档中的键不匹配，则需要使用@JsonProperty注释来指定JSON文档的键。

排小坑：在你创建下面的Value.class之前，上面的文件会在private Value value;报错，因为Value类还没有被创建，不要纠结这个。

此外，还需要一个额外的类来嵌入内部引用本身。

package hello;

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 + '\'' +
                '}';
    }
}

使用相同的注释，但是映射到了其他数据字段。

使应用程序可执行

现在，可以编写一个使用RestTemplate的Application类 从Spring Boot引用服务上获取数据。

package hello;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class Application {

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

    public static void main(String args[]) {
        RestTemplate restTemplate = new RestTemplate();
        Quote quote = restTemplate.getForObject("http://gturnquist-quoters.cfapps.io/api/random", Quote.class);
        log.info(quote.toString());
    }

}

因为Jackson JSON处理库在类路径中，RestTemplate将会使用它（通过消息转换器）将接收到的JSON数据转换为Quote对象，Quote对象的内容将会被记录到控制台。
这里，只使用RestTemplate进行HTTP GET请求。但是RestTemplate还支持其他HTTP动词，如POST，PUT和DELETE。

用Spring Boot管理应用程序生命周期

到目前为止，还没有在应用程序中使用Spring Boot，用Spring Boot有一些优势，并且使用起来并不难。优点之一便是我们可能想要Spring Boot管理RestTemplate中的消息转换器，这样个性化自定义就很容易以声明方式添加。为了达成这个目的，我们在主类上使用@SpringBootApplication并转换main方法来启用它，像在其他Spring Boot应用程序上那样。最后，我们将RestTemplate移动到CommandLineRunner`回调，以便在启动时由Spring Boot执行：

package hello;

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

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

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

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

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

RestTemplateBuilder由Spring注入，如果您使用它来创建RestTemplate，那么您将受益于 （使用消息转换器和请求工厂的）Spring Boot中发生的所有自动配置。我们还将RestTemplate提取成一个@Bean，使其更易于测试。