Jackson 2.x 系列【18】序列化器创建工厂 SerializerFactory

╰半橙微兮° 2024-04-23 12:53 67阅读 0赞

> **有道无术，术尚可求，有术无道，止于术。**
> 
> **本系列Jackson 版本 2.17.0** 
> 
> **源码地址：https://gitee.com/pearl-organization/study-jaskson-demo**

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

*   *  1. 概述
     *  2. SerializerFactory
     *  3. BasicSerializerFactory
     *  4. BeanSerializerFactory
     *  5. DeserializerFactory

### 1. 概述 ###

在上一篇文档中，我们学习了`SerializerProvider`负责提供特定类型的序列化器，那么序列化器是如何创建的呢，接下来一起学习`SerializerFactory`来回应这个问题。

### 2. SerializerFactory ###

`SerializerFactory`抽象类提供给`SerializerProvider`用于创建`JsonSerializer`实例，以执行序列化操作。定义了抽象类可以让序列化过程可以更加灵活和定制化，具体的实现细节和策略则留给继承这个抽象类的子类来实现。

`SerializerFactory`继承结构如下：

![在这里插入图片描述][cf55b66f7f4340c19c941bfeef252fd9.png]

`SerializerFactory`声明了三个`with`开头的抽象方法：

public abstract SerializerFactory withAdditionalSerializers(Serializers additional);
    
        public abstract SerializerFactory withAdditionalKeySerializers(Serializers additional);
    
        public abstract SerializerFactory withSerializerModifier(BeanSerializerModifier modifier);

`withAdditionalSerializers`和`withAdditionalKeySerializers`方法创建一个新的工厂实例，并在创建过程中添加额外的序列化器，在自定义序列化器的时候回用到，示例代码如下：

// 创建 ObjectMapper
            ObjectMapper objectMapper = new ObjectMapper();
            
            // 获取原有的 SerializerFactory
            SerializerFactory serializerFactory = objectMapper.getSerializerFactory();
            // 创建额外序列化器
            SimpleSerializers simpleSerializers=new SimpleSerializers();
            simpleSerializers.addSerializer(new SqlBlobSerializer());
            // SerializerFactory 添加自定义的序列化器
             SerializerFactory newSerializerFactory = serializerFactory.withAdditionalSerializers(simpleSerializers);
            // 重新设置给 ObjectMapper（因为SerializerFactory 是不可变对象， with 方法返回新的实例）
            objectMapper.setSerializerFactory(newSerializerFactory);

`withSerializerModifier`方法创建一个新的工厂实例，并在创建过程中添加额外的`BeanSerializerModifier`。

`Java Bean`和`JSON`的转换过程是比较复杂的，因为一般对象都包含了多种类型的属性， 之前有了解过`Java Bean`调用的是`BeanSerializer`执行的序列化，而`BeanSerializerModifier`则是这个序列化类的修改器，`Jackson`提供了扩展机制用于添加一些自定义的处理逻辑。

此外还声明了多个创建序列化器的方法：

/**
         * 给指定的类型创建序列化器，对于不可变的序列化器，这个方法可能会选择重用现有的序列化器实例，而不是创建一个新的。
         *
         * @param prov     SerializerProvider（提供者，仅用于解析由注解指定的序列化器，而不用于其他类型的序列化器）
         * @param baseType 声明的类型，用作类型信息序列化器的基础类型
         * @return
         * @throws JsonMappingException
         */
        public abstract JsonSerializer<Object> createSerializer(SerializerProvider prov,
                                                                JavaType baseType)
                throws JsonMappingException;
    
        public abstract TypeSerializer createTypeSerializer(SerializationConfig config,
                                                            JavaType baseType)
                throws JsonMappingException;
    
        // 创建负责处理 Map 的键的序列化器
        public JsonSerializer<Object> createKeySerializer(SerializerProvider prov,
                                                          JavaType type, JsonSerializer<Object> defaultImpl)
                throws JsonMappingException {
        
            return createKeySerializer(prov.getConfig(), type, defaultImpl);
        }
    
        @Deprecated // since 2.11
        public abstract JsonSerializer<Object> createKeySerializer(SerializationConfig config,
                                                                   JavaType type, JsonSerializer<Object> defaultImpl)
                throws JsonMappingException;

### 3. BasicSerializerFactory ###

`BasicSerializerFactory`也是一个抽象类，继承自`SerializerFactory`，用于为标准的`JDK`类提供序列化器， 例如`String`、`Integer`、`Date`这些类型，可以直接由该工厂提供合适的序列化器。

该类的静态代码块中，预先实例化了很多`JDK`类对应的序列化器：

static {
        
            HashMap<String, Class<? extends JsonSerializer<?>>> concLazy
                = new HashMap<String, Class<? extends JsonSerializer<?>>>();
            HashMap<String, JsonSerializer<?>> concrete
                = new HashMap<String, JsonSerializer<?>>();
    
    		
            /* String and string-like types (note: date types explicitly
             * not included -- can use either textual or numeric serialization)
             */
            concrete.put(String.class.getName(), new StringSerializer());
            final ToStringSerializer sls = ToStringSerializer.instance;
            concrete.put(StringBuffer.class.getName(), sls);
            concrete.put(StringBuilder.class.getName(), sls);
    
    
            // Primitives/wrappers for primitives (primitives needed for Beans)
            NumberSerializers.addAll(concrete);
            concrete.put(Boolean.TYPE.getName(), new BooleanSerializer(true));
            concrete.put(Boolean.class.getName(), new BooleanSerializer(false));
    
            // Other numbers, more complicated
    
    		// 省略........
            _concrete = concrete;
            _concreteLazy = concLazy;
        }

![在这里插入图片描述][b4a0e4af09314b59814069f8de380595.png]

实现了父类的`with`方法（其他抽象方法也基本实现了）：

![在这里插入图片描述][2c1f035993d642eb87d1aa026e1a85c1.png]  
提供了很多创建特定类型序列化器的方法：

![在这里插入图片描述][4051053f4b6d4811a0eeab9a9badb14c.png]  
提供了很多查询序列化器的方法：

![在这里插入图片描述][49b3f75e9c934a97a864526a6e4a52ce.png]

### 4. BeanSerializerFactory ###

`BeanSerializerFactory`继承自`BasicSerializerFactory`，是一个可以为任意`Java Bean`和标准`JDK`类提供序列化器的工厂类。

`BeanSerializerFactory`主要是重写了`createSerializer`方法：

![在这里插入图片描述][3d9bde28d9f049e897666bef2528a35b.png]

### 5. DeserializerFactory ###

`DeserializerFactory`抽象类提供给`DeserializationContext`用于创建`JsonDeserializer`实例，以反执行序列化操作。  
![在这里插入图片描述][f55a7c0055804cd6aae51b0b1831d88b.png]  
在`DeserializationContext`中可以看到`DeserializerFactory`类型的成员变量：  
![在这里插入图片描述][91ce9c83e79247a9806da19cfe9787c3.png]

其结构、属性、方法都和`SerializerFactory`差不多，所以这里也只是简单带过，比如多个`with`方法用于创建新的工厂实例：

public abstract DeserializerFactory withAdditionalDeserializers(Deserializers additional);
    
        public abstract DeserializerFactory withAdditionalKeyDeserializers(KeyDeserializers additional);
    
        public abstract DeserializerFactory withDeserializerModifier(BeanDeserializerModifier modifier);
    
        public abstract DeserializerFactory withAbstractTypeResolver(AbstractTypeResolver resolver);
    
        public abstract DeserializerFactory withValueInstantiators(ValueInstantiators instantiators);

其他方法如下：

![在这里插入图片描述][53d661f334544f92b466339f71dccf9b.png]  
创建`ObjectMapper`时，可以对`DeserializerFactory`进行扩展：

// 创建 ObjectMapper
            ObjectMapper objectMapper = new ObjectMapper();
            // 获取原有的 DeserializationContext
            DeserializationContext deserializationContext = objectMapper.getDeserializationContext();
            // 获取原有的 DeserializerFactory
            DeserializerFactory deserializerFactory = deserializationContext.getFactory();
            // 设置 BeanDeserializerModifier
            DeserializerFactory newDeserializerFactory=deserializerFactory.withDeserializerModifier(new BeanDeserializerModifier() {
        
            });
            // 重新设置给 ObjectMapper（因为DeserializerFactory 是不可变对象， with 方法返回新的实例）
            objectMapper.setDeserializerFactory(newDeserializerFactory);

[cf55b66f7f4340c19c941bfeef252fd9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/de6240e5fd764dc49f8af14ba7cb1892.png
[b4a0e4af09314b59814069f8de380595.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/ddb6e73cee574f419d0cdc4500ad053a.png
[2c1f035993d642eb87d1aa026e1a85c1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/e05b19c0254e49f4ba1990fd0ec38e1d.png
[4051053f4b6d4811a0eeab9a9badb14c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/fe96b3d101164184a37d46f0bd4d3553.png
[49b3f75e9c934a97a864526a6e4a52ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/b7f28ba0a6bc4e9a97b0e70c2585aa9f.png
[3d9bde28d9f049e897666bef2528a35b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/f439afa8220345368384748021adf0e1.png
[f55a7c0055804cd6aae51b0b1831d88b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/9c0bc218bc8a43428c2ecf9bb12cb2f2.png
[91ce9c83e79247a9806da19cfe9787c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/0538a2c2079f43b6bdfdc7a8a56507fb.png
[53d661f334544f92b466339f71dccf9b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/cb8b45de3e4342fa890f4abda556090f.png