Spring Cloud中使用Feign,@RequestBody無法繼承的解決方案

Posted on by

使用Feign,@RequestBody無法繼承的問題

根據官網FeignClient的例子，編寫一個簡單的updateUser接口，定義如下

@RequestMapping("/user")
public interface UserService {
    @RequestMapping(value = "/{userId}", method = RequestMethod.GET)
    UserDTO findUserById(@PathVariable("userId") Integer userId);
    @RequestMapping(value = "/update", method = RequestMethod.POST)
    boolean updateUser(@RequestBody UserDTO user);
}

實現類

 @Override
    public boolean updateUser(UserDTO user)
    {   
        LOGGER.info("===updateUser, id = " + user.getId() + " ,name= " + user.getUsername());
        return false;
    }

執行單元測試，發現沒有獲取到預期的輸入參數

2018-09-07 15:35:38,558 [http-nio-8091-exec-5] INFO [com.springboot.user.controller.UserController] {} – ===updateUser, id = null ,name= null

原因分析

SpringMVC中使用RequestResponseBodyMethodProcessor類進行入參、出參的解析。以下方法根據參數是否有@RequestBody註解判斷是否進行消息體的轉換。

@Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(RequestBody.class);
    }

解決方案

既然MVC使用RequestResponseBodyMethodProcessor進行參數解析，可以實現一個定制化的Processor，修改supportParameter的判斷方法。

 @Override
    public boolean supportsParameter(MethodParameter parameter)
    {
        //springcloud的接口入參沒有寫@RequestBody，並且是自定義類型對象 也按JSON解析
        if (AnnotatedElementUtils.hasAnnotation(parameter.getContainingClass(), FeignClient.class) && isCustomizedType(parameter.getParameterType())) {
            return true;
        }
        return super.supportsParameter(parameter);
    }

此處的判斷邏輯可以根據實際框架進行定義，目的是判斷到為Spring Cloud定義的接口，並且是自定義對象時，使用@RequestBody相同的內容轉換器。

實現定制化的Processor後，還需要讓自定義的配置生效，有兩種方案可選：

  • 直接替換RequestResponseBodyMethodProcessor，在SpringBoot下需要自定義RequestMappingHandlerAdapter。
  • 實現WebMvcConfigurer中的addArgumentResolvers接口

這裡采用較為簡單的第二種方式，初始化時的消息轉換器根據需要進行加載：

public class XXXWebMvcConfig implements WebMvcConfigurer
{
@Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers)
    {
        StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
        stringHttpMessageConverter.setWriteAcceptCharset(false);
        List<HttpMessageConverter<?>> messageConverters = new ArrayList<>(5);
        messageConverters.add(new ByteArrayHttpMessageConverter());
        messageConverters.add(stringHttpMessageConverter);
        messageConverters.add(new SourceHttpMessageConverter<>());
        messageConverters.add(new AllEncompassingFormHttpMessageConverter());
        CustomizedMappingJackson2HttpMessageConverter jackson2HttpMessageConverter = new CustomizedMappingJackson2HttpMessageConverter();
        jackson2HttpMessageConverter.setObjectMapper(defaultObjectMapper());
        messageConverters.add(jackson2HttpMessageConverter);
        ViomiMvcRequestResponseBodyMethodProcessor resolver = new ViomiMvcRequestResponseBodyMethodProcessor(messageConverters);
        resolvers.add(resolver);
    }

修改完成後，微服務的實現類即可去掉@RequestBody註解。

使用feign遇到的問題

spring cloud 使用feign 項目的搭建 在這裡就不寫瞭，本文主要講解在使用過程中遇到的問題以及解決辦法

1、示例

@RequestMapping(value = "/generate/password", method = RequestMethod.POST)
KeyResponse generatePassword(@RequestBody String passwordSeed);

在這裡 隻能使用 @RequestMapping(value = “/generate/password”, method = RequestMethod.POST) 註解 不能使用

@PostMapping 否則項目啟動會報

Caused by: java.lang.IllegalStateException: Method generatePassword not annotated with HTTP method type (ex. GET, POST) 異常

2、首次訪問超時問題

原因：Hystrix默認的超時時間是1秒，如果超過這個時間尚未響應，將會進入fallback代碼。

而首次請求往往會比較慢（因為Spring的懶加載機制，要實例化一些類），這個響應時間可能就大於1秒瞭。

解決方法：

<1：配置Hystrix的超時時間改為5秒

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 5000

<2：禁用Hystrix的超時時間

hystrix.command.default.execution.timeout.enabled: false

<3：禁用feign的hystrix 功能

feign.hystrix.enabled: false

註：個人推薦 第一 或者第二種 方法

3、FeignClient接口中

如果使用到@PathVariable，必須指定其value

spring cloud feign 使用 Apache HttpClient

問題：1 沒有指定 Content-Type 是情況下 會出現如下異常 ？ 這裡很納悶？

Caused by: java.lang.IllegalArgumentException: MIME type may not contain reserved characters

在這裡有興趣的朋友可以去研究下源碼

ApacheHttpClient.class 
  private ContentType getContentType(Request request) {
    ContentType contentType = ContentType.DEFAULT_TEXT;
    for (Map.Entry<String, Collection<String>> entry : request.headers().entrySet())
    // 這裡會判斷 如果沒有指定 Content-Type 屬性 就使用上面默認的 text/plain; charset=ISO-8859-1
    // 問題出在默認的 contentType ： 格式 text/plain; charset=ISO-8859-1 
    // 轉到 ContentType.create(entry.getValue().iterator().next(), request.charset()); 方法中看
    if (entry.getKey().equalsIgnoreCase("Content-Type")) {
      Collection values = entry.getValue();
      if (values != null && !values.isEmpty()) {
        contentType = ContentType.create(entry.getValue().iterator().next(), request.charset());
        break;
      }
    }
    return contentType;
  }
ContentType.class
   public static ContentType create(final String mimeType, final Charset charset) {
        final String normalizedMimeType = Args.notBlank(mimeType, "MIME type").toLowerCase(Locale.ROOT);
 // 問題在這 check  中 valid f方法中
        Args.check(valid(normalizedMimeType), "MIME type may not contain reserved characters");
        return new ContentType(normalizedMimeType, charset);
    }
   private static boolean valid(final String s) {
        for (int i = 0; i < s.length(); i++) {
            final char ch = s.charAt(i);
     // 這裡 在上面 text/plain;charset=UTF-8 中出現瞭 分號 導致檢驗沒有通過 
            if (ch == '"' || ch == ',' || ch == ';') {
                return false;
            }
        }
        return true;
    }

解決辦法 ：

@RequestMapping(value = "/generate/password", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)

註解中指定： Content-Type 即 指定 consumes 的屬性值 ： 這裡 consumes 屬性的值在這不做具體講解，有興趣的可以去研究下

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：