Spring feign cloud支持表单等数据类型

最新推荐文章于 2024-06-11 10:34:24 发布
最新推荐文章于 2024-06-11 10:34:24 发布
阅读量812 收藏
点赞数
文章标签： spring cloud feign client form-data
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010714901/article/details/118681700
版权

Spring Cloud FeignClient支持表单等数据

Spring Cloud Feign Client默认仅仅提供了application/json格式的支持，当然，Spring cloud feign client支持自定规则，如contract，encoder，decoder等等，通常我们会自定义个业务feignClient

  1. 自定义Feignclient
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@FeignClient(
    name = "${api.project}",
    configuration = ApiClientConfiguration.class
)
public @interface ApiClient {

    String path() default "";

}
  1. 自定义ApiClientConfiguration 配置
class ApiClientConfiguration extends BaseFeignClientConfiguration {

    @Bean
    public Contract feignContract(ObjectProvider<ConversionService> feignConversionService) {
        return super.feignContract(feignConversionService.getIfAvailable());
    }

    @Bean
    @Primary
    @Override
    public RequestInterceptor requestInterceptor() {
        return super.requestInterceptor();
    }

    @Bean
    @Override
    public ErrorDecoder errorDecoder() {
        return super.errorDecoder();
    }

}

详细参考：https://cloud.spring.io/spring-cloud-netflix/multi/multi_spring-cloud-feign.html

默认使用SpringEncoder，仅仅支持application/json，但是如果我们需要支持application/x-www-form-urlencoded或者multipart/form-data呢？

支持multipart/form-data类型

multipart/form-data 通常表现在文件上传等业务场景，为了支持这个类型数据，我们需要做如下工作

  1. 引入依赖：
        <dependency>
            <groupId>io.github.openfeign.form</groupId>
            <artifactId>feign-form</artifactId>
            <version>3.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign.form</groupId>
            <artifactId>feign-form-spring</artifactId>
            <version>3.8.0</version>
        </dependency>

注意： 上面的需要spring版本支持9.5及以上
2. 在ApiClientConfiguration 中增加代码

    @Bean
    @Primary
  //    @Scope("prototype")
    public Encoder multipartFormEncoder() {
        return new SpringFormEncoder();
    }

那么feignClient就支持multipart/form-data了，但是如果这么做的话，那么就会导致application/json格式的数据兼容不好

支持application/x-www-form-urlencoded类型

application/x-www-form-urlencoded类型通常用来在url加入格式如 http://xxx.com?key1=val2&key2=val2。为了支持该类型，在基于上面的操作外，我们需要做如下工作：

  1. 增加一个自定义encoder DfsEncoder （需要lombok支持）
/**
 * @author Artem Labazin
 */
@FieldDefaults(level = PRIVATE, makeFinal = true)
public class DfsEncoder implements Encoder {

    private static final String CONTENT_TYPE_HEADER;

    private static final Pattern CHARSET_PATTERN;

    static {
        CONTENT_TYPE_HEADER = "Content-Type";
        CHARSET_PATTERN = Pattern.compile("(?<=charset=)([\\w\\-]+)");
    }

    Encoder delegate;

    Map<ContentType, IContentProcessor> processors;

    /**
     * Constructor with the default Feign's encoder as a delegate.
     */
    public DfsEncoder() {
        this(new Default());
    }

