基于protostuff的序列化工具类开发

[toc]


基于protostuff的序列化工具类开发

前言

前面在介绍protostuff的基本使用时(可以参考文章protostuff基本使用),都是针对某个类写的序列化和反序列化方法,显然这样不具有通用性,例如在进行远程过程调用时,传输的对象并不唯一,这时就需要开发具有通用性的序列化工具类,即不管序列化的对象是什么类型,都可以使用该工具类进行序列化。下面就来开发这样的工具类。

基于这个需要,下面会开发两个序列化工具类,一个是不具有缓存功能的SerializationUtil,一个是具有缓存功能的增强版本SerializationUtil2

需要注意的是,protostuff序列化工具类的开发需要大量使用到Java泛型的知识,因此在阅读这些源代码时应该需要具有一定的泛型知识储备,否则代码阅读起来会比较难懂,尽管我已经全部加了注释。

protostuff序列化工具类SerializationUtil

下面直接给出源代码:

package cn.xpleaf.protostuff.netty.utils;

import com.dyuproject.protostuff.LinkedBuffer;
import com.dyuproject.protostuff.ProtostuffIOUtil;
import com.dyuproject.protostuff.runtime.RuntimeSchema;

/**
 * 序列化工具类,基于Protostuff实现(其基于Google Protobuf实现)
 *
 * @author yeyonghao
 *
 */
public class SerializationUtil {

    /**
     * 序列化方法,将对象序列化为字节数组(对象 ---> 字节数组)
     *
     * @param obj
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <T> byte[] serialize(T obj) {
        // 获取泛型对象的类型
        Class<T> clazz = (Class<T>) obj.getClass();
        // 创建泛型对象的schema对象
        RuntimeSchema<T> schema = RuntimeSchema.createFrom(clazz);
        // 创建LinkedBuffer对象
        LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE);
        // 序列化
        byte[] array = ProtostuffIOUtil.toByteArray(obj, schema, buffer);
        // 返回序列化对象
        return array;
    }

    /**
     * 反序列化方法,将字节数组反序列化为对象(字节数组 ---> 对象)
     *
     * @param data
     * @param clazz
     * @return
     */
    public static <T> T deserialize(byte[] data, Class<T> clazz) {
        // 创建泛型对象的schema对象
        RuntimeSchema<T> schema = RuntimeSchema.createFrom(clazz);
        // 根据schema实例化对象
        T message = schema.newMessage();
        // 将字节数组中的数据反序列化到message对象
        ProtostuffIOUtil.mergeFrom(data, message, schema);
        // 返回反序列化对象
        return message;
    }
}

protostuff序列化工具类SerializationUtil2

SerializationUtil的问题在于,每次调用序列化方法和反序列化方法时都需要重新生成一个schema对象,所以可以把生成的schema对象保存起来,在下一次调用方法时就不需要重新生成这些schema对象,这样可以提高序列化和反序列化的性能。

package cn.xpleaf.protostuff.netty.utils;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import com.dyuproject.protostuff.LinkedBuffer;
import com.dyuproject.protostuff.ProtostuffIOUtil;
import com.dyuproject.protostuff.runtime.RuntimeSchema;

/**
 * 具备缓存功能的序列化工具类,基于Protostuff实现(其基于Google Protobuf实现)
 *
 * @author yeyonghao
 *
 */
public class SerializationUtil2 {

    // 缓存schema对象的map
    private static Map<Class<?>, RuntimeSchema<?>> cachedSchema = new ConcurrentHashMap<Class<?>, RuntimeSchema<?>>();

    /**
     * 根据获取相应类型的schema方法
     *
     * @param clazz
     * @return
     */
    @SuppressWarnings({ "unchecked", "unused" })
    private <T> RuntimeSchema<T> getSchema(Class<T> clazz) {
        // 先尝试从缓存schema map中获取相应类型的schema
        RuntimeSchema<T> schema = (RuntimeSchema<T>) cachedSchema.get(clazz);
        // 如果没有获取到对应的schema,则创建一个该类型的schema
        // 同时将其添加到schema map中
        if (schema == null) {
            schema = RuntimeSchema.createFrom(clazz);
            if (schema != null) {
                cachedSchema.put(clazz, schema);
            }
        }
        // 返回schema对象
        return schema;
    }

    /**
     * 序列化方法,将对象序列化为字节数组(对象 ---> 字节数组)
     *
     * @param obj
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <T> byte[] serialize(T obj) {
        // 获取泛型对象的类型
        Class<T> clazz = (Class<T>) obj.getClass();
        // 创建泛型对象的schema对象
        RuntimeSchema<T> schema = RuntimeSchema.createFrom(clazz);
        // 创建LinkedBuffer对象
        LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE);
        // 序列化
        byte[] array = ProtostuffIOUtil.toByteArray(obj, schema, buffer);
        // 返回序列化对象
        return array;
    }

    /**
     * 反序列化方法,将字节数组反序列化为对象(字节数组 ---> 对象)
     *
     * @param data
     * @param clazz
     * @return
     */
    public static <T> T deserialize(byte[] data, Class<T> clazz) {
        // 创建泛型对象的schema对象
        RuntimeSchema<T> schema = RuntimeSchema.createFrom(clazz);
        // 根据schema实例化对象
        T message = schema.newMessage();
        // 将字节数组中的数据反序列化到message对象
        ProtostuffIOUtil.mergeFrom(data, message, schema);
        // 返回反序列化对象
        return message;
    }
}

