Protostuff 序列化/反序列化集合等對象
在使用 Protostuff 的時候會遇到一些無法直接序列化/反序列化的對象,比如Map、List等。
在序列化這些無法直接序列化/反序列化的對象時,可以引入一個包裝類來吧這些數據包裝一下,然後對這個包裝類進行序列化/反序列化。
具體實現如下:
1. 定義一個包裝類
SerializeDeserializeWrapper.java
package com.butioy.commons.beans;
/**
* <p>
* 序列化/反序列化對象包裝類
* 專爲基於 Protostuff 進行序列化/反序列化而定義。
* Protostuff 是基於POJO進行序列化和反序列化操作。
* 如果需要進行序列化/反序列化的對象不知道其類型,不能進行序列化/反序列化;
* 比如Map、List、String、Enum等是不能進行正確的序列化/反序列化。
* 因此需要映入一個包裝類,把這些需要序列化/反序列化的對象放到這個包裝類中。
* 這樣每次 Protostuff 都是對這個類進行序列化/反序列化,不會出現不能/不正常的操作出現
* </p>
*
* @author butioy
*/
public class SerializeDeserializeWrapper<T> {
private T data;
public static <T> SerializeDeserializeWrapper<T> builder(T data) {
SerializeDeserializeWrapper<T> wrapper = new SerializeDeserializeWrapper<>();
wrapper.setData(data);
return wrapper;
}
getter and setter...
}
2. 編寫Protostuff工具類
ProtostuffUtils.java
package com.butioy.commons.utils;
import com.butioy.commons.beans.SerializeDeserializeWrapper;
import com.google.common.collect.Maps;
import io.protostuff.LinkedBuffer;
import io.protostuff.ProtostuffIOUtil;
import io.protostuff.Schema;
import io.protostuff.runtime.RuntimeSchema;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.Stack;
import java.util.TreeMap;
import java.util.Vector;
import java.util.concurrent.CopyOnWriteArrayList;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* <p>
* Protostuff 序列化/反序列化工具類
* </p>
*
* @author butioy
*/
public class ProtostuffUtils {
private static Logger logger = LoggerFactory.getLogger(ProtostuffUtils.class);
/**
* 需要使用包裝類進行序列化/反序列化的class集合
*/
private static final Set<Class<?>> WRAPPER_SET = new HashSet<>();
/**
* 序列化/反序列化包裝類 Class 對象
*/
private static final Class<SerializeDeserializeWrapper> WRAPPER_CLASS = SerializeDeserializeWrapper.class;
/**
* 序列化/反序列化包裝類 Schema 對象
*/
private static final Schema<SerializeDeserializeWrapper> WRAPPER_SCHEMA = RuntimeSchema.createFrom(WRAPPER_CLASS);
/**
* 緩存對象及對象schema信息集合
*/
private static final Map<Class<?>, Schema<?>> CACHE_SCHEMA = Maps.newConcurrentMap();
/**
* 預定義一些Protostuff無法直接序列化/反序列化的對象
*/
static {
WRAPPER_SET.add(List.class);
WRAPPER_SET.add(ArrayList.class);
WRAPPER_SET.add(CopyOnWriteArrayList.class);
WRAPPER_SET.add(LinkedList.class);
WRAPPER_SET.add(Stack.class);
WRAPPER_SET.add(Vector.class);
WRAPPER_SET.add(Map.class);
WRAPPER_SET.add(HashMap.class);
WRAPPER_SET.add(TreeMap.class);
WRAPPER_SET.add(Hashtable.class);
WRAPPER_SET.add(SortedMap.class);
WRAPPER_SET.add(Map.class);
WRAPPER_SET.add(Object.class);
}
/**
* 註冊需要使用包裝類進行序列化/反序列化的 Class 對象
*
* @param clazz 需要包裝的類型 Class 對象
*/
public static void registerWrapperClass(Class clazz) {
WRAPPER_SET.add(clazz);
}
/**
* 獲取序列化對象類型的schema
*
* @param cls 序列化對象的class
* @param <T> 序列化對象的類型
* @return 序列化對象類型的schema
*/
@SuppressWarnings({"unchecked", "rawtypes"})
private static <T> Schema<T> getSchema(Class<T> cls) {
Schema<T> schema = (Schema<T>) CACHE_SCHEMA.get(cls);
if (schema == null) {
schema = RuntimeSchema.createFrom(cls);
CACHE_SCHEMA.put(cls, schema);
}
return schema;
}
/**
* 序列化對象
*
* @param obj 需要序列化的對象
* @param <T> 序列化對象的類型
* @return 序列化後的二進制數組
*/
@SuppressWarnings("unchecked")
public static <T> byte[] serialize(T obj) {
Class<T> clazz = (Class<T>) obj.getClass();
LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE);
try {
Object serializeObject = obj;
Schema schema = WRAPPER_SCHEMA;
if (!WRAPPER_SET.contains(clazz)) {
schema = getSchema(clazz);
} else {
serializeObject = SerializeDeserializeWrapper.builder(obj);
}
return ProtostuffIOUtil.toByteArray(serializeObject, schema, buffer);
} catch (Exception e) {
logger.error("序列化對象異常 [" + obj + "]", e);
throw new IllegalStateException(e.getMessage(), e);
} finally {
buffer.clear();
}
}
/**
* 反序列化對象
*
* @param data 需要反序列化的二進制數組
* @param clazz 反序列化後的對象class
* @param <T> 反序列化後的對象類型
* @return 反序列化後的對象集合
*/
public static <T> T deserialize(byte[] data, Class<T> clazz) {
try {
if (!WRAPPER_SET.contains(clazz)) {
T message = clazz.newInstance();
Schema<T> schema = getSchema(clazz);
ProtostuffIOUtil.mergeFrom(data, message, schema);
return message;
} else {
SerializeDeserializeWrapper<T> wrapper = new SerializeDeserializeWrapper<>();
ProtostuffIOUtil.mergeFrom(data, wrapper, WRAPPER_SCHEMA);
return wrapper.getData();
}
} catch (Exception e) {
logger.error("反序列化對象異常 [" + clazz.getName() + "]", e);
throw new IllegalStateException(e.getMessage(), e);
}
}
}
3. 編寫測試類
import com.butioy.commons.beans.SerializeDeserializeWrapper;
import java.util.HashMap;
import java.util.Map;
/**
* <p>
* 測試類
* </p>
*
* @author butioy
*/
public class Main {
public static void main(String[] args) {
Map<String, Object> map = new HashMap<>();
map.put("key1", "butioy");
map.put("key2", "protostuff");
map.put("key3", "serialize");
SerializeDeserializeWrapper wrapper = SerializeDeserializeWrapper.builder(map);
byte[] serializeBytes = ProtostuffUtils.serialize(wrapper);
System.out.println("序列化map集合二進制數組長度 length=" + serializeBytes.length);
SerializeDeserializeWrapper deserializeWrapper = ProtostuffUtils.deserialize(serializeBytes, SerializeDeserializeWrapper.class);
System.out.println("反序列化map對象:" + deserializeWrapper.getData());
}
}
輸出結果
好了,到此就想使用正常POJO一樣使用集合進行序列化/反序列化了。本例只是更具個人的想法簡單的實現,未經嚴格測試。如有錯誤,還請指正。