Spring cloud Feign不支持對象傳參解決辦法[完美解決]

    spring cloud 使用 Feign 進行服務調用時，不支持對象參數。

    通常解決方法是，要么把對象每一個參數平行展開，並使用 @RequestParam 標識出每一個參數，要么用 @RequestBody 將請求改為 body 傳參，雖然這樣解決了問題，但是這樣限制了傳參方式，並且使代碼變得很繁重。

    以下為完美解決 Feign 對象傳參問題的辦法。

1. 引入如下依賴（可以在maven倉庫中搜索 strongfeign）

<dependency>
    <groupId>com.moonciki.strongfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
    <version>10.2.3</version>
</dependency>

該源碼修改自 https://github.com/OpenFeign/feign，提交過pr，但是項目原作者並沒有采納，pr地址如下：https://github.com/OpenFeign/feign/pull/949

之后為了同步到了maven 倉庫，做了相應刪減及pom的變更，具體改動可參考github。地址：https://github.com/cdmamata/strong-feign

注意：不要使用 10.3.x版本，該版本有問題。如果jar包無法下載請使用 maven 中央倉庫。

2. 創建如下三個類

    開始時，打算把以下三個類加進倉庫中，但由於如下三個類內容不多，並且有很多定制化的可能，因此單獨實現。

    2.1 ParamModel.java

package com.moonciki.strongfeign.model.annotation;

import java.lang.annotation.*;

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ParamModel {
    String value() default "";
}

    2.2 ModelExpander.java

package com.moonciki.strongfeign.model.expander;

import com.alibaba.fastjson.JSON;
import feign.Param;
import lombok.extern.slf4j.Slf4j;

import java.util.Map;

@Slf4j
public class ModelExpander implements Param.Expander {

    public String expand(Object value) {
        String objectJson = JSON.toJSONString(value);
        return objectJson;
    }

    @Override
    public String expandWithName(Object value, String name) {
        String valueExpand = null;

        if(value != null){
            if(name != null) {
                try {
                    Map<String, Object> jsonMap = (Map<String, Object>)JSON.toJSON(value);

                    Object getValue = jsonMap.get(name);
                    if(getValue != null){
                        valueExpand = getValue.toString();
                    }
                } catch (Exception e) {
                    log.error("GET VALUE ERROR:", e);
                }
            }else {
                valueExpand = value.toString();
            }
        }

        return valueExpand;
    }
}

注：該類需依賴 fastjson，也可根據個人需要修改該方法。

    2.3 ParamModelParameterProcessor.java

package com.moonciki.strongfeign.model.processor;

import com.moonciki.strongfeign.model.annotation.ParamModel;
import com.moonciki.strongfeign.model.expander.ModelExpander;
import feign.MethodMetadata;
import org.springframework.cloud.openfeign.AnnotatedParameterProcessor;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Collection;


public class ParamModelParameterProcessor implements AnnotatedParameterProcessor {

    private static final Class<ParamModel> ANNOTATION = ParamModel.class;

    public Class<? extends Annotation> getAnnotationType() {
        return ANNOTATION;
    }

    @Override
    public boolean processArgument(AnnotatedParameterContext context, Annotation annotation, Method method) {

        int parameterIndex = context.getParameterIndex();
        Class parameterType = method.getParameterTypes()[parameterIndex];
        MethodMetadata data = context.getMethodMetadata();

        Field[] fields = parameterType.getDeclaredFields();

        for(Field field: fields) {
            String name = field.getName();
            context.setParameterName(name);

            Collection query = context.setTemplateParameter(name, (Collection)data.template().queries().get(name));
            data.template().query(name, query);
        }
        data.indexToExpander().put(context.getParameterIndex(), new ModelExpander());

        return true;
    }
}

 

3. 使用注解配置 feign Contract 對象

    @Bean
    public Contract feignContract(){
        List<AnnotatedParameterProcessor> processors = new ArrayList<>();
        processors.add(new ParamModelParameterProcessor());
        processors.add(new PathVariableParameterProcessor());
        processors.add(new RequestHeaderParameterProcessor());
        processors.add(new RequestParamParameterProcessor());
        return new SpringMvcContract(processors);
    }

 

4. 使用方法示例

@Primary
@FeignClient(value = "/user", fallback = UserClientFallback.class)
public interface UserClient {

    /**
     * demo post
     * @return
     */
    @PostMapping("/demoPost")
    Result demoPost(@ParamModel UserAccount userAccount);

    /**
     * demo get
     * @return
     */
    @GetMapping("/demoGet")
    Result demoPost(@ParamModel UserAccount userAccount);


}

使用時，只需要在對象前加 @ParamModel  注解即可

需要同時傳遞對象及基本類型參數時， @ParamModel 可以與 @RequestParam("jobName")  同時使用在不同參數上。