FastJsonHttpMessageConverter 类的作用与使用详解

悠悠 2024-03-24 13:58 20阅读 0赞

## FastJson高效使用系列文章目录 ##

[第一章 FastJson使用详解][FastJson]  
[第二章 FastJsonHttpMessageConverter 类的作用与使用详解][FastJsonHttpMessageConverter]  
[第三章 Jackson 使用详解][Jackson]

--------------------

#### 文章目录 ####

*  FastJson高效使用系列文章目录
 *  前言
 *  一、fastJson是什么？
 *  二、使用步骤
 *   *  1.创建FastJsonConfig对象并进行自定义配置
     *  2.创建FastJsonHttpMessageConverter对象并设置FastJsonConfig
     *  3.将FastJsonHttpMessageConverter添加到HttpMessageConverters中
 *  三、FastConfig配置详解
 *   *  1 序列化特性（SerializerFeature）
     *  2 日期格式（DateFormat）
     *  过滤器（SerializeFilter）
     *  4 自定义序列化器和反序列化器
 *  总结

--------------------

## 前言 ##

--------------------

## 一、fastJson是什么？ ##

FastJson是一种高性能、功能强大的JSON库，由阿里巴巴开发。在Spring框架中，我们可以使用FastJsonHttpMessageConverter来处理HTTP请求和响应中的JSON数据。在使用FastJsonHttpMessageConverter时，我们可以通过以下方式进行自定义配置。

## 二、使用步骤 ##

### 1.创建FastJsonConfig对象并进行自定义配置 ###

代码如下：

@Configuration
    public class MyFastJsonConfig {
        
    
        @Bean
        public FastJsonConfig fastJsonConfig() {
        
            FastJsonConfig fastJsonConfig = new FastJsonConfig();
            fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat, SerializerFeature.WriteMapNullValue);
            return fastJsonConfig;
        }
    
    }

上面的代码中，我们通过@Bean注解创建一个FastJsonConfig对象，并设置了两个序列化特性：SerializerFeature.PrettyFormat用于美化输出格式，SerializerFeature.WriteMapNullValue用于输出null字段。

### 2.创建FastJsonHttpMessageConverter对象并设置FastJsonConfig ###

代码如下：

@Configuration
    public class MyFastJsonHttpMessageConverter {
        
    
        @Autowired
        private FastJsonConfig fastJsonConfig;
    
        @Bean
        public FastJsonHttpMessageConverter fastJsonHttpMessageConverter() {
        
            FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
            fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
            return fastJsonHttpMessageConverter;
        }
    
    }

上面的代码中，我们使用@Autowired注解将FastJsonConfig对象注入到MyFastJsonHttpMessageConverter中，并在FastJsonHttpMessageConverter中设置了FastJsonConfig。

--------------------

### 3.将FastJsonHttpMessageConverter添加到HttpMessageConverters中 ###

@Configuration
    public class MyWebMvcConfig implements WebMvcConfigurer {
        
    
        @Autowired
        private FastJsonHttpMessageConverter fastJsonHttpMessageConverter;
    
        @Override
        public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        
            converters.add(fastJsonHttpMessageConverter);
        }
    
    }

上面的代码中，我们实现了WebMvcConfigurer接口，并在configureMessageConverters方法中将FastJsonHttpMessageConverter添加到HttpMessageConverters中。

## 三、FastConfig配置详解 ##

FastJsonConfig是用于配置FastJson序列化和反序列化的配置类。它可以设置各种序列化和反序列化的参数，包括日期格式、序列化特性、过滤器、自定义序列化器和反序列化器等。  
下面是FastJsonConfig的一些常用配置：

### 1 序列化特性（SerializerFeature） ###

序列化特性用于控制JSON输出格式，例如禁用循环引用、输出空置字段、美化输出格式等。SerializerFeature是一个枚举类型，它包括很多选项，例如：

*  PrettyFormat：美化输出格式，使其更易读。
 *  WriteMapNullValue：输出空置字段，默认为false。
 *  DisableCircularReferenceDetect：禁用循环引用，默认为false。
 *  WriteDateUseDateFormat：按指定格式输出日期，例如yyyy-MM-dd HH:mm:ss。

可以使用以下代码进行配置：

FastJsonConfig fastJsonConfig = new FastJsonConfig();
    fastJsonConfig.setSerializerFeatures(
        SerializerFeature.PrettyFormat, 
        SerializerFeature.WriteMapNullValue,
        SerializerFeature.DisableCircularReferenceDetect,
        SerializerFeature.WriteDateUseDateFormat
    );

### 2 日期格式（DateFormat） ###

FastJson默认使用ISO-8601格式输出日期，例如"2019-12-01T12:00:00.000Z"。我们可以通过设置DateFormat来指定输出格式，例如"yyyy-MM-dd HH:mm:ss"。可以使用以下代码进行配置：

FastJsonConfig fastJsonConfig = new FastJsonConfig();
    fastJsonConfig.setDateFormat("yyyy-MM-dd HH:mm:ss");

### 过滤器（SerializeFilter） ###

过滤器可以用于在序列化时进行字段过滤、属性重命名等操作。FastJson提供了多种过滤器，例如PropertyPreFilter、NameFilter、ValueFilter、BeforeFilter、AfterFilter等。可以使用以下代码进行配置：

FastJsonConfig fastJsonConfig = new FastJsonConfig();
    PropertyPreFilter propertyPreFilter = new SimplePropertyPreFilter(User.class, "id", "name", "age");
    fastJsonConfig.setSerializeFilters(propertyPreFilter);

上面的代码中，我们创建了一个PropertyPreFilter对象，用于过滤User类中的id、name、age字段。然后将该过滤器设置到FastJsonConfig中。

### 4 自定义序列化器和反序列化器 ###

如果需要对某些类型的数据进行特殊处理，可以通过自定义序列化器和反序列化器来实现。我们可以继承Serializer和Deserializer接口，实现serialize和deserialize方法，然后将自定义的序列化器和反序列化器注册到FastJsonConfig中。例如：

public class DateSerializer extends JsonSerializer<Date> {
        
    
        @Override
        public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            String str = sdf.format(date);
            jsonGenerator.writeString(str);
        }

## 总结 ##

以上就是本篇文章内容，本文仅仅简单介绍了FastJsonHttpMessageConverter的使用，通过以上步骤，我们就可以自定义FastJsonHttpMessageConverter的配置，例如设置序列化特性、日期格式、禁用循环引用等。。

[FastJson]: https://blog.csdn.net/qq_28754027/article/details/129930844?spm=1001.2014.3001.5502
[FastJsonHttpMessageConverter]: https://blog.csdn.net/qq_28754027/article/details/129928792?spm=1001.2014.3001.5502
[Jackson]: https://blog.csdn.net/qq_28754027/article/details/129954756?spm=1001.2014.3001.5502