文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringCloud Feign Jackson自定义配置的方法

2023-06-29 13:17

关注

今天小编给大家分享一下SpringCloud Feign Jackson自定义配置的方法的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。

Feign Jackson自定义配置

Spring Cloud Feign 默认支持Spring MVC的注解 使用相同的HttpMessageConverters类转换

官方文档说明:

Spring Cloud adds support for Spring MVC annotations and for using the same HttpMessageConverters used by default in Spring Web.

但是我们一般在返回给前端JSON格式的时候 都会把相应的 NULL值转为相应的"",这使得Spring Cloud Feign也使用相同的Jackson配置,例如我们项目的配置

    @Bean    public ObjectMapper jacksonObjectMapper() {        ObjectMapper objectMapper = new ObjectMapper();        // objectMapper.setSerializationInclusion(Include.NON_NULL);        objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {            @Override            public void serialize(Object value, JsonGenerator jg, SerializerProvider sp)                throws IOException, JsonProcessingException {                jg.writeString("");                sp.getDefaultNullKeySerializer();            }        });        objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);        return objectMapper;    }

出现的问题

在服务通过Feign进行请求的时候,传NULL值引用类型值时,会出现类型转换异常,由于HttpMessageConverters直接把NULL转为了""。

解决思路

自定义配置 Spring Cloud Feign Encoder与Decoder

官方文档说明:

Spring Cloud Netflix provides the following beans by default for feign (BeanType beanName: ClassName):Decoder feignDecoder: ResponseEntityDecoder (which wraps a SpringDecoder)Encoder feignEncoder: SpringEncoderLogger feignLogger: Slf4jLoggerContract feignContract: SpringMvcContractFeign.Builder feignBuilder: HystrixFeign.BuilderClient feignClient: if Ribbon is enabled it is a LoadBalancerFeignClient, otherwise the default feign client is used.

解决方法

统一配置Feign 的Encoder和Decoder的Jackson转换方式

import com.fasterxml.jackson.databind.DeserializationFeature;import com.fasterxml.jackson.databind.ObjectMapper;import org.springframework.beans.factory.ObjectFactory;import org.springframework.boot.autoconfigure.http.HttpMessageConverters;import org.springframework.cloud.openfeign.support.ResponseEntityDecoder;import org.springframework.cloud.openfeign.support.SpringDecoder;import org.springframework.cloud.openfeign.support.SpringEncoder;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.http.converter.HttpMessageConverter;import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;import feign.codec.Decoder;import feign.codec.Encoder;@Configurationpublic class CustomFeignConfig {    @Bean    public Decoder feignDecoder() {        HttpMessageConverter jacksonConverter = new MappingJackson2HttpMessageConverter(customObjectMapper());        ObjectFactory<HttpMessageConverters> objectFactory = () -> new HttpMessageConverters(jacksonConverter);        return new ResponseEntityDecoder(new SpringDecoder(objectFactory));    }    @Bean    public Encoder feignEncoder(){        HttpMessageConverter jacksonConverter = new MappingJackson2HttpMessageConverter(customObjectMapper());        ObjectFactory<HttpMessageConverters> objectFactory = () -> new HttpMessageConverters(jacksonConverter);        return new SpringEncoder(objectFactory);    }    public ObjectMapper customObjectMapper(){        ObjectMapper objectMapper = new ObjectMapper();        //Customize as much as you want        objectMapper.configure(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT, true);        return objectMapper;    }}

如果配置DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT 不起作用可以试试这种方式

public ObjectMapper customObjectMapper(){        ObjectMapper objectMapper = new ObjectMapper();        //Customize as much as you want        objectMapper.registerModule(new StringSanitizerModule());        return objectMapper;}public class StringSanitizerModule extends SimpleModule {    public StringSanitizerModule() {        addDeserializer(String.class, new StdScalarDeserializer<String>(String.class) {            @Override            public String deserialize(JsonParser jsonParser, DeserializationContext ctx) throws IOException {               return StringUtils.trimToNull(jsonParser.getValueAsString());            }        });    }}

Feign自定义配置应用

环境

nacos: 1.3.1

启动nacos

cd /usr/local/nacos/bin

sh startup.sh -m standalone

自定义Feign的配置

1)添加依赖

加入nacos-discovery发现服务的依赖、web、actuator用于监控检查,添加openfeign依赖才能使用Feign功能

SpringCloud Feign Jackson自定义配置的方法

2)修改配置文件

配置nacos注册中心地址,因为不提供服务,所以不需要再注册中心注册因此register-enabled=false

SpringCloud Feign Jackson自定义配置的方法

3)添加Feign支持

SpringCloud Feign Jackson自定义配置的方法

配置FeignConfiguration类文件

Spring Cloud Netflix默认的SpringMvcController将替换为feign.Contract.Default

用feign.Contract.Default将契约改为Feign原生的默认契约,就可以使用feign自带的注解了

SpringCloud Feign Jackson自定义配置的方法

4)自定义Feign接口

Feign接口文件需和启动类再同一包目录下,使用@FeignClient注解配置所需要调用服务,此处nacos-provider是需要在注册中心提供服务

因为上面配置了feign.Contract.Deafault,所以在接口中可以使用Feign原生的注解@RequestLine

SpringCloud Feign Jackson自定义配置的方法

添加HelloController类文件

此处使用接口MyFeignClient调用hello方法获取到nacos-provider客户端提供的服务

SpringCloud Feign Jackson自定义配置的方法

Feign中记录日志

1)添加配置项

在配置文件中添加记录日志的包,* 而每个FeignClient都需要单独配置,它只能响应debug级别的日志

SpringCloud Feign Jackson自定义配置的方法

2)设置日志等级

在FeignConfiguration类文件中配置日志等级

SpringCloud Feign Jackson自定义配置的方法

日志等级:

测试Feign自定义的配置

启动nacos-provider、feign-config客户端,进入nacos查询nacos-provider服务是否注册

SpringCloud Feign Jackson自定义配置的方法

进入浏览器端键入地址http://localhost:2334/hello,就能访问到nacos-provider提供的服务内容

SpringCloud Feign Jackson自定义配置的方法

查看日志

控制台会输出如下信息

SpringCloud Feign Jackson自定义配置的方法

[MyFeignClient#hello] <&mdash; HTTP/1.1 200 (405ms)
2020-08-13 16:16:23.021 DEBUG 3680 &mdash; [nio-2334-exec-1] com.kk.feign.MyFeignClient : [MyFeignClient#hello] content-length: 16
2020-08-13 16:16:23.021 DEBUG 3680 &mdash; [nio-2334-exec-1] com.kk.feign.MyFeignClient : [MyFeignClient#hello] content-type: text/plain;charset=UTF-8
2020-08-13 16:16:23.021 DEBUG 3680 &mdash; [nio-2334-exec-1] com.kk.feign.MyFeignClient : [MyFeignClient#hello] date: Thu, 13 Aug 2020 08:16:23 GMT
2020-08-13 16:16:23.021 DEBUG 3680 &mdash; [nio-2334-exec-1] com.kk.feign.MyFeignClient : [MyFeignClient#hello]
2020-08-13 16:16:23.021 DEBUG 3680 &mdash; [nio-2334-exec-1] com.kk.feign.MyFeignClient : [MyFeignClient#hello] Hello Gateway A!
2020-08-13 16:16:23.021 DEBUG 3680 &mdash; [nio-2334-exec-1] com.kk.feign.MyFeignClient : [MyFeignClient#hello] <&mdash; END HTTP (16-byte body)

以上就是“SpringCloud Feign Jackson自定义配置的方法”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注编程网行业资讯频道。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