    /**
     * Constructor with specified delegate encoder.
     *
     * @param delegate delegate encoder, if this encoder couldn't encode object.
     */
    public DfsEncoder(Encoder delegate) {
        this.delegate = delegate;

        val list = Arrays.asList(
                new DfsFormProcessor(), new UrlencodedProcessor()
        );

        processors = new HashMap<>(list.size(), 1.F);
        for (IContentProcessor processor : list) {
            processors.put(processor.getSupportedContentType(), processor);
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {
        String contentTypeValue = getContentTypeValue(template.headers());
        ContentType contentType = ContentType.of(contentTypeValue);
        if (!processors.containsKey(contentType)) {
            delegate.encode(object, bodyType, template);
            return;
        }
        final IContentProcessor processor = processors.get(contentType);
        final ProcessorType processorType = processor.processType();
        if (processorType == ProcessorType.ENCODER) {
            processor.encode(object, bodyType, template);
            return;
        }
        // 默认处理器处理
        Map<String, Object> data;
        if (MAP_STRING_WILDCARD.equals(bodyType)) {
            data = (Map<String, Object>) object;
        } else if (PojoUtil.isUserPojo(bodyType)) {
            data = PojoUtil.toMap(object);
        } else {
            delegate.encode(object, bodyType, template);
            return;
        }
        Charset charset = getCharset(contentTypeValue);
        processor.process(template, charset, data);
    }

    public final IContentProcessor getContentProcessor(ContentType type) {
        return processors.get(type);
    }

    @SuppressWarnings("PMD.AvoidBranchingStatementAsLastInLoop")
    private String getContentTypeValue(Map<String, Collection<String>> headers) {
        for (val entry : headers.entrySet()) {
            if (!entry.getKey().equalsIgnoreCase(CONTENT_TYPE_HEADER)) {
                continue;
            }
            for (val contentTypeValue : entry.getValue()) {
                if (contentTypeValue == null) {
                    continue;
                }
                return contentTypeValue;
            }
        }
        return null;
    }

    private Charset getCharset(String contentTypeValue) {
        val matcher = CHARSET_PATTERN.matcher(contentTypeValue);
        return matcher.find()
                ? Charset.forName(matcher.group(1))
                : StandardCharsets.UTF_8;
    }
}

在代码

 Map<ContentType, IContentProcessor> processors;
 // 很多代码
  processors = new HashMap<>(list.size(), 1.F);
        for (IContentProcessor processor : list) {
            processors.put(processor.getSupportedContentType(), processor);
        }

中，表示了我们需要定义支持的contentType对应的processor.
2. 定义application/x-www-form-urlencoded对应的processor，processor的接口定义如下：

public interface IContentProcessor extends Encoder {

    String CONTENT_TYPE_HEADER = "Content-Type";

    String CRLF = "\r\n";

    /**
     * Processes a request.
     *
     * @param template Feign's request template.
     * @param charset  request charset from 'Content-Type' header (UTF-8 by default).
     * @param data     reqeust data.
     * @throws EncodeException in case of any encode exception
     */
    default void process(RequestTemplate template, Charset charset, Map<String, Object> data) throws EncodeException {

    }

    /**
     * Returns supported {@link ContentType} of this processor.
     *
     * @return supported content type enum value.
     */
    ContentType getSupportedContentType();

    @Override
    default void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {

    }

    /**
     * 处理器类型
     *
     * @return 处理器类型，默认为processor
     */
    default ProcessorType processType() {
        return ProcessorType.PROCESSOR;
    }
}

application/x-www-form-urlencoded的processor UrlencodedProcessor 如下：

public class UrlencodedProcessor implements IContentProcessor {

    private static final char QUERY_DELIMITER = '&';

    private static final char EQUAL_SIGN = '=';

    @SneakyThrows
    private static String encode(Object string, Charset charset) {
        return URLEncoder.encode(string.toString(), charset.name());
    }

    @Override
    public void process(RequestTemplate template, Charset charset, Map<String, Object> data) throws EncodeException {
        StringBuilder bodyData = new StringBuilder();
        for (Entry<String, Object> entry : data.entrySet()) {
            if (entry == null || entry.getKey() == null) {
                continue;
            }
            if (bodyData.length() > 0) {
                bodyData.append(QUERY_DELIMITER);
            }
            bodyData.append(createKeyValuePair(entry, charset));
        }

        String contentTypeValue = new StringBuilder()
                .append(getSupportedContentType().getHeader())
                .append("; charset=").append(charset.name())
                .toString();

        byte[] bytes = bodyData.toString().getBytes(charset);
        // reset header
        template.header(CONTENT_TYPE_HEADER, Collections.emptyList());
        template.header(CONTENT_TYPE_HEADER, contentTypeValue);
        template.body(bytes, charset);
    }

    @Override
    public ContentType getSupportedContentType() {
        return ContentType.URLENCODED;
    }

    private String createKeyValuePair(Entry<String, Object> entry, Charset charset) {
        String encodedKey = encode(entry.getKey(), charset);
        Object value = entry.getValue();

        if (value == null) {
            return encodedKey;
        } else if (value.getClass().isArray()) {
            return createKeyValuePairFromArray(encodedKey, value, charset);
        } else if (value instanceof Collection) {
            return createKeyValuePairFromCollection(encodedKey, value, charset);
        }
        return new StringBuilder()
                .append(encodedKey)
                .append(EQUAL_SIGN)
                .append(encode(value, charset))
                .toString();
    }

    @SuppressWarnings("unchecked")
    private String createKeyValuePairFromCollection(String key, Object values, Charset charset) {
        val collection = (Collection) values;
        val array = collection.toArray(new Object[0]);
        return createKeyValuePairFromArray(key, array, charset);
    }

    private String createKeyValuePairFromArray(String key, Object values, Charset charset) {
        val result = new StringBuilder();
        val array = (Object[]) values;

        for (int index = 0; index < array.length; index++) {
            val value = array[index];
            if (value == null) {
                continue;
            }
            if (index > 0) {
                result.append(QUERY_DELIMITER);
            }
            result.append(key)
                    .append(EQUAL_SIGN)
                    .append(encode(value, charset));
        }
        return result.toString();
    }
}

在自定义的Encoder中DfsEncoder的构造函数中代码中注入了这个processor

 val list = Arrays.asList(
                new UrlencodedProcessor()
        );

当你需要的时候，在ApiClientConfiguration中的自定义Encoder生命为

    @Bean
    @Primary
//    @Scope("prototype")
    public Encoder multipartFormEncoder() {
        return new DfsEncoder();
    }

然而，这仅仅支持 application/x-www-form-urlencoded

三种方式都支持

支持application/json,application/x-www-form-urlencoded和multipart/form-data，通常在实际开发，这三种类型都是存在的，那么如何才能都支持呢？
结合上面的描述，我们需要在自定义encoder中根据类型分配processor，首先参考如下结构
在这里插入图片描述
最后自定义Encoder-DfsEncoder 代码如下：

import java.lang.reflect.Type;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Pattern;

import static lombok.AccessLevel.PRIVATE;

/**
 * @author Artem Labazin
 */
@FieldDefaults(level = PRIVATE, makeFinal = true)
public class DfsEncoder implements Encoder {

    private static final String CONTENT_TYPE_HEADER;

    private static final Pattern CHARSET_PATTERN;

    static {
        CONTENT_TYPE_HEADER = "Content-Type";
        CHARSET_PATTERN = Pattern.compile("(?<=charset=)([\\w\\-]+)");
    }

    Encoder delegate;

    Map<ContentType, IContentProcessor> processors;

    /**
     * Constructor with the default Feign's encoder as a delegate.
     */
    public DfsEncoder() {
        this(new Default());
    }

    /**
     * Constructor with specified delegate encoder.
     *
     * @param delegate delegate encoder, if this encoder couldn't encode object.
     */
    public DfsEncoder(Encoder delegate) {
        this.delegate = delegate;

        val list = Arrays.asList(
                new DfsFormProcessor(), new UrlencodedProcessor()
        );

        processors = new HashMap<>(list.size(), 1.F);
        for (IContentProcessor processor : list) {
            processors.put(processor.getSupportedContentType(), processor);
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {
        String contentTypeValue = getContentTypeValue(template.headers());
        ContentType contentType = ContentType.of(contentTypeValue);
        if (!processors.containsKey(contentType)) {
            delegate.encode(object, bodyType, template);
            return;
        }
        final IContentProcessor processor = processors.get(contentType);
        final ProcessorType processorType = processor.processType();
        if (processorType == ProcessorType.ENCODER) {
            processor.encode(object, bodyType, template);
            return;
        }
        // 默认处理器处理
        Map<String, Object> data;
        if (MAP_STRING_WILDCARD.equals(bodyType)) {
            data = (Map<String, Object>) object;
        } else if (PojoUtil.isUserPojo(bodyType)) {
            data = PojoUtil.toMap(object);
        } else {
            delegate.encode(object, bodyType, template);
            return;
        }
        Charset charset = getCharset(contentTypeValue);
        processor.process(template, charset, data);
    }

    public final IContentProcessor getContentProcessor(ContentType type) {
        return processors.get(type);
    }

    @SuppressWarnings("PMD.AvoidBranchingStatementAsLastInLoop")
    private String getContentTypeValue(Map<String, Collection<String>> headers) {
        for (val entry : headers.entrySet()) {
            if (!entry.getKey().equalsIgnoreCase(CONTENT_TYPE_HEADER)) {
                continue;
            }
            for (val contentTypeValue : entry.getValue()) {
                if (contentTypeValue == null) {
                    continue;
                }
                return contentTypeValue;
            }
        }
        return null;
    }

    private Charset getCharset(String contentTypeValue) {
        val matcher = CHARSET_PATTERN.matcher(contentTypeValue);
        return matcher.find()
                ? Charset.forName(matcher.group(1))
                : StandardCharsets.UTF_8;
    }
}

ApiClientConfiguration定义如下：

class ApiClientConfiguration extends BaseFeignClientConfiguration {
    @Autowired
    private ObjectFactory<HttpMessageConverters> messageConverters;

    @Bean
    public Contract feignContract(ObjectProvider<ConversionService> feignConversionService) {
        return super.feignContract(feignConversionService.getIfAvailable());
    }

    @Bean
    @Primary
    @Override
    public RequestInterceptor requestInterceptor() {
        return super.requestInterceptor();
    }

    @Bean
    @Override
    public ErrorDecoder errorDecoder() {
        return super.errorDecoder();
    }

    @Bean
    @Primary
//    @Scope("prototype")
    public Encoder multipartFormEncoder() {
        final SpringEncoder encoder = new SpringEncoder(messageConverters);
        return new DfsEncoder(encoder);
    }

}

支持类如下：
ProcessorType

public enum ProcessorType {
    /**
     * 常规的处理
     */
    PROCESSOR,
    /**
     * 编码器
     */
    ENCODER;
}
asa-x
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
openFeign调用接口时传递表单参数、Json参数、HttpServletRequest对象
weixin_52116015的博客
12-28 2033
openFeign调用接口时传递表单参数、Json参数、HttpServletRequest对象
使用Feign调用form-data的接口
黄黄黄黄黄的博客
02-10 1651
当不想用restTemplate处理form-data接口时，采取以下方式：
Fegin如何传参form-data文件
最新发布
Just_do_it_HZF的博客
06-11 496
【代码】Fegin如何传参form-data文件。
四步解决Feign调用form-data的接口
翼望空间@CSDN.net
06-15 8339
Feign默认不支持form-data的接口，如果需要支持其实也不难。只要四步。 第一步：创建一个转换器。 @Configuration public class FeignMultipartSupportConfig { @Bean @Primary @Scope("prototype") public Encoder multipartFormEncoder() { return new SpringFormEncoder(); } } 第...
Spring Boot 一个接口同时支持 form 表单、form-data、json 优雅写法
代码界的扛把子
10-27 347
else if (contentType.contains("multipart")) { // 文件流解析 return null;
【Feign】feignclient发送formdata请求
记录并分享一些日常工作和学习笔记
09-15 2767
小伙伴们在使用feign进行远程调用时，会遇到formdata类型的post请求，希望以下内容可以帮助到大家。请确保请求方法正确，并使用注解来接收FormData请求的参数。
记feign调用第三方接口时header是multipart/form-data
wangfenglei123456的博客
11-15 547
请求第三方接口，用feign请求
让Feign支持post方法的表单提交
风流倜傥唐伯虎的博客
08-23 2794
让Feign支持post方法的表单提交
multipart/form-data上传文件报错AttributeError:：object has no attribute ‘encode‘
totorobig的博客
08-30 1312
AttributeError:：object has no attribute ‘encode’
关于FeignClient的使用大全——使用篇
wangmj518的专栏
03-03 3480
完整代码参照： ocean-sea(https://github.com/biticcf/ocean-sea-platform.git) 一个最简单的使用FeignClient的例子如下： 1，添加maven依赖 <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifac
FeignClient的参数传递给服务提供方的方式（简单数据类型、对象）
梦想起飞的地方.........
11-11 2985
xx
使用feign对x-www-form-urlencode类型的encode和decode问题
CH的博客
01-05 4730
关键词：urlencode、feign-core、RequestTemplate、x-www-form-urlencode、;\:@&=+$,# 记录一下开发过程中遇到的一个问题。 问题场景：使用feign调用另一服务b时，在feign-client包里跑单测能调用成功，在另一项目a引入该feign-client时使用同样的参数调用失败。content-type为application...
Spring Cloud Feign java实现postman中form-data传参 文件上传下载
热门推荐
赵英超的博客
03-12 1万+
postman中几种传参方式区别： 1.form-data form-data主要是以键值对的形式来上传参数，同时参数之间以&分隔符分开，同时也可以上传文件，文件上传要指定文件类型,具体可以看下面的图。 2.x-www-form-urlencode 这种参数的传递与form-data最大的区别是，x-www-form-urlencode只能是以键值对的形式传参，不能上传文件。 ...
@FeignClient以post请求form-data包的形式远程调用第三方接口
b1142021407的博客
12-29 2604
@FeignClient以post请求form-data包的形式远程调用第三方接口
open feign支持调用form-data的接口
wangwenzhe的博客
05-09 326
【代码】open feign支持调用form-data的接口。
微服务之间通过feign调用接口上传文件
lhz121的博客
05-12 1614
具体需求: 我们的项目是基于springboot框架的springcloud微服务搭建的，后端服务技术层面整体上分为business服务和core服务，business服务用于作为应用层，直接连接客户端，通常用于聚合数据，core服务用来客户端具体操作不同需求来控制数据库,文件上传是通过客户端上传接口,通过business服务,由服务端调用feign接口,也是第一次做这种文件中转,遇到各种问题,下面是我自己的解决方案,不喜勿喷,代码小白一枚; 一,core服务层接口@requestmapping 属性加
springboot~feign模拟multipart/form-data
m0_68064743的博客
04-26 2678
openfeign介绍 在微服务设计里，服务之间的调用是很正常的，通常我们使用httpClient来实现对远程资源的调用，而这种方法需要知识服务的地址，业务接口地址等，而且需要等他开发完成后你才可以去调用它，这对于集成开发来说，不是什么好事 ，产生了A业务与B业务的强依赖性，那么我们如何进行解耦呢，答案就是openfeign框架，它与是springcloudy里的一部分。 　　　　springcloud的服务消费者指的就是服务间的调用，实现的方式有两种：一种就是上一章讲的restTemplate+ribbo
使用@FeignClient的json转form-data数据转换调用
AaronCao
09-20 5832
首先说明一下情况，Server服务是原来就有的，Server_1之前调用Server的时候使用是form-data形式，这就导致了Server支持的就是form-data格式，导致了Server_2使用json格式调用的时候就调不通，拿不到数据。此时需要做数据的转换。 1.添加一个转换类 public class FeignSimpleEncoderConfig { @Bean ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值