SpringBoot中fastjson扩展: 自定义序列化和反序列化方法实战

❃博主首页：
「码到三十五」
，同名公众号 :「码到三十五」，wx号 : 「liwu0213」

☠博主专栏：

♝博主的话：
搬的每块砖，皆为峰峦之基；公众号搜索「码到三十五」关注这个爱发技术干货的coder，一起筑基

- - 1. 扩展点的用途
  - 2. 序列化扩展点
  - - 2.1. SerializeFilter
    - 2.2. SerializerFeature
    - 2.3. SerializeConfig
    - 2.4. 自定义序列化器（Serializer）
    - 2.5. 序列化过滤器（SerializeFilter）
    - 2.6. 自定义日期格式化
  - 2. 反序列化扩展点
  - - 2.1. ParseProcess
    - 2.2. ParserConfig
    - 2.3. 自定义反序列化器（Deserializer）
    - 2.4. 解析过程（ParseProcess）

在fastjson库中，为了提供灵活的序列化和反序列化机制，设计了一系列的扩展点。以下是在SpringBoot和SpringClould环境中对这些扩展点的详细介绍及其实战使用：

1. 扩展点的用途

fastjson提供的这些扩展点为用户提供了极大的灵活性，可以根据实际需求定制序列化和反序列化的行为。SpringBoot和SpringClould环境中,可以通过SerializeFilter和ParserProcess定制复杂的序列化和反序列化逻辑，通过SerializerFeature和ParserFeature控制序列化和反序列化的输出格式和特性，以及通过SerializeConfig和ParserConfig进行全局配置。这些扩展点不仅简化了用户代码，也提高了系统的可维护性和可扩展性。

2. 序列化扩展点

2.1. SerializeFilter

用途：用于在序列化过程中定制输出，如过滤某些字段、修改字段值等。
使用方法：
- 实现SerializeFilter接口或其子接口（如SimplePropertyPreFilter、PropertyFilter等）。
- 在序列化时，通过JSON.toJSONString等方法的重载版本传入自定义的SerializeFilter实例。

SerializeFilter filter = new SimplePropertyPreFilter() {
    @Override
    public boolean accept(int index, JavaBeanSerializer beanSer, Object object, Object fieldName, Object fieldVal) {
        // 定制序列化逻辑
        return true; // 返回true表示保留该字段，false表示过滤
    }
};
String jsonStr = JSON.toJSONString(obj, filter);

2.2. SerializerFeature

用途：控制序列化的输出格式和特性。
使用方法：
- 在序列化时，通过JSON.toJSONString等方法的重载版本传入SerializerFeature枚举值来控制序列化特性。

String jsonStr = JSON.toJSONString(obj, SerializerFeature.PrettyFormat); // 格式化输出

2.3. SerializeConfig

用途：全局配置序列化行为，如自定义序列化器、日期格式等。
使用方法：
- 创建SerializeConfig实例并配置相关选项。
- 在序列化时，通过JSON.toJSONString等方法的重载版本传入SerializeConfig实例。

SerializeConfig config = new SerializeConfig();
// 配置...
String jsonStr = JSON.toJSONString(obj, config);

2.4. 自定义序列化器（Serializer）

fastjson允许用户自定义序列化器，用于控制特定类型的序列化过程。用户需要实现SerializerFeature接口，并重写write方法。

public class CustomSerializer implements SerializerFeature {
    @Override
    public void write(JSONSerializer serializer, Object object, Object fieldName, Type fieldType, int features) throws IOException {
        // 自定义序列化逻辑
    }
}

在序列化过程中，可以通过SerializerFeature枚举值来指定使用自定义序列化器。

String jsonStr = JSON.toJSONString(obj, SerializerFeature.CustomSerializer, new CustomSerializer());

2.5. 序列化过滤器（SerializeFilter）

序列化过滤器用于在序列化过程中修改序列化结果。用户需要实现SerializeFilter接口，并重写process方法。

