Spring Cloud Feign實現動態(tài)URL
需求描述
動態(tài)URL的需求場景：
有一個異步服務S，它為其他業(yè)務（業(yè)務A，業(yè)務B...）提供異步服務接口，在這些異步接口中執(zhí)行完指定邏輯之后需要回調相應業(yè)務方的接口。
這在諸如風控審核，支付回調等場景中挺常見的。
那么，這個回調業(yè)務方接口該怎么實現呢？
首先，需要約定好回調這些業(yè)務方接口時的請求方法（通常為POST請求），請求參數格式（通常為JSON格式，方便擴展）和響應消息格式（通常為JSON格式）。
具體調用業(yè)務方接口時有2種辦法來實現：
1.在服務S的每一個異步接口中都獨立寫一套回調的邏輯
2.因為回調的方法類型和參數格式是約定好的，所以可以寫一個統(tǒng)一的公共回調方法即可
方法1顯然不是最優(yōu)選擇，這樣做會帶來大量重復的代碼邏輯，而且非常不利用后期維護和升級。
方法2的實現更加靈活一些，便于擴展。
如下將闡述如何使用Feign框架定義一個公共的回調方法。
具體實現
在Feign中能實現動態(tài)URL的基礎是框架本身就支持，只需要在接口方法中包含一個java.net.URI參數，Feign就會將該參數值作為目標主機地址，詳見Interface Annotations一節(jié)中的“Overriding the Request Line”部分。
如下將分別闡述獨立使用Feign和使用Spring Cloud OpenFeign實現定義統(tǒng)一的回調方法。
使用Feign定義統(tǒng)一回調方法
定義統(tǒng)一回調方法：
public interface CallbackAPI {
? ? /**
? ? ?* 統(tǒng)一回調接口方法，請求消息體格式為JSON，響應消息體格式也為JSON
? ? ?* @param host 接口主機地址，如：http://localhost:8080，該參數是實現動態(tài)URL的關鍵
? ? ?* @param path 接口路徑，如：/test/hello
? ? ?* @param queryMap 動態(tài)URL參數集合
? ? ?* @param body 請求消息體對象
? ? ?* @return
? ? ?*/
? ? @RequestLine("POST {path}")
? ? @Headers({
? ? ? ? "Content-Type: application/json",
? ? ? ? "Accept: application/json"
? ? })
? ? Object callback(URI host, @Param("path") String path, @QueryMap Map<String, Object> queryMap, Subject body);
? ?/**
? ? ?* 統(tǒng)一回調接口方法，請求消息體格式為JSON，響應消息體格式也為JSON
? ? ?* @param uri 完整的請求路徑地址，如：http://localhost:8080/test/hello
? ? ?* @param queryMap 動態(tài)URL參數集合
? ? ?* @param body 請求消息體對象
? ? ?* @return
? ? ?*/
? ? @RequestLine("POST")
? ? @Headers({
? ? ? ? "Content-Type: application/json",
? ? ? ? "Accept: application/json"
? ? })
? ? Object callback(URI uri, @QueryMap Map<String, Object> queryMap, Subject body);
}調用回調方法：
CallbackAPI callbackAPI = Feign.builder()
? ? ? ? .encoder(new GsonEncoder())
? ? ? ? .decoder(new GsonDecoder())
? ? ? ? .logger(new Slf4jLogger())
? ? ? ? .logLevel(Logger.Level.FULL)
? ? ? ? .target(CallbackAPI.class, "EMPTY"); // 注意：這里的url參數不能為空字符串，但是可以設置為任意字符串值，在這里設置為“EMPTY”
String uri = "http://localhost:8080";
Map<String, Object> queryMap = new HashMap<>(0);
queryMap.put("k", "v");
Subject body = Subject.builder().id(10).build();
// 請求主機地址與路徑分開傳遞
callbackAPI.callback(URI.create(uri), "/test/simple/post/json", queryMap, body);
// 直接將完整請求完整路徑作為uri類型參數
callbackAPI.callback(URI.create("http://localhost:8080/test/simple/post/json"), queryMap, body);詳細請求日志如下：
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] ---> POST http://localhost:8080/test/simple/post/json?k=v HTTP/1.1
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] Accept: application/json
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] Content-Length: 14
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] Content-Type: application/json
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback]
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] {
"id": 10
}
2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] ---> END HTTP (14-byte body)
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] <--- HTTP/1.1 200 (32ms)
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] connection: keep-alive
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] content-length: 9
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] content-type: application/json
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] date: Mon, 14 Feb 2022 07:32:13 GMT
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] keep-alive: timeout=60
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback]
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] {"id":10}
2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] <--- END HTTP (9-byte body)
顯然，動態(tài)設置目標主機和接口路徑已經成功了。
使用Spring Cloud Feign定義統(tǒng)一回調方法
在Spring Cloud Feign中實現定義統(tǒng)一回調接口方法可以直接使用注解進行標注，非常簡潔。
定義統(tǒng)一回調方法：
// 注意：這里的url屬性值不能為空字符串，但是可以設置為任意字符串值，在這里設置為“EMPTY”
@FeignClient(value = "CallbackAPI", url = "EMPTY", configuration = CallbackConfiguration.class)
public interface CallbackAPI {
? ? /**
? ? ?* 統(tǒng)一回調接口方法，請求消息體格式為JSON，響應消息體格式也為JSON
? ? ?* @param host 接口主機地址，如：http://localhost:8080
? ? ?* @param path 接口路徑，如：/test/hello
? ? ?* @param queryMap 動態(tài)URL參數集合
? ? ?* @param body 請求消息體對象
? ? ?* @return
? ? ?*/
? ? @RequestMapping(value = "{path}", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
? ? Object callback(URI host,
? ? ? ? ? ? ? ? ? ? @PathVariable("path") String path,
? ? ? ? ? ? ? ? ? ? @SpringQueryMap Map<String, Object> queryMap,
? ? ? ? ? ? ? ? ? ? @RequestBody Object body);
? ? /**
? ? ?* 統(tǒng)一回調接口方法，請求消息體格式為JSON，響應消息體格式也為JSON
? ? ?* @param uri 完整的請求路徑地址，如：http://localhost:8080/test/hello
? ? ?* @param queryMap 動態(tài)URL參數集合
? ? ?* @param body 請求消息體對象
? ? ?* @return
? ? ?*/
? ? @RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
? ? Object callback(URI uri,
? ? ? ? ? ? ? ? ? ? @SpringQueryMap Map<String, Object> queryMap,
? ? ? ? ? ? ? ? ? ? @RequestBody Object body);
}
// 回調接口配置
public class CallbackConfiguration {
? ? @Bean
? ? public Encoder feignEncoder() {
? ? ? ? return new GsonEncoder();
? ? }
? ? @Bean
? ? public Decoder feignDecoder() {
? ? ? ? return new GsonDecoder();
? ? }
? ? @Bean
? ? public Retryer feignRetryer() {
? ? ? ? return new Retryer.Default();
? ? }
? ? @Bean
? ? public Logger feignLogger() {
? ? ? ? return new Slf4jLogger();
? ? }
? ? @Bean
? ? public Logger.Level feignLoggerLevel() {
? ? ? ? return Logger.Level.FULL;
? ? }
}調用回調方法：
@Autowired
CallbackAPI callbackAPI;
String uri = "http://localhost:8080";
Map<String, Object> queryMap = new HashMap<>(0);
queryMap.put("k", "v");
Subject subject = Subject.builder().id(10).build();
// 請求主機地址與路徑分開傳遞
this.callbackAPI.callback(URI.create(uri), "/test/simple/post/json", queryMap, subject);
// 直接將完整請求完整路徑作為uri類型參數
this.callbackAPI.callback(URI.create("http://localhost:8080/test/simple/post/json"), queryMap, subject);詳細請求日志如下：
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] ---> POST http://localhost:8080/test/simple/post/json?k=v HTTP/1.1
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] Accept: application/json
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] Content-Length: 14
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] Content-Type: application/json
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback]
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] {
"id": 10
}
2022-02-14 15:38:38.908 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] ---> END HTTP (14-byte body)
2022-02-14 15:38:38.924 DEBUG 20184 --- [ main] s.n.www.protocol.http.HttpURLConnection : sun.net.www.MessageHeader@539c48307 pairs: {POST /test/simple/post/json?k=v HTTP/1.1: null}{Accept: application/json}{Content-Type: application/json}{User-Agent: Java/1.8.0_271}{Host: localhost:8080}{Connection: keep-alive}{Content-Length: 14}
2022-02-14 15:38:38.945 DEBUG 20184 --- [ main] s.n.www.protocol.http.HttpURLConnection : sun.net.www.MessageHeader@681e913c6 pairs: {null: HTTP/1.1 200}{Content-Type: application/json}{Content-Length: 9}{Date: Mon, 14 Feb 2022 07:38:38 GMT}{Keep-Alive: timeout=60}{Connection: keep-alive}
2022-02-14 15:38:38.952 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] <--- HTTP/1.1 200 (37ms)
2022-02-14 15:38:38.952 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] connection: keep-alive
2022-02-14 15:38:38.952 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] content-length: 9
2022-02-14 15:38:38.952 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] content-type: application/json
2022-02-14 15:38:38.952 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] date: Mon, 14 Feb 2022 07:38:38 GMT
2022-02-14 15:38:38.953 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] keep-alive: timeout=60
2022-02-14 15:38:38.953 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback]
2022-02-14 15:38:38.955 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] {"id":10}
2022-02-14 15:38:38.955 DEBUG 20184 --- [ main] feign.Logger : [CallbackAPI#callback] <--- END HTTP (9-byte body)
從日志詳情看，在Spring Cloud Feign中同樣實現動態(tài)URL的效果。
總結
在Feign中實現動態(tài)URL時：
1.可以使用URI類型的參數作為請求目標主機地址或者完整請求地址
2.如果URI類型的參數值僅為主機部分，請求路徑部分可以使用表達式進行替換
【參考】
https://www.cnblogs.com/syui-terra/p/14386188.html Feign 動態(tài)URL 解決記錄
https://blog.csdn.net/kysmkj/article/details/89672952 Feign 訪問遠程api，動態(tài)指定url
到此這篇關于Spring Cloud Feign實現動態(tài)URL的文章就介紹到這了,更多相關Spring Cloud Feign 動態(tài)URL內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要為大家詳細介紹了如何利用Java實現一個簡單的非阻塞式服務器，文中的示例代碼講解詳細，具有一定的學習價值，需要的可以參考一下2023-05-05
Optional項是一個容器對象,它可以包含非空值,也可以不包含非空值,它用于表示沒有值,而不是使用?null,引入Optional項是為了幫助開發(fā)人員編寫更簡潔、更具表現力的代碼,并避免?NullPointerException2024-01-01
這篇文章主要為大家詳細介紹了Java字符串轉成二進制碼的方法，具有一定的參考價值，感興趣的小伙伴們可以參考一2017-05-05
SpringBoot與Spring中數據緩存Cache超詳細講解
我們知道內存讀取速度遠大于硬盤讀取速度，當需要重復獲取相同數據時，一次一次的請求數據庫或者遠程服務，導致在數據庫查詢或者遠程方法調用上小號大量的時間，最終導致程序性能降低，這就是數據緩存要解決的問題，學過計算機組成原理或者操作系統(tǒng)的同學們應該比較熟悉2022-10-10
這兩天公司有需求讓做一個商戶注冊的后臺功能，其中需要商戶上傳多張圖片并回顯，本文就使用SpringBoot2.0實現，具有一定的參考價值，感興趣的可以了解一下2021-07-07
這篇文章主要介紹了數據結構基本算法希爾排序的相關資料,需要的朋友可以參考下2017-08-08
這篇文章主要介紹了Springboot2.0處理自定義異常并返回json,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-11-11
這篇文章主要介紹了SpringBoot多線程@Async的使用體驗，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-12-12
TCP是一種傳輸控制協(xié)議，是面向連接的、可靠的、基于字節(jié)流之間的傳輸層通信協(xié)議，由IETF的RFC 793定義。在簡化的計算機網絡OSI模型中，TCP完成第四層傳輸層所指定的功能2021-06-06
今天小編就為大家分享一篇Java Unsafe學習筆記，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-11-11