springboot引入fastjson解析枚举类型

最新推荐文章于 2024-04-12 11:27:04 发布

Henry_ss

最新推荐文章于 2024-04-12 11:27:04 发布

阅读量7.8k

点赞数

文章标签： java spring spring boot

本文链接：https://blog.youkuaiyun.com/Henry_ss/article/details/121119633

版权

本文介绍了如何在SpringBoot项目中使用Fastjson替代Jackson，并详细讲解了如何处理枚举类型的序列化和反序列化问题。文章提供了一种自定义枚举解析方式的方法，确保Fastjson能正确解析枚举的int值。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot引入fastjson解析枚举类型

前言

fastjson是目前开源平台上最快的json解析库之一，且由国内大厂alibaba开源。国内大部分项目和很多程序员喜欢使用fastjson作为json解析库。

版本

这边列出有涉及到的库的版本

springboot.version = 2.5.4

fastjson.version = 1.2.78

hutool.version = 5.7.13

正文

fastjson替换jackson

springboot自带的json解析库为jackson，如果要引入fastjson替代原始的jackson一般做法是构建一个配置类实现WebMvcConfigurer接口，并重写void configureMessageConverters(List<HttpMessageConverter<?>> converters)方法。基本逻辑是定义一个 FastJsonHttpMessageConverter 对象，并插入到springmvc的Converters列表中的首位。

代码如下

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        //自定义配置...
        List<MediaType> mediaTypes = new ArrayList<>();
        mediaTypes.add(MediaType.APPLICATION_JSON);
        converter.setSupportedMediaTypes(mediaTypes);
        //获取fastjson全局序列化、反序列化配置
        SerializeConfig serializeConfig = SerializeConfig.getGlobalInstance();
        ParserConfig parserConfig = ParserConfig.getGlobalInstance();
        //以下几种类型解析时解析为string，避免精度丢失 
        serializeConfig.put(BigInteger.class, ToStringSerializer.instance);
        serializeConfig.put(Long.class, ToStringSerializer.instance);
        serializeConfig.put(BigDecimal.class, ToStringSerializer.instance);
        //配置生效
        FastJsonConfig config = converter.getFastJsonConfig();
        config.setSerializeConfig(serializeConfig);
        config.setParserConfig(parserConfig);
        /*将fastjson设置为序号为0的json解析器，同时要在pom中的spring-boot-starter-web依赖添加exclusion
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-json</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        */
        converters.add(0, converter);
    }
}

fastjson解析枚举类型

一个示例的枚举类 Code.class

@Getter
@AllArgsConstructor
public enum Code implements Enumerator{
    /**
     * 请求成功
     */
    SUCCESS(200,"请求成功"),
    /**
     * 请求失败
     */
    FAIL(300,"请求失败"),
    /**
     * 系统错误
     */
    SYSTEM_ERROR(500,"系统错误");

    private final Integer code;
    private final String description;
}

Code枚举表示了Restful Api的返回状态码，使用枚举封装状态值更利于项目的开发和维护，但是请求方需要的是枚举封装的真实的int值。所以反序列化时我们需要把枚举反序列为其内部封装的int值。

然而fastjson对枚举的默认解析是解析为枚举名，即 Code.SUCCESS 会被解析为 SUCCESS 而不是 200。

同样的反序列化时，fastjson也是通过枚举名或者是枚举的ordinal() ,即枚举对象的序号来反序列化。当接收到的json为 200 时，fastjson无法将200反序列化为 Code.SUCCESS。

因此需要我们自定义fastjson对我们自定义的枚举类型的序列化和反序列化方式。因此我们要改写之前的代码。

代码如下

这边我将自定义的枚举类型全部定义在 com.shop.common.base.enumerate 并且全部继承Enumerator接口，并重写getCode方法。

这边扫描包用到了hutool库的方法，hutool的版本可见上文，使用需要在pom.xml中加入以下内容。当然也可以改用别的库或自定义扫描方法。

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>${hutool.version}</version>
</dependency>

WebConfig.java

