Hadoop 典型Writable类详解
Hadoop
将很多Writable
类归入org.apache.hadoop.io
包中,在这些类中,比较重要的有Java
基本类、Text
、Writable
集合、ObjectWritable
等,重点介绍Java
基本类和ObjectWritable
的实现。
1. Java基本类型的Writable封装
目前Java
基本类型对应的Writable
封装如下表所示。所有这些Writable
类都继承自WritableComparable
。也就是说,它们是可比较的。同时,它们都有get()
和set()
方法,用于获得和设置封装的值。
Java
基本类型对应的Writable
封装
Java基本类型 | Writable | 序列化后长度 |
---|---|---|
布尔型(boolean) | BooleanWritable | 1 |
字节型(byte) | ByteWritable | 1 |
整型(int) | IntWritable VIntWritable | 4 1~5 |
浮点型(float) | FloatWritable | 4 |
长整型(long) | LongWritable VLongWritable | 8 1~9 |
双精度浮点型(double) | DoubleWritable | 8 |
在表中,对整型(int和long)进行编码的时候,有固定长度格式(IntWritable
和LongWritable
)和可变长度格式(VIntWritable
和VLongWritable
)两种选择。固定长度格式的整型,序列化后的数据是定长的,而可变长度格式则使用一种比较灵活的编码方式,对于数值比较小的整型,它们往往比较节省空间。同时,由于VIntWritable
和VLongWritable
的编码规则是一样的,所以VIntWritable
的输出可以用VLongWritable
读入。下面以VIntWritable
为例,说明Writable的Java基本类封装实现。代码如下:
public class VIntWritable implements WritableComparable {
private int value;
// ……
// 设置VIntWritable的值
public void set(int value) { this.value = value; }
// 获取VIntWritable的值
public int get() { return value; }
public void readFields(DataInput in) throws IOException {
value = WritableUtils.readVInt(in);
}
public void write(DataOutput out) throws IOException {
WritableUtils.writeVInt(out, value);
}
}
首先,每个Java
基本类型的Writable
封装,其类的内部都包含一个对应基本类型的成员变量value
,get()
和set()
方法就是用来对该变量进行取值/赋值操作的。而Writable
接口要求的readFields()
和write()
方法,VIntWritable
则是通过调用Writable工具类中提供的readVInt()
和writeVInt()
读/写数据。方法readVInt()
和writeVInt()
的实现也只是简单调用了readVLong()
和writeVLong()
,所以,通过writeVInt()
写的数据自然可以通过readVLong()
读入。
writeVLong ()
方法实现了对整型数值的变长编码,它的编码规则如下:
如果输入的整数大于或等于–112同时小于或等于127,那么编码需要1字节;否则,序列化结果的第一个字节,保存了输入整数的符号和后续编码的字节数。符号和后续字节数依据下面的编码规则(又一个规则):
如果是正数,则编码值范围落在–113和–120间(闭区间),后续字节数可以通过–(v+112)计算。
如果是负数,则编码值范围落在–121和–128间(闭区间),后续字节数可以通过–(v+120)计算。
后续编码将高位在前,写入输入的整数(除去前面全0字节)。代码如下:
public final class WritableUtils {
public stati cvoid writeVInt(DataOutput stream, int i) throws IOException
{
writeVLong(stream, i);
}
/**
* @param stream保存系列化结果输出流
* @param i 被序列化的整数
* @throws java.io.IOException
*/
public static void writeVLong(DataOutput stream, long i) throws……
{
//处于[-112, 127]的整数
if (i >= -112 && i <= 127) {
stream.writeByte((byte)i);
return;
}
//计算情况2的第一个字节
int len = -112;
if (i < 0) {
i ^= -1L;
len = -120;
}
long tmp = i;
while (tmp != 0) {
tmp = tmp >> 8;
len--;
}
stream.writeByte((byte)len);
len = (len < -120) ? -(len + 120) : -(len + 112);
//输出后续字节
for (int idx = len; idx != 0; idx--) {
int shiftbits = (idx - 1) * 8;
long mask = 0xFFL << shiftbits;
stream.writeByte((byte)((i & mask) >> shiftbits));
}
}
}
2. ObjectWritable
类的实现
针对Java
基本类型、字符串、枚举、Writable
、空值、Writable
的其他子类,ObjectWritable
提供了一个封装,适用于字段需要使用多种类型。ObjectWritable
可应用于Hadoop
远程过程调用中参数的序列化和反序列化;ObjectWritable
的另一个典型应用是在需要序列化不同类型的对象到某一个字段,如在一个SequenceFile
的值中保存不同类型的对象(如LongWritable
值或Text
值)时,可以将该值声明为ObjectWritable
。
ObjectWritable
的实现比较冗长,需要根据可能被封装在ObjectWritable
中的各种对象进行不同的处理。ObjectWritable
有三个成员变量,包括被封装的对象实例instance
、该对象运行时类的Class
对象和Configuration
对象。
ObjectWritable
的write
方法调用的是静态方法ObjectWritable.writeObject()
,该方法可以往DataOutput
接口中写入各种Java
对象。
writeObject()
方法先输出对象的类名(通过对象对应的Class
对象的getName()
方法获得),然后根据传入对象的类型,分情况序列化对象到输出流中,也就是说,对象通过该方法输出对象的类名,对象序列化结果对到输出流中。在ObjectWritable.writeObject()
的逻辑中,需要分别处理null
、Java
数组、字符串String
、Java
基本类型、枚举和Writable
的子类6种情况,由于类的继承,处理Writable
时,序列化的结果包含对象类名,对象实际类名和对象序列化结果三部分。
为什么需要对象实际类名呢?根据Java的单根继承规则,ObjectWritable
中传入的declaredClass
,可以是传入instance
对象对应的类的类对象,也可以是instance
对象的父类的类对象。但是,在序列化和反序列化的时候,往往不能使用父类的序列化方法(如write
方法)来序列化子类对象,所以,在序列化结果中必须记住对象实际类名。相关代码如下:
public class ObjectWritable implements Writable, Configurable {
private Class declaredClass;//保存于ObjectWritable的对象对应的类对象
private Object instance;//被保留的对象
private Configuration conf;
public ObjectWritable() {}
public ObjectWritable(Object instance) {
set(instance);
}
public ObjectWritable(Class declaredClass, Object instance) {
this.declaredClass = declaredClass;
this.instance = instance;
}
……
public void readFields(DataInput in) throws IOException {
readObject(in, this, this.conf);
}
public void write(DataOutput out) throws IOException {
writeObject(out, instance, declaredClass, conf);
}
……
public static void writeObject(DataOutput out, Object instance,
Class declaredClass,Configuration conf) throws……{
if (instance == null) {//空
instance = new NullInstance(declaredClass, conf);
declaredClass = Writable.class;
}
// 写出declaredClass的规范名
UTF8.writeString(out, declaredClass.getName());
if (declaredClass.isArray()) {//数组
……
} else if (declaredClass == String.class) {//字符串
……
} else if (declaredClass.isPrimitive()) {//基本类型
if (declaredClass == Boolean.TYPE) { //boolean
out.writeBoolean(((Boolean)instance).booleanValue());
} else if (declaredClass == Character.TYPE) { //char
……
}
} else if (declaredClass.isEnum()) {//枚举类型
……
} else if (Writable.class.isAssignableFrom(declaredClass)) {
//Writable的子类
UTF8.writeString(out, instance.getClass().getName());
((Writable)instance).write(out);
} else {
……
}
public static Object readObject(DataInput in,
ObjectWritable objectWritable, Configuration conf){
……
Class instanceClass = null;
……
Writable writable = WritableFactories.newInstance(instanceClass,
conf);
writable.readFields(in);
instance = writable;
……
}
}
和输出对应,ObjectWritable
的readFields()
方法调用的是静态方法ObjectWritable.readObject()
,该方法的实现和writeObject()
类似,唯一值得研究的是Writable
对象处理部分,readObject()
方法依赖于WritableFactories
类。WritableFactories
类允许非公有的Writable子类定义一个对象工厂,由该工厂创建Writable
对象,如在上面的readObject()
代码中,通过WritableFactories
的静态方法newInstance()
,可以创建类型为instanceClass
的Writable
子对象。相关代码如下:
public class WritableFactories {
//保存了类型和WritableFactory工厂的对应关系
private static final HashMap<Class, WritableFactory>CLASS_TO_FACTORY
= new HashMap<Class, WritableFactory>();
……
public static Writable newInstance(Class<? extends Writable> c,
Configuration conf) {
WritableFactory factory = WritableFactories.getFactory(c);
if (factory != null) {
Writable result = factory.newInstance();
if (result instanceof Configurable) {
((Configurable) result).setConf(conf);
}
return result;
} else {
//采用传统的反射工具ReflectionUtils,创建对象
return ReflectionUtils.newInstance(c, conf);
}
}
}
WritableFactories.newInstance()
方法根据输入的类型查找对应的WritableFactory
工厂对象,然后调用该对象的newInstance()
创建对象,如果该对象是可配置的,newInstance()
还会通过对象的setConf()
方法配置对象。
WritableFactories
提供注册机制,使得这些Writable
子类可以将该工厂登记到WritableFactories
的静态成员变量CLASS_TO_FACTORY
中。下面是一个典型的WritableFactory
工厂实现,来自于HDFS
的数据块Block
。其中,WritableFactories.setFactory()
需要两个参数,分别是注册类对应的类对象和能够构造注册类的WritableFactory
接口的实现,在下面的代码里,WritableFactory
的实现是一个匿名类,其newInstance()
方法会创建一个新的Block对象。
public class Block implements Writable, Comparable<Block> {
static {
WritableFactories.setFactory
(Block.class,//类对象
new WritableFactory() {//对应类的WritableFactory实现
public Writable newInstance() { return new Block(); }
});
}
// ……
}
ObjectWritable
作为一种通用机制,相当浪费资源,它需要为每一个输出写入封装类型的名字。如果类型的数量不是很多,而且可以事先知道,则可以使用一个静态类型数组来提高效率,并使用数组索引作为类型的序列化引用。GenericWritable
就是因为这个目的被引入org.apache.hadoop.io
包中。