Spring 打造一個 API 消費者

Spring 打造一個 API 消費者

我們上次做了一個簡單 RESTful Web Service
這次呢!我們來做一個對 API 發出請求的服務!

一樣 這篇是來做 Spring.io 的練習:Consuming a RESTful Web Service

就讓我們開始吧!


我們將建立一個…

一個 Spring 應用程式使用 RestTemplate 類別去對 https://gturnquist-quoters.cfapps.io/api/random 這個 API 發出要求,以取得回傳的資料物件

API 回傳的格式是這樣的

{
  "type": "success",
  "value": {
    "id": 4,
    "quote": "Previous to Spring Boot, I ..."
  }
}

我們要做的事情是,當我們把 Spring 服務跑起來之後,會直接對 API 發出請求
請求過後再把資料轉成資料物件,完成後印在我們的 log 中!

建立資源表示類別 ( Resource Representation Class )

Quote 類別

package com.judysocute.consumingapp;

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

Value 類別

package com.judysocute.consumingapp;

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

}

這兩個類別其實很單純,就是單純的定義類別成員,Getter、Setter、toString() 方法而已!

發出請求

再來寫我們發出請求的部分

發出請求我們需要一個 RestTemplate 類別

package com.judysocute.consumingapp;

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 DemoApplication {
  
  	// ... 略過 ...

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

	// ... 略過 ...
  
}

這邊先不用太執著於去瞭解 RestTemplate ,現階段我們先知道 RestTemplate 可以讓我們發出請求並且將回傳內容轉為物件,就可以了!

完成 RestTemplate 的建立之後就可以寫發出要求的部分了!

package com.judysocute.consumingapp;

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 DemoApplication {
	private static final Logger log = LoggerFactory.getLogger(DemoApplication.class);

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.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://gturnquist-quoters.cfapps.io/api/random", Quote.class);
			log.info(quote.toString());
		};
	}

}

這個 run() 方法就是發出要求並且轉換為物件、最後再寫到 log 中的部分!

這樣就完成囉!
只要再執行 main() 方法,就會看到類似這段

INFO 3381 --- [           main] c.j.consumingapp.DemoApplication         : Quote{type='success', value=Value{id=5, quote='Spring Boot solves this problem. It gets rid of XML and wires up common components for me, so I don't have to spend hours scratching my head just to figure out how it's all pieced together.'}}

就是回傳內容了!

wayne

No Comment

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *

文章分類