鸿蒙OS开发文档 第12页
Serializable public interface Serializable 类的可序列化性由实现 java.io.Serializable 接口的类启用。未实现此接口的类将不会对其任何状态进行序列化或反序列化。可序列化类的所有子类型本身都是可序列化的。序列化接口没有方法或字段,仅用于识别可序列化的语义。 为了允许序列化不可序列化类的子类型,子类型可以负责保存和恢复超类型的公共、受保护和(如果可访问)包字段的状态。仅当它扩展的类具有可访问的无参数构造函数来初始化类的状态时,子类型才可以承担此责任。如果不是这种情况,则声明类 Serializable 是错误的。将在运行时检测到错误。 在反序列化过程中,不可序列化类的字段将使用类的公共或受保护的无参数构造函数进行初始化。可序列化的子类必须可以访问无参数构造函数。可序列化子类的字段将从流中恢复。 在遍历图时,可能会遇到不支持 Serializable 接口的对象。在这种情况下,NotSerializableException 将被抛出,并将识别不可序列化对象的类。 在序列化和反序列化过程中需要特殊处理的类必须实现具有这些确切签名的特殊方法: private void writeObject(java.io.ObjectOutputStream out) throws IOException private void readObject(java.io.ObjectInputStream in) throws IOException, ClassNotFoundException; private void readObjectNoData() throws ObjectStreamException; writeObject 方法负责为其特定类写入对象的状态,以便相应的 readObject 方法可以恢复它。可以通过调用 out.defaultWriteObject 来调用保存 Object 字段的默认机制。该方法不需要关注属于其超类或子类的状态。通过使用 writeObject 方法或使用 DataOutput 支持的原始数据类型的方法将各个字段写入 ObjectOutputStream 来保存状态。 readObject 方法负责从流中读取并恢复类字段。它可以调用 in.defaultReadObject 来调用用于恢复对象的非静态和非瞬态字段的默认机制。 defaultReadObject 方法使用流中的信息将保存在流中的对象的字段分配给当前对象中相应命名的字段。这可以处理类已经演变为添加新字段的情况。该方法不需要关注属于其超类或子类的状态。通过使用 writeObject 方法或使用 DataOutput 支持的原始数据类型的方法将各个字段写入 ObjectOutputStream 来保存状态。 如果序列化流未将给定类列为被反序列化对象的超类,readObjectNoData 方法负责为其特定类初始化对象的状态。这可能发生在接收方使用与发送方不同版本的反序列化实例类的情况下,并且接收方的版本扩展了发送方版本未扩展的类。如果序列化流已被篡改,也可能发生这种情况;因此,尽管存在“敌对”或不完整的源流,但 readObjectNoData 对于正确初始化反序列化对象很有用。 在将对象写入流时需要指定要使用的替代对象的可序列化类应使用精确签名实现此特殊方法: ANY-ACCESS-MODIFIER Object writeReplace() throws ObjectStreamException; 如果该方法存在并且可以从被序列化对象的类中定义的方法访问,则该 writeReplace 方法由序列化调用。 因此,该方法可以具有私有、受保护和包私有访问。 对该方法的子类访问遵循 java 可访问性规则。 当从流中读取实例时需要指定替换的类应该使用精确的签名实现这个特殊方法。 ANY-ACCESS-MODIFIER Object readResolve() throws ObjectStreamException; 此 readResolve 方法遵循与 writeReplace 相同的调用规则和可访问性规则。 序列化运行时将版本号与每个可序列化类相关联,称为 serialVersionUID,在反序列化期间使用该版本号来验证序列化对象的发送者和接收者是否已为该对象加载了与序列化兼容的类。 如果接收者为对象加载了一个类,该对象的 serialVersionUID 与相应发送者的类不同,则反序列化将导致 InvalidClassException。 可序列化的类可以通过声明一个名为“serialVersionUID”的字段来显式声明自己的serialVersionUID,该字段必须是静态的、最终的和long类型: ANY-ACCESS-MODIFIER static final long serialVersionUID = 42L; 如果可序列化类没有显式声明 serialVersionUID,则序列化运行时将根据类的各个方面为该类计算默认的 serialVersionUID 值,如 Java(TM) 对象序列化规范中所述。但是,强烈建议所有可序列化的类都显式声明 serialVersionUID 值,因为默认的 serialVersionUID 计算对类细节高度敏感,这些细节可能因编译器实现而异,因此可能在反序列化期间导致意外的 InvalidClassExceptions。因此,为了保证在不同的 java 编译器实现中具有一致的 serialVersionUID 值,可序列化的类必须声明一个显式的 serialVersionUID 值。还强烈建议显式 serialVersionUID...
ObjectStreamConstants public interface ObjectStreamConstants 写入对象序列化流的常量。 Since: JDK 1.1 字段摘要 修饰符和类型 字段 描述 static int baseWireHandle 要分配的第一个导线句柄。 static int PROTOCOL_VERSION_1 流协议版本。 static int PROTOCOL_VERSION_2 流协议版本。 static byte SC_BLOCK_DATA ObjectStreamClass 标志的位掩码。 static byte SC_ENUM ObjectStreamClass 标志的位掩码。 static byte SC_EXTERNALIZABLE ObjectStreamClass 标志的位掩码。 static byte SC_SERIALIZABLE ObjectStreamClass 标志的位掩码。 static byte SC_WRITE_METHOD ObjectStreamClass 标志的位掩码。 static short STREAM_MAGIC 写入流标头的幻数。 static short STREAM_VERSION 写入流标头的版本号。 static SerializablePermission SUBCLASS_IMPLEMENTATION_PERMISSION 启用 readObject 和 writeObject 的覆盖。 static SerializablePermission SUBSTITUTION_PERMISSION 在序列化/反序列化期间启用一个对象替换另一个对象。 static byte TC_ARRAY 新数组。 static byte TC_BASE 第一个标签值。 static byte TC_BLOCKDATA 可选数据块。 static byte TC_BLOCKDATALONG 长块数据。 static byte TC_CLASS 参考类。 static byte TC_CLASSDESC 新的类描述符。 static byte TC_ENDBLOCKDATA 对象的可选块数据块的结尾。 static byte TC_ENUM 新的枚举常量。 static byte TC_EXCEPTION 写入期间出现异常。 static byte TC_LONGSTRING 长串。 static byte TC_MAX 最后一个标签值。 static byte TC_NULL 空对象引用。 static byte TC_OBJECT 新对象。 static byte TC_PROXYCLASSDESC 新的代理类描述符。 static byte TC_REFERENCE 对已写入流的对象的引用。 static byte TC_RESET 重置流上下文。 static byte TC_STRING 新字符串。 字段详细信息 PROTOCOL_VERSION_1 static final int PROTOCOL_VERSION_1 流协议版本。 调用此方法后,所有可外部化的数据都以 JDK 1.1 的外部数据格式写入。 需要此版本来编写包含可被 JDK 1.1.6 之前的 JVM 读取的 Externalizable 数据的流。 Since: 1.2...
ObjectOutput public interface ObjectOutput extends DataOutput, AutoCloseable ObjectOutput 扩展了 DataOutput 接口以包括对象的写入。 DataOutput 包括用于输出原始类型的方法,ObjectOutput 扩展了该接口以包括对象、数组和字符串。 Since: JDK1.1 方法总结 修饰符和类型 方法 描述 void close() 关闭流。 void flush() 冲洗流。 void write(byte[] b) 写入一个字节数组。 void write(byte[] b, int off, int len) 写入一个子字节数组。 void write(int b) 写入一个字节。 void writeObject(Object obj) 将对象写入底层存储或流。 从接口 java.io.DataOutput 继承的方法 writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF 方法详情 writeObject void writeObject(Object obj) throws IOException 将对象写入底层存储或流。 实现此接口的类定义了对象的编写方式。 参数: 参数名称 参数描述 obj 要写入的对象 Throws: Throw名称 Throw描述 IOException 任何常见的输入/输出相关异常。 write void write(int b) throws IOException 写入一个字节。 此方法将阻塞,直到实际写入字节。 指定者: 写入接口DataOutput 参数: 参数名称 参数描述 b 字节 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误。 write void write(byte[] b) throws IOException 写入一个字节数组。 此方法将阻塞,直到实际写入字节。 指定者: 写入接口DataOutput 参数: 参数名称 参数描述 b 要写入的数据 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误。 write void write(byte[] b, int off, int len) throws IOException 写入一个子字节数组。 指定者: 写入接口DataOutput 参数: 参数名称 参数描述 b 要写入的数据 off...
ObjectInputValidation public interface ObjectInputValidation 回调接口以允许验证图中的对象。 允许在反序列化完整的对象图时调用对象。 Since: JDK1.1 方法总结 修饰符和类型 方法 描述 void validateObject() 验证对象。 方法详情 validateObject void validateObject() throws InvalidObjectException 验证对象。 Throws: Throw名称 Throw描述 InvalidObjectException 如果对象无法验证自己。
ObjectInput public interface ObjectInput extends DataInput, AutoCloseable ObjectInput 扩展了 DataInput 接口以包括对象的读取。 DataInput 包括用于输入原始类型的方法,ObjectInput 扩展了该接口以包括对象、数组和字符串。 Since: JDK1.1 方法总结 修饰符和类型 方法 描述 int available() 返回可以在不阻塞的情况下读取的字节数。 void close() 关闭输入流。 int read() 读取一个字节的数据。 int read(byte[] b) 读入一个字节数组。 int read(byte[] b, int off, int len) 读入一个字节数组。 Object readObject() 读取并返回一个对象。 long skip(long n) 跳过 n 个字节的输入。 从接口 java.io.DataInput 继承的方法 readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes 方法详情 readObject Object readObject() throws ClassNotFoundException, IOException 读取并返回一个对象。 实现此接口的类定义了从何处“读取”对象。 返回: 从流中读取的对象 Throws: Throw名称 Throw描述 ClassNotFoundException 如果找不到序列化对象的类。 IOException 如果发生任何常见的输入/输出相关异常。 read int read() throws IOException 读取一个字节的数据。 如果没有可用的输入,此方法将阻塞。 返回: 读取的字节,如果到达流的末尾,则为 -1。 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误。 read int read(byte[] b) throws IOException 读入一个字节数组。 此方法将阻塞,直到某些输入可用。 参数: 参数名称 参数描述 b 读取数据的缓冲区 返回: 实际读取的字节数,到达流末尾时返回-1。 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误。 read int read(byte[] b, int off, int len) throws IOException 读入一个字节数组。 此方法将阻塞,直到某些输入可用。 参数: 参数名称 参数描述 b 读取数据的缓冲区 off 数据的起始偏移量 len 读取的最大字节数 返回:...
Flushable public interface Flushable Flushable 是可以刷新的数据的目的地。 调用 flush 方法将任何缓冲的输出写入底层流。 Since: 1.5 方法总结 修饰符和类型 方法 描述 void flush() 通过将任何缓冲输出写入底层流来刷新此流。 方法详情 flush void flush() throws IOException 通过将任何缓冲输出写入底层流来刷新此流。 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误
FilenameFilter @FunctionalInterface public interface FilenameFilter 实现此接口的类的实例用于过滤文件名。 这些实例用于过滤类 File 的 list 方法中的目录列表,并由 Abstract Window Toolkit 的文件对话框组件。 Since: JDK1.0 方法总结 修饰符和类型 方法 描述 boolean accept(File dir, String name) 测试指定文件是否应包含在文件列表中。 方法详情 accept boolean accept(File dir, String name) 测试指定文件是否应包含在文件列表中。 参数: 参数名称 参数描述 dir 找到文件的目录。 name 文件的名称。 返回: 当且仅当名称应包含在文件列表中时为 true; 否则为 false。
FileFilter @FunctionalInterface public interface FileFilter 抽象路径名的过滤器。 此接口的实例可以传递给 File 类的 File#listFiles(java.io.FileFilter) 方法。 Since: 1.2 方法总结 修饰符和类型 方法 描述 boolean accept(File pathname) 测试指定的抽象路径名是否应包含在路径名列表中。 方法详情 accept boolean accept(File pathname) 测试指定的抽象路径名是否应包含在路径名列表中。 参数: 参数名称 参数描述 pathname 要测试的抽象路径名 返回: 当且仅当应该包含路径名时才为 true
Externalizable public interface Externalizable extends Serializable 只有 Externalizable 实例的类的标识被写入序列化流中,并且类有责任保存和恢复其实例的内容。 Externalizable 接口的 writeExternal 和 readExternal 方法由一个类实现,以使该类可以完全控制对象及其超类型的流的格式和内容。这些方法必须显式地与超类型协调以保存其状态。这些方法取代了 writeObject 和 readObject 方法的自定义实现。对象序列化使用 Serializable 和 Externalizable 接口。对象持久性机制也可以使用它们。每个要存储的对象都针对 Externalizable 接口进行了测试。如果对象支持 Externalizable,则调用 writeExternal 方法。如果对象不支持 Externalizable 并且实现了 Serializable,则使用 ObjectOutputStream 保存对象。重构 Externalizable 对象时,会使用公共无参数构造函数创建实例,然后调用 readExternal 方法。可序列化对象是通过从 ObjectInputStream 中读取来恢复的。 Externalizable 实例可以通过 Serializable 接口中记录的 writeReplace 和 readResolve 方法指定替换对象。 Since: JDK1.1 方法总结 修饰符和类型 方法 描述 void readExternal(ObjectInput in) 该对象实现了 readExternal 方法来恢复其内容,方法是调用基本类型的 DataInput 方法和对象、字符串和数组的 readObject 方法。 void writeExternal(ObjectOutput out) 对象实现 writeExternal 方法以保存其内容,方法是调用 DataOutput 的方法获取其原始值,或者调用 ObjectOutput 的 writeObject 方法获取对象、字符串和数组。 方法详情 writeExternal void writeExternal(ObjectOutput out) throws IOException 对象实现 writeExternal 方法以保存其内容,方法是调用 DataOutput 的方法获取其原始值,或者调用 ObjectOutput 的 writeObject 方法获取对象、字符串和数组。 参数: 参数名称 参数描述 out 将对象写入的流 Throws: Throw名称 Throw描述 IOException 包括可能发生的任何 I/O 异常 readExternal void readExternal(ObjectInput in) throws ClassNotFoundException, IOException 该对象实现了 readExternal 方法来恢复其内容,方法是调用基本类型的 DataInput 方法和对象、字符串和数组的 readObject 方法。 readExternal 方法必须以与 writeExternal 写入的相同顺序和相同类型读取值。 参数: 参数名称 参数描述 in 要从中读取数据以恢复对象的流 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误 ClassNotFoundException 如果找不到正在恢复的对象的类。
DataOutput public interface DataOutput DataOutput 接口提供将数据从任何 Java 原始类型转换为一系列字节并将这些字节写入二进制流。 还有一种工具可以将字符串转换为修改后的 UTF-8 格式并写入生成的一系列字节。 对于此接口中所有写入字节的方法,通常情况下,如果由于某种原因无法写入字节,则会抛出 IOException。 Since: JDK1.0 方法总结 修饰符和类型 方法 描述 void write(byte[] b) 将数组 b 中的所有字节写入输出流。 void write(byte[] b, int off, int len) 按顺序将数组 b 中的 len 个字节写入输出流。 void write(int b) 将参数 b 的 8 个低位写入输出流。 void writeBoolean(boolean v) 将布尔值写入此输出流。 void writeByte(int v) 将参数 v 的 8 个低位写入输出流。 void writeBytes(String s) 将字符串写入输出流。 void writeChar(int v) 将一个由两个字节组成的 char 值写入输出流。 void writeChars(String s) 将字符串 s 中的每个字符按顺序写入输出流,每个字符两个字节。 void writeDouble(double v) 将包含八个字节的双精度值写入输出流。 void writeFloat(float v) 将一个由四个字节组成的浮点值写入输出流。 void writeInt(int v) 将一个由四个字节组成的 int 值写入输出流。 void writeLong(long v) 将一个由 8 个字节组成的 long 值写入输出流。 void writeShort(int v) 将两个字节写入输出流以表示参数的值。 void writeUTF(String s) 将两个字节的长度信息写入输出流,然后是字符串 s 中每个字符的修改后的 UTF-8 表示。 方法详情 write void write(int b) throws IOException 将参数 b 的 8 个低位写入输出流。 b 的高 24 位被忽略。 参数: 参数名称 参数描述 b 要写入的字节。 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误。 write void write(byte[] b) throws IOException 将数组 b 中的所有字节写入输出流。 如果 b 为 null,则抛出 NullPointerException。 如果 b.length 为零,则不写入任何字节。 否则,先写入字节 b[0],然后写入 b[1],以此类推; 最后写入的字节是 b[b.length-1]。 参数: 参数名称 参数描述 b 数据。 Throws: Throw名称 Throw描述 IOException 如果发生 I/O 错误。 write...