测试

测试代码如下:

package cn.xpleaf.protostuff.netty.utils;

import static org.junit.Assert.*;

import org.junit.Test;

import cn.xpleaf.pojo.User;

public class TestUtil {

    @Test
    public void testUtil01() throws Exception {
        User user = new User("xpleaf", 10);
        System.out.println(user);
        // 序列化
        byte[] array = SerializationUtil.serialize(user);
        // 反序列化
        User user2 = SerializationUtil.deserialize(array, User.class);
        System.out.println(user2);
        // 判断值是否相等
        System.out.println(user.toString().equals(user2.toString()));
    }

    @Test
    public void testUtil02() throws Exception {
        User user = new User("xpleaf", 10);
        System.out.println(user);
        // 序列化
        byte[] array = SerializationUtil2.serialize(user);
        // 反序列化
        User user2 = SerializationUtil2.deserialize(array, User.class);
        System.out.println(user2);
        // 判断值是否相等
        System.out.println(user.toString().equals(user2.toString()));
    }
}

执行testUtil01时的输出结果如下:

User [name=xpleaf, age=10]
User [name=xpleaf, age=10]
true

执行testUtil02时的输出结果如下:

User [name=xpleaf, age=10]
User [name=xpleaf, age=10]
true

原文地址:http://blog.51cto.com/xpleaf/2071752

时间: 2024-10-11 12:42:16

基于protostuff的序列化工具类开发的相关文章

FTP工具类开发

正所谓工欲善其事必先利其器,熟悉了下一套流程,以此铭记. 1.FTP服务搭建 由于本人使用wondiow系统,所以针对window的童鞋们可以查看.至于windowX这里配置类似,所以不要纠结于window系统不同.经过以上操作我们可以获取到ftp的用户名,密码,以及IP地址,端口号(ps:默认端口号,搭建时可以设置) 2.FTP编码集问题 由于FTP使用编码集为ISO-8859-1,所以在中文文件夹以及文件名称上传,获取服务器文件等会出现问题.有以下2中解决方案: 1.将目录.文件转码,这样就

Java 基于log4j的日志工具类

Java 基于log4j的日志工具类 对log4j日志类进行了简单封装,使用该封装类的优势在于以下两点: 1.不必在每个类中去创建对象,直接类名 + 方法即可 2.可以很方便的打印出堆栈信息 package com.tradeplatform.receiveorder.util; import java.io.PrintWriter; import java.io.StringWriter; import org.apache.log4j.Logger; /** * @Description 日

Java 序列化工具类

import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sun.misc.BASE64Decoder; import sun.misc.BASE64Encoder; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.ObjectInputSt

MapReduce之Job工具类开发

[toc] MapReduce之Job工具类开发 在MapReduce程序写Mapper和Reducer的驱动程序时,有很多代码都是重复性代码,因此可以将其提取出来写成一个工具类,后面再写MapReduce程序时都会使用这个工具类. Job工具类开发 程序代码如下: package com.uplooking.bigdata.common.utils; import org.apache.hadoop.conf.Configuration; import org.apache.hadoop.fs

序列化工具类({对实体Bean进行序列化操作.},{将字节数组反序列化为实体Bean.})

package com.dsj.gdbd.utils.serialize; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; /** * * @作用:序列化工具类 * @功能: * @作者: wyt * @

JSON序列化必看以及序列化工具类

1.要序列化的类必须用 [DataContract] 特性标识 2.需要序列化的属性应用 [DataMember] 特性标识,没有该特性则表示不序列化该属性.类亦如此! 3.可以网络上找封装好的序列化类工具,也可以引用 System.json 程序集 1 // /*--------------- 2 // // 使用地方:eKing 警备系统 [终端和服务器之间的数据同步] 3 // // 4 // // 文件名:JsonUtils.cs 5 // // 文件功能描述: 6 // // 指定对象

基于JSch的Sftp工具类

本Sftp工具类的API如下所示. 1)构造方法摘要 Sftp(String host, int port, int timeout, String username, String password) 参数: host - SFTP服务器IP地址 port - SFTP服务器端口 timeout - 连接超时时间,单位毫秒 username - 用户名 password - 密码 2)方法摘要 boolean changeDir(String pathName)           切换工作目

Protostuff序列化工具类

源代码 package org.wit.ff.util; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.util.List; import com.dyuproject.protostuff.LinkedBuffer; import com.dyuproject.protostuff.ProtostuffIOUti

对象序列化工具类

这个类中提供了对象序列化与反序列化的方法,在实际的项目中会经常被用到. 1 import java.io.*; 2 3 public class SerializationUtils { 4 5 //把一个对象序列化 6 public static byte[] serialize(Object state) { 7 ObjectOutputStream oos = null; 8 try { 9 ByteArrayOutputStream bos = new ByteArrayOutputSt