SpringBoot調(diào)用第三方接口的幾種方式小結(jié)
一、前言
在項(xiàng)目中調(diào)用第三方接口時(shí),確實(shí)需要根據(jù)項(xiàng)目的技術(shù)棧、架構(gòu)規(guī)范以及具體的業(yè)務(wù)需求來選擇最適合的調(diào)用方式。比如:RESTful API調(diào)用、Feign聲明式HTTP客戶端、Apache HttpClient等調(diào)用方式,每種方式都有其適用場景和優(yōu)勢。下面我們就介紹幾種調(diào)用第三方接口的實(shí)現(xiàn)方式以及代碼示例。
二、常見的調(diào)用方式
1. RESTful API調(diào)用
適用場景:當(dāng)?shù)谌浇涌谧裱璕ESTful設(shè)計(jì)風(fēng)格時(shí),通常使用HTTP客戶端庫(如OkHttp、Apache HttpClient等)來發(fā)送HTTP請求并接收響應(yīng)。
優(yōu)勢:
- 通用性強(qiáng):RESTful API基于HTTP協(xié)議,可以跨平臺、跨語言調(diào)用。
- 靈活性高:支持各種HTTP方法(GET、POST、PUT、DELETE等),可以滿足不同的業(yè)務(wù)需求。
- 易于測試:可以使用Postman、curl等工具進(jìn)行接口測試。
- 實(shí)現(xiàn)方式:使用HTTP客戶端庫構(gòu)建請求,發(fā)送請求并處理響應(yīng)。
2. Feign聲明式HTTP客戶端
適用場景:在Spring Cloud等微服務(wù)架構(gòu)中,F(xiàn)eign可以作為聲明式HTTP客戶端,簡化HTTP請求的編寫。
優(yōu)勢:
- 簡化代碼:通過注解的方式定義HTTP請求,減少模板代碼。
- 支持負(fù)載均衡:可以配合Ribbon等組件實(shí)現(xiàn)客戶端負(fù)載均衡。
- 易于集成:與Spring Cloud等框架集成良好,方便使用。
- 實(shí)現(xiàn)方式:在Spring Boot項(xiàng)目中添加Feign依賴,使用注解定義HTTP請求,并通過注入的方式調(diào)用Feign客戶端。
3. Apache HttpClient
適用場景:對于需要更精細(xì)控制HTTP請求和響應(yīng)的場景,可以使用Apache HttpClient。
優(yōu)勢:
功能豐富:支持HTTP/1.1和HTTP/2,提供豐富的API來構(gòu)建和發(fā)送HTTP請求。
靈活性強(qiáng):可以自定義請求頭、請求體、連接池等參數(shù)。
可擴(kuò)展性好:支持插件式擴(kuò)展,可以根據(jù)需要添加自定義功能。
實(shí)現(xiàn)方式:使用HttpClientBuilder構(gòu)建HttpClient實(shí)例,通過HttpClient實(shí)例發(fā)送HTTP請求并處理響應(yīng)。
4. 其他方式
- Spring的RestTemplate:在Spring框架中,RestTemplate提供了簡化的方式來調(diào)用RESTful服務(wù)。它內(nèi)部封裝了HttpClient,提供了更加簡潔的API。
- WebClient:在Spring WebFlux中,WebClient是一個(gè)響應(yīng)式、非阻塞的HTTP客戶端,用于調(diào)用RESTful服務(wù)。
- GraphQL客戶端:如果第三方接口支持GraphQL,可以使用GraphQL客戶端庫(如Apollo、Relay等)來調(diào)用。
三、SpringBoot 第三方接口調(diào)用示例
1. JDK HttpClient
自Java 11起,JDK自帶了一個(gè)全新的HTTP客戶端API,用于發(fā)送HTTP請求和接收HTTP響應(yīng)。
它提供了同步和異步的API,支持HTTP/1.1和HTTP/2,并且是基于CompletableFuture實(shí)現(xiàn)的異步操作。
import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.net.http.HttpTimeoutException; public class JdkHttpClientTest { public static void main(String[] args) { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://123.com")) .build(); try { HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode()); System.out.println(response.body()); } catch (Exception e) { e.printStackTrace(); } } }
2. Apache HttpClient
Apache HttpClient是一個(gè)功能豐富的HTTP客戶端庫,由Apache Software Foundation開發(fā),廣泛應(yīng)用于各種Java項(xiàng)目中,用于發(fā)送HTTP請求和接收HTTP響應(yīng)。
public class ApacheHttpClientTest { public static void main(String[] args) { HttpGet request = new HttpGet("https://1234.com"); CloseableHttpClient client = HttpClients.custom().build(); try { HttpClientResponseHandler<String> responseHandler = new BasicHttpClientResponseHandler(); String ret = client.execute(httpget, responseHandler) ; System.out.println(ret) ; } catch (Exception e) { e.printStackTrace(); } } }
3. OkHttp
OkHttp是一款由Square公司貢獻(xiàn)的開源網(wǎng)絡(luò)請求的輕量級框架,主要用于Android和Java應(yīng)用。它作為現(xiàn)代HTTP客戶端,具備高效、易用、功能強(qiáng)大的特點(diǎn)。
public void OkHttpClientTest() { // 1. 創(chuàng)建一個(gè)OkHttpClient實(shí)例 OkHttpClient client = new OkHttpClient(); // 2. 創(chuàng)建一個(gè)Request對象 Request request = new Request.Builder().url("http://1234.com") // 設(shè)置請求的URL .build(); // 3. 發(fā)送請求并獲取Response對象 try (Response response = client.newCall(request).execute()) { String responseBody = response.body().string(); System.out.println(responseBody); } catch (IOException e) { e.printStackTrace(); } }
4. RestTemplate
RestTemplate是Spring框架中的一個(gè)類,它提供了一個(gè)高層次的RESTful web service客戶端。
它簡化了與RESTful web services的集成,并提供了多種方法來發(fā)送HTTP請求和接收HTTP響應(yīng)。
public class RestTemplateTest { public static void main(String[] args) { RestTemplate restTemplate = new RestTemplate(); String response = restTemplate.getForObject("https://1234.com", String.class); System.out.println(response); } }
5. WebClient
WebClient 是Spring WebFlux提供的一個(gè)非阻塞的、響應(yīng)式的Web客戶端,用于發(fā)起HTTP請求。它特別適用于響應(yīng)式編程模型和Spring WebFlux應(yīng)用程序。
public class WebClientExample { public static void main(String[] args) { WebClient webClient = WebClient.create("http://1234.com"); webClient.get() .uri("/api/data") .retrieve() .bodyToMono(String.class) .subscribe( body -> System.out.println(body), error -> System.err.println("Error occurred: " + error) ); } }
6. OpenFeign
注意這里是OpenFeign可不是Spring Cloud OpenFeign,Spring Cloud openfeign對OpenFeign進(jìn)行了包裝,所以在使用上是有差別的。
添加依賴
<dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-core</artifactId> <version>13.2.1</version> </dependency>
public interface MyFeignClient { @RequestLine("GET /api/data") String getData(); static MyFeignClient create() { return Feign.builder() .encoder(new JacksonEncoder()) .decoder(new JacksonDecoder()) .logger(new Logger.ErrorLogger()) .logLevel(Level.FULL) .retryer(new Retryer.Default(100, TimeUnit.MILLISECONDS.toMillis(1), 5)) .target(Target.EmptyTarget.create(MyFeignClient.class, "http://123456.com")); } }
MyFeignClient client = MyFeignClient.create(); String data = client.getData(); System.out.println(data);
以上對 Spring Boot 調(diào)用外部接口的六種方式進(jìn)行了簡單介紹,但實(shí)踐中需要依據(jù)項(xiàng)目具體需求和實(shí)際情況進(jìn)行選擇,以確保項(xiàng)目導(dǎo)向和效率最優(yōu)。
到此這篇關(guān)于SpringBoot調(diào)用第三方接口的幾種方式小結(jié)的文章就介紹到這了,更多相關(guān)SpringBoot調(diào)用第三方接口內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
maven package 打包報(bào)錯(cuò) Failed to execute goal的解決
這篇文章主要介紹了maven package 打包報(bào)錯(cuò) Failed to execute goal的解決,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-11-11Spring?Data?Jpa返回自定義對象的3種方法實(shí)例
在使用Spring Data Jpa框架時(shí),根據(jù)業(yè)務(wù)需求我們通常需要進(jìn)行復(fù)雜的數(shù)據(jù)庫查詢,下面這篇文章主要給大家介紹了關(guān)于Spring?Data?Jpa返回自定義對象的3種方法,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-08-08Java與Oracle實(shí)現(xiàn)事務(wù)(JDBC事務(wù))實(shí)例詳解
這篇文章主要介紹了Java與Oracle實(shí)現(xiàn)事務(wù)(JDBC事務(wù))實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下2017-05-05IDEA創(chuàng)建Java項(xiàng)目文件并運(yùn)行教程解析
這篇文章主要介紹了IDEA創(chuàng)建Java項(xiàng)目文件并運(yùn)行教程解析,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-11-11Spring 定時(shí)任務(wù)@Scheduled 注解中的 Cron 表達(dá)式詳解
Cron 表達(dá)式是一種用于定義定時(shí)任務(wù)觸發(fā)時(shí)間的字符串表示形式,它由七個(gè)字段組成,分別表示秒、分鐘、小時(shí)、日期、月份、星期和年份,這篇文章主要介紹了Spring 定時(shí)任務(wù)@Scheduled 注解中的 Cron 表達(dá)式,需要的朋友可以參考下2023-07-07