SpringCloud OpenFeign自定義結(jié)果解碼器方式
SpringCloud OpenFeign自定義結(jié)果解碼器
我們在定義微服務(wù)接口的時候，通常會使用一個Result類進行封裝，將提示信息，返回對象和狀態(tài)碼等內(nèi)容封裝到一起返回給調(diào)用方，
例如
如下的格式：
public class Result<T> {
/**
* 響應(yīng)碼，200為成功
*/
private Integer code;
/**
* 失敗時的具體失敗信息
*/
private String message;
/**
* 失敗信息是否為用戶提示，如果是的話框架不會主動攔截該錯誤
*/
private boolean userPrompt;
/**
* 響應(yīng)的具體對象
*/
private T data;
}而調(diào)用方在使用Spring Cloud OpenFeign定義的客戶端調(diào)用遠程服務(wù)時，默認(rèn)的解碼器只能按照定義的方法返回類型對接口的返回結(jié)果進行強制轉(zhuǎn)換，沒辦法實現(xiàn)一些自定義的邏輯，比如將統(tǒng)一返回的Result類重新拆開，僅返回對應(yīng)的業(yè)務(wù)對象，或者對特定的響應(yīng)碼進行處理等等。
為了實現(xiàn)上述功能，我們就需要改造默認(rèn)的Decoder。
Spring Cloud OpenFeign允許我們在定義一個Feign Client的時候，指定一個額外的配置類，比如：
@FeignClient(name = "stores", configuration = CustomizedConfiguration.class)
public interface StoreClient {
//..
}而這個配置類就可以作為我們的擴展點，我們可以在CustomizedConfiguration中定義一個自己的Decoder來覆蓋默認(rèn)的配置。
Spring Cloud對Feign的封裝和默認(rèn)配置可以查看官方文檔。
自定義的Decoder需要實現(xiàn)feign.codec.Decoder接口，也可以參考默認(rèn)的Decoder的實現(xiàn)邏輯（org.springframework.cloud.openfeign.support.ResponseEntityDecoder），下面的實現(xiàn)可以對統(tǒng)一返回值Result類的拆分，并對異常返回進行處理：
public class FeignResultDecoder implements Decoder {
@Override
public Object decode(Response response, Type type) throws IOException, DecodeException, FeignException {
if (response.body() == null) {
throw new DecodeException(response.status(), "沒有返回有效的數(shù)據(jù)", response.request());
}
String bodyStr = Util.toString(response.body().asReader(Util.UTF_8));
//對結(jié)果進行轉(zhuǎn)換
Result result = (Result) JsonUtil.json2obj(bodyStr, type);
//如果返回錯誤，且為內(nèi)部錯誤，則直接拋出異常
if (result.getCode() != ResultCode.SUCCESS.code) {
if (!result.isUserPrompt()) {
throw new DecodeException(response.status(), "接口返回錯誤：" + result.getMessage(), response.request());
}
}
return result.data;
}
}其中如何將response中的json轉(zhuǎn)換為實際的返回類型很費了一些功夫，因為可能存在復(fù)雜的嵌套關(guān)系和泛型定義，最后才發(fā)現(xiàn)jackson框架已經(jīng)有默認(rèn)的實現(xiàn)了…
代碼如下：
public static <T> T json2obj(String jsonStr, Type targetType) {
try {
JavaType javaType = TypeFactory.defaultInstance().constructType(targetType);
return mapper.readValue(jsonStr, javaType);
} catch (IOException e) {
throw new IllegalArgumentException("將JSON轉(zhuǎn)換為對象時發(fā)生錯誤:" + jsonStr, e);
}
}實現(xiàn)了Decoder之后，只需要將其配置到CustomizedConfiguration中即可，注意如果CustomizedConfiguration添加了@Configuration的注解，則會成為Feign Client構(gòu)建的默認(rèn)配置，這樣就不需要在每個@FeignClient注解中都去指定配置類了：
public class CustomizedConfiguration{
@Bean
public Decoder feignDecoder() {
return new FeignResultDecoder();
}
}添加了自定義的Decoder之后，如果一個遠程接口的定義是這樣的：
@GetMapping("/api/user/detail")
public Result<User> detailById(@RequestParam("id") Integer id) {
User user = userService.getById(id);
return ResultGenerator.genSuccessResult(user);
}我們定義Feign Client方法的時候，方法的返回值可以直接使用Result的泛型類型：
@RequestMapping(value = "/api/user/detail", method = RequestMethod.GET)
public User detailById(@RequestParam("id") Integer id)類似的方式，我們還可以自定義Feign的Encoder，ErrorDecoder等關(guān)鍵配置組件。
總結(jié)
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Spring@Value使用獲取配置信息為null的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
在使用切面編程時,通常需要為以下類或組件添加注解來標(biāo)識它們,以便 Spring 或其他切面框架能夠正確識別和處理它們,這篇文章主要介紹了Spring使用aop切面編程時要給那些類加注解,需要的朋友可以參考下2023-11-11
Spring MVC 請求參數(shù)綁定實現(xiàn)方式
Spring MVC 是一個用于構(gòu)建 Web 應(yīng)用程序的框架,它提供了一種方便的方式來處理 HTTP 請求和響應(yīng),Spring MVC 提供了多種方式來實現(xiàn)請求參數(shù)綁定,本文結(jié)合實例代碼給大家介紹的非常詳細(xì),需要的朋友跟隨小編一起看看吧2023-09-09
Java Vector和ArrayList的異同分析及實例講解
在本篇文章里小編給大家整理的是一篇關(guān)于Java Vector和ArrayList的異同分析及實例講解內(nèi)容，有興趣的朋友們可以學(xué)習(xí)參考下。2021-01-01
Springboot Mybatis Plus自動生成工具類詳解代碼
java書店系統(tǒng)畢業(yè)設(shè)計 用戶模塊（3）
淺析SpringBoot2底層注解@Conditional@ImportResource