@Slf4j
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        //自定义配置...
        List<MediaType> mediaTypes = getMediaType();
        converter.setSupportedMediaTypes(mediaTypes);
        SerializeConfig serializeConfig = SerializeConfig.getGlobalInstance();
        ParserConfig parserConfig = ParserConfig.getGlobalInstance();
        //以下几种类型解析时解析为string，避免精度丢失
        serializeConfig.put(BigInteger.class, ToStringSerializer.instance);
        serializeConfig.put(Long.class, ToStringSerializer.instance);
        serializeConfig.put(BigDecimal.class, ToStringSerializer.instance);
        //获取枚举包下所有枚举类
        Set<Class<?>> enumTypes = getEnumTypes();
        //为枚举类配置序列化和反序列化方法,只要实现Enumerator接口的枚举类都可以被fastjson正常序列化和反序列化
        enumTypes.stream().forEach(aClass -> {
            setEnumParser(aClass, parserConfig);
            setEnumSerializer(aClass, serializeConfig);
        });
        //配置生效
        FastJsonConfig config = converter.getFastJsonConfig();
        config.setSerializeConfig(serializeConfig);
        config.setParserConfig(parserConfig);
        /*将fastjson设置为序号为0的json解析器，同时要在pom中的spring-boot-starter-web依赖添加exclusion
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-json</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        */
        converters.add(0, converter);
    }

    /**
     * @return 获取 com.shop.common.base.enumerate 包下的所有枚举类
     */
    private Set<Class<?>> getEnumTypes() {
        //将扫描路径替换为自己枚举类所在的包名
        Set<Class<?>> classes = ClassScanner.scanPackage("com.shop.common.base.enumerate");
        log.info("加载枚举包下所以枚举类成功，获取结果 = {}", JSON.toJSONString(classes));
        return classes;
    }

    /**
     * 为枚举配置序列化方法
     * @param aClass 枚举class
     * @param serializeConfig 序列化配置
     */
    private void setEnumSerializer(Class aClass, SerializeConfig serializeConfig) {
        serializeConfig.put(aClass, (JSONSerializer serializer, Object object, Object fileName, Type type, int features) -> {
            SerializeWriter out = serializer.out;
            if (object instanceof Enumerator) {
                Enumerator enumerator = (Enumerator) object;
                out.write(enumerator.getCode().toString());
            } else {
                out.writeEnum((Enum<?>) object);
            }
        });
    }

    /**
     * 为枚举配置反序列化方法
     * @param aClass 枚举class
     * @param parserConfig 反序列化方法
     */
    private void setEnumParser(Class aClass, ParserConfig parserConfig) {
        parserConfig.putDeserializer(aClass, new ObjectDeserializer() {
            @Override
            public <T> T deserialze(DefaultJSONParser parser, Type type, Object o) {
                final JSONLexer lexer = parser.lexer;
                final int token = lexer.token();
                Class cls = (Class) type;
                Object[] enumConstants = cls.getEnumConstants();
                if (Enumerator.class.isAssignableFrom(cls)) {
                    for (Object enumConstant : enumConstants) {
                        Enumerator enumerator = (Enumerator) enumConstant;
                        Object enumCodeObject = enumerator.getCode();
                        int enumCode = Integer.parseInt(enumCodeObject.toString());
                        if (lexer.intValue() == enumCode) {
                            return (T) enumerator;
                        }
                    }
                } else {
                    //没实现EnumValue接口的 默认的按名字或者按ordinal
                    if (token == JSONToken.LITERAL_INT) {
                        int intValue = lexer.intValue();
                        lexer.nextToken(JSONToken.COMMA);
                        if (intValue < 0 || intValue > enumConstants.length) {
                            throw new JSONException(String.format("parse enum %s error, value : %s", cls.getName(), intValue));
                        }
                        return (T) enumConstants[intValue];
                    } else if (token == JSONToken.LITERAL_STRING) {
                        return (T) Enum.valueOf(cls, lexer.stringVal());
                    }
                }
                return null;
            }

            @Override
            public int getFastMatchToken() {
                return JSONToken.LITERAL_INT;
            }
        });
    }

    private List<MediaType> getMediaType(){
        List<MediaType> mediaTypes = new ArrayList<>();
        mediaTypes.add(MediaType.APPLICATION_JSON);
        mediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);
        return mediaTypes;
    }
}

Enumerator.java

public interface Enumerator {
    /**
     * Code integer.
     *
     * @return the integer
     */
    Integer getCode();
}

后续如果还有定义新的枚举类型只需要添加在同一个包下，然后继承Enumerator接口即可。

springboot引入fastjson解析枚举类型

springboot引入fastjson解析枚举类型

目录

前言

版本

正文

fastjson替换jackson

代码如下

fastjson解析枚举类型

代码如下