public class CustomSerializeFilter implements SerializeFilter {
    @Override
    public boolean process(Object source, String name, Object value, SerializeFilter.Context context) {
        // 自定义序列化过滤逻辑
    }
}

在序列化过程中，可以通过JSON.toJSONString方法的重载版本传入自定义序列化过滤器。

String jsonStr = JSON.toJSONString(obj, new CustomSerializeFilter());

2.6. 自定义日期格式化

fastjson允许用户自定义日期格式。可以通过SerializerFeature枚举值DisableCircularReferenceDetect和WriteMapNullValue来指定日期格式。

String jsonStr = JSON.toJSONString(obj, SerializerFeature.DisableCircularReferenceDetect, SerializerFeature.WriteMapNullValue);

此外，用户还可以通过DateFormat属性来指定全局的日期格式。

JSON.setDateFormat(new StdDateFormat());

2. 反序列化扩展点

2.1. ParseProcess

用途：在反序列化过程中执行额外逻辑，如修改反序列化结果。
使用方法：
- 实现ParseProcess接口并重写其中的方法。
- 在反序列化时，通过JSON.parseObject等方法的重载版本传入ParseProcess实例。

ParserFeature

用途：控制反序列化的行为和特性。
使用方法：
- 在反序列化时，通过JSON.parseObject等方法的重载版本传入ParserFeature枚举值来控制反序列化特性。

Object obj = JSON.parseObject(jsonStr, Object.class, Feature.AllowSingleQuotes); // 允许使用单引号

2.2. ParserConfig

用途：全局配置反序列化行为，如自定义反序列化器、自动类型转换等。
使用方法：
- 创建ParserConfig实例并配置相关选项。
- 在反序列化时，通过JSON.parseObject等方法的重载版本传入ParserConfig实例。

ParserConfig config = new ParserConfig();
// 配置...
Object obj = JSON.parseObject(jsonStr, Object.class, config);

示例代码

这里提供一个简单的SerializeFilter示例，用于过滤某些字段：

SerializeFilter filter = new SimplePropertyPreFilter() {
    @Override
    public boolean accept(int index, JavaBeanSerializer beanSer, Object object, Object fieldName, Object fieldVal) {
        if ("password".equals(fieldName)) {
            return false; // 过滤password字段
        }
        return true;
    }
};
String jsonStr = JSON.toJSONString(user, filter);

2.3. 自定义反序列化器（Deserializer）

类似地，fastjson也支持自定义反序列化器。用户需要实现ObjectDeserializer接口，并重写deserialze方法。

public class CustomDeserializer implements ObjectDeserializer {
    @Override
    public Object deserialize(DefaultJSONParser parser, Type type, Object fieldName) {
        // 自定义反序列化逻辑
    }
}

在反序列化过程中，可以通过ParserConfig类的putDeserializer方法来注册自定义反序列化器。

ParserConfig.getGlobalInstance().putDeserializer(SomeType.class, new CustomDeserializer());

2.4. 解析过程（ParseProcess）

解析过程在反序列化过程中使用，用户可以实现ParseProcess接口并重写process方法来自定义解析逻辑。

public class CustomParseProcess implements ParseProcess {
    @Override
    public Object process(ParseContext ctx) {
        // 自定义解析逻辑
    }
}

在反序列化过程中，可以通过JSON.parseObject方法的重载版本传入自定义解析过程。

Object obj = JSON.parseObject(jsonStr, SomeType.class, new CustomParseProcess());

总之,SpringBoot和SpringClould环境中,可以通过SerializeFilter和ParserProcess定制复杂的序列化和反序列化逻辑，通过SerializerFeature和ParserFeature控制序列化和反序列化的输出格式和特性，以及通过SerializeConfig和ParserConfig进行全局配置。这些扩展点不仅简化了用户代码，也提高了系统的可维护性和可扩展性。

关注公众号获取更多技术干货 !

目录