Java 如何使用Feign發(fā)送HTTP請(qǐng)求
在往常的 HTTP 調(diào)用中,一直都是使用的官方提供的 RestTemplate 來進(jìn)行遠(yuǎn)程調(diào)用,該調(diào)用方式將組裝代碼冗余到正常業(yè)務(wù)代碼中,不夠優(yōu)雅,因此在接觸到 Feign 后,考慮使其作為一個(gè) HTTP 發(fā)送基礎(chǔ),來進(jìn)行遠(yuǎn)程調(diào)用。
下面就讓我們來看一下,其是如何使用的。
引入依賴
首先,我們需要將 Feign 的基礎(chǔ)依賴引入項(xiàng)目,因?yàn)槲覀冎皇褂?Feign 的 remote 功能,因此,只引入基礎(chǔ)依賴。
此外在項(xiàng)目中,我們還自定義了了 JSON 轉(zhuǎn)換和 log 設(shè)置,因此還需要引入這些的第三方依賴,如下所示。
<!-- feign --> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-core</artifactId> <version>10.10.1</version> </dependency> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-gson</artifactId> <version>10.10.1</version> </dependency> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-slf4j</artifactId> <version>10.10.1</version> </dependency>
發(fā)送路徑和方法設(shè)置
然后,因?yàn)?Feign 是一種申明式的調(diào)用,因此我們需要配置發(fā)送的接口路徑和發(fā)送接口定義,看下面的例子。
@RequestLine('GET /user/getone?arkOrgId={arkOrgId}&userId={userId}') JSONObject getOneStaff(@Param('arkOrgId') String arkOrgId,@Param('userId') String userId); @RequestLine('POST /user/add') @Headers('Content-Type: application/json') @Body('{body}') JSONObject saveStaff(@Param('body') SaveEmployeeDTO saveEmployeeDTO);
在代碼實(shí)例中,我們定義了兩種發(fā)送的實(shí)例,一種是 GET 請(qǐng)求,一種是 POST 請(qǐng)求,下面,我們分別來看一下其中的代碼的作用是什么。
@RequestLine:定義發(fā)送方式和發(fā)送接口定義,其中用 GET 和 POST 來定義發(fā)送方式,然后空格后,寫上 servelt path(context path 和域名或ip端口號(hào)在其他地方配置); {}:用來作為占位符,動(dòng)態(tài)填充需要的參數(shù); @Param:用來匹配 URI 中的占位符; @Headers('Content-Type: application/json'):構(gòu)建請(qǐng)求表頭,在 POST 請(qǐng)求中,需要聲明該請(qǐng)求的發(fā)送格式為 json; @Body:POST 請(qǐng)求,需要標(biāo)注請(qǐng)求體; JSONObject:在本實(shí)例中,采用是一個(gè)通用的 json 對(duì)象來接收,方便統(tǒng)一,在自己的代碼中,也可以定義一個(gè)接受實(shí)體類來接受,作用是一樣的。POST 請(qǐng)求,需要在實(shí)體中重寫 toString() 方法,使其在發(fā)送時(shí)調(diào)用該方法后,是一個(gè) JSON 字符串,詳細(xì)見后文 Tips 中寫的。
定義發(fā)送客戶端
@Configurationpublic class FeignConfig { public static final String DATE_TIME_FORMAT = 'yyyy-MM-dd HH:mm:ss'; @Value('${staff.base.url}') private String staffBaseUrl; @Bean public StaffFeignService staffFeignService() { GsonBuilder builder = new GsonBuilder(); builder.setDateFormat(DATE_TIME_FORMAT); return Feign.builder().retryer(closeFeignRetry()).decoder(new GsonDecoder(builder.create())).encoder(new GsonEncoder()).logger(new Slf4jLogger()).logLevel(Logger.Level.FULL).target(StaffFeignService.class, staffBaseUrl); } /** * 關(guān)閉feign的失敗重試功能 */ @Bean public Retryer closeFeignRetry() { return Retryer.NEVER_RETRY; } @Bean public Request.Options options() { return new Request.Options(15000, 30000); }}
緊接著,我們來定義發(fā)送客戶端。
首先,我們采用 @Value 來動(dòng)態(tài)添加路由,這樣,就可以根據(jù)在配置文件中的屬性來添加 context path,從而做到可拓展。
然后,feign 的很多配置都是可以根據(jù)自身項(xiàng)目需要在 DIY 的,因此在這里,我們配置了編解碼采用 GSON 的編解碼器,日志級(jí)別設(shè)置全打印。通過該設(shè)置來生成一個(gè) Feign 客戶端。
Feign 官方文檔,在官方文檔中,有詳細(xì)的配置說明,根據(jù)自身需要使用,即可。
使用
@AutowiredStaffFeignService staffFeignService;// get 請(qǐng)求JSONObject saveSingleQrCode = staffFeignService.saveSingleQrCode(userId);// post 請(qǐng)求SaveMultiQrCodesDTO saveMultiQrCodesDTO = new SaveMultiQrCodesDTO();;JSONObject saveMultiQrCodes = staffFeignService.saveMultiQrCodes(saveMultiQrCodesDTO);
通過該方式,即可發(fā)送對(duì)應(yīng)請(qǐng)求。
Tips
記錄一些在使用中的重點(diǎn),需要注意。
重寫 toString() 方法在發(fā)送 JSON 時(shí),需要重寫 toString() 方法,否則會(huì)導(dǎo)致接受方,無法用 json 進(jìn)行解析。
@Override public String toString() { return JSON.toJSONString(this); }
異步客戶端
有時(shí)候,我們使用異步發(fā)送,從而不影響我們的主體業(yè)務(wù),F(xiàn)eign 也支持該種配置。
@Bean public IHermesFeignService hermesFeignService() { GsonBuilder builder = new GsonBuilder(); builder.setDateFormat(DATE_TIME_FORMAT); return AsyncFeign.asyncBuilder().decoder(new GsonDecoder(builder.create())).encoder(new GsonEncoder(builder.create())).logger(new Slf4jLogger()).logLevel(Logger.Level.FULL).target(IHermesFeignService.class, hermesBaseUrl); }
重點(diǎn),就是在構(gòu)建 Feign 時(shí),采用 AsyncFeign.asyncBuilder() 來進(jìn)行構(gòu)建。
以上就是Java 如何使用Feign發(fā)送HTTP請(qǐng)求的詳細(xì)內(nèi)容,更多關(guān)于使用Feign發(fā)送HTTP請(qǐng)求的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
