Spring Boot 调用外部接口的几种方式

Spring Boot 调用外部接口的几种方式

在微服务架构中，服务间的调用是不可或缺的环节。Spring Boot 为开发者提供了多种方式来实现这一任务，这个文章将为你详细介绍这些方式。

一、使用RestTemplate

RestTemplate是 Spring Boot 早期版本中常用的 REST 客户端，尽管在新的 Spring 的版本中，RestTemplate已经被标注为不建议使用，但了解其用法仍然有必要。以下是如何使用RestTemplate进行 GET 和 POST 请求的例子。

示例代码

import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.web.client.RestTemplate;

// REST GET请求
RestTemplate restTemplate = new RestTemplate();
String resultGet = restTemplate.getForObject("http://example.com/endpoint", String.class);

// REST POST请求
HttpHeaders headers = new HttpHeaders();
headers.set("Custom-Header", "Custom header value");
HttpEntity<String> entity = new HttpEntity<>(headers);
String resultPost = restTemplate.postForObject("http://example.com/endpoint", entity, String.class);
1
2
3
4
5
6
7
8
9
10
11
12
13
14

二、使用WebClient

WebClient是 Spring 5 中推出，用于替代RestTemplate的新的非阻塞的 REST 客户端。

示例代码

import org.springframework.web.reactive.function.client.WebClient;

// 创建WebClient
WebClient webClient = WebClient.create("http://example.com");

// REST GET请求
String resultGet = webClient.get()
        .uri("/endpoint")
        .retrieve()
        .bodyToMono(String.class)
        .block();

// REST POST请求
String resultPost = webClient.post()
        .uri("/endpoint")
        .header("Custom-Header", "Custom header value")
        .retrieve()
        .bodyToMono(String.class)
        .block();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

三、使用 Feign

为了简化微服务间的调用，Spring Cloud 提供了 Feign。Feign 可以让 HTTP 客户端的调用像调用本地方法一样简单。

示例代码

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

// 定义Feign接口
@FeignClient(name = "example-service", url = "http://example.com")
public interface ExampleClient {
    @GetMapping("/endpoint")
    String exampleRequest();
}

// 调用Feign接口
@Autowired
private ExampleClient exampleClient;

public void doSomething() {
    String result = exampleClient.exampleRequest();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

结语

以上对 Spring Boot 调用外部接口的三种方式进行了简单介绍，但实践中需要依据项目具体需求和实际情况进行选择，以确保项目导向和效率最优。

---