fastjson:实现对java.nio.ByteBuffer数据类型的支持

刺骨的言语ヽ痛彻心扉 2022-06-07 01:12 151阅读 0赞

一般情况下，我们都用`byte[]`作为保存二进制数据的数据类型，较少用ByteBuffer来表示字节数组。然而最近的工作中需要二进制数据(字节数组)即支持fastjson序列化也要能用thrift:swift序列化。  
我们知道fastjson可以对byte\[\]进行序列化，但fastjson默认是不支持`java.noi.ByteBuffer`数据类型序列化的。  
而thrift是跨语言的，所以它并没有byte\[\]这样的类型，对于二进制数据则对应的用binary类型，在java对应的是`java.nio.ByteBuffer`。这就尴尬了。

那么到底字节数组用什么表示？byte\[\] or ByteBuffer?

看来还是得用ByteBuffer,因为fastjson是个非常灵活的框架，允许使用者通过自定义对象实现对特定类型的序列化支持，只要fastjson能支持ByteBuffer的序列化，thrift也就没问题了。  
如果想要实现对ByteBuffer类型的支持，需要自己实现ByteBuffer的序列化器和反序列化器(ObjectSerializer, ObjectDeserializer),以下是代码实现。  
ByteBufferCodec.java

package gu.simplemq.json;
    
    import java.io.IOException;
    import java.lang.reflect.Type;
    import java.nio.ByteBuffer;
    
    import com.alibaba.fastjson.JSONException;
    import com.alibaba.fastjson.parser.DefaultJSONParser;
    import com.alibaba.fastjson.parser.JSONToken;
    import com.alibaba.fastjson.parser.deserializer.ObjectDeserializer;
    import com.alibaba.fastjson.serializer.JSONSerializer;
    import com.alibaba.fastjson.serializer.ObjectSerializer;
    import com.alibaba.fastjson.serializer.PrimitiveArraySerializer;
    import com.alibaba.fastjson.serializer.SerializerFeature;
    
    /**
     * {@link ByteBuffer} 序列化反序列化支持
     * @author guyadong
     *
     */
    public class ByteBufferCodec implements ObjectSerializer, ObjectDeserializer {
        
        public static ByteBufferCodec instance = new ByteBufferCodec();
        @SuppressWarnings("unchecked")
        @Override
        public <T> T deserialze(DefaultJSONParser parser, Type type, Object fieldName) {
            int token = parser.lexer.token();
            if (token == JSONToken.NULL) {
                parser.lexer.nextToken();
                return null;
            } else if(token == JSONToken.HEX  || token == JSONToken.LITERAL_STRING){
                byte[] bytes = parser.lexer.bytesValue();
                parser.lexer.nextToken();
                return (T) ByteBuffer.wrap(bytes);
            }
            throw new JSONException(String.format("invalid '%s' for ByteBuffer",JSONToken.name(token)));
        }
    
        @Override
        public int getFastMatchToken() {
            return JSONToken.LITERAL_STRING;
        }
        /**
         * 返回buffer中所有字节(position~limit),不改变buffer状态
         * @param buffer
         * @return
         */
        private static final byte[] getAllBytesInBuffer(ByteBuffer buffer){
            int pos = buffer.position();
            try{
                byte[] bytes = new byte[buffer.remaining()];
                buffer.get(bytes);
                return bytes;
            }finally{
                buffer.position(pos);
            }
        }
        /** 
         * 直接引用{@link PrimitiveArraySerializer}实现序列化
         */
        @Override
        public void write(JSONSerializer serializer, Object object, Object fieldName, Type fieldType, int features)
                throws IOException {
            if ( (object instanceof ByteBuffer) ) {
                PrimitiveArraySerializer.instance.write(serializer, getAllBytesInBuffer((ByteBuffer)object), fieldName, fieldType, features);
            }else{
                serializer.out.writeNull(SerializerFeature.WriteNullListAsEmpty);
            }
    
        }
    }

使用示例：

package gu.simplemq;
    
    import java.nio.ByteBuffer;
    
    import org.junit.Test;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.parser.ParserConfig;
    import com.alibaba.fastjson.serializer.SerializeConfig;
    
    import gu.simplemq.json.ByteBufferCodec;
    
    public class TestByteBuffer {
        
    
        @Test
        public void test() {
            ByteBuffer byteBuffer =ByteBuffer.wrap(new byte[]{
       22,33,3,2,3,1,5,-1});
            // 修改ParserConfig.global全局变量，将ByteBufferCodec加入反序列化器容器
            ParserConfig.global.putDeserializer(ByteBuffer.class, ByteBufferCodec.instance);
            // 修改SerializeConfig.globalInstance全局变量，将ByteBufferCodec加入序列化器容器
            // 对应的Class为 java.nio.HeapByteBuffer
            SerializeConfig.globalInstance.put(ByteBuffer.wrap(new byte[]{}).getClass(), ByteBufferCodec.instance);
            // 待序列化的 ByteBuffer 对象
            ByteBuffer byteBuffer =ByteBuffer.wrap(new byte[]{
       22,33,3,2,3,1,5,-1});
            // 序列化
            String serString = JSON.toJSONString(group.byteBuffer);
            System.out.println(serString);
            // 反序列化
            ByteBuffer deserialedByteBuffer = JSON.parseObject(serString,ByteBuffer.class);
            System.out.println(JSON.toJSONString(deserialedByteBuffer));
        }
    
    }