Класс ObjectOutputStream
- Все реализованные интерфейсы:
-
Closeable,DataOutput,Flushable,ObjectOutput,ObjectStreamConstants,AutoCloseable
public class ObjectOutputStream extends OutputStream implements ObjectOutput, ObjectStreamConstants
Только объекты, поддерживающие интерфейс java.io.Serializable, могут быть записаны в потоки. Класс каждого сериализуемого объекта кодируется, включая имя класса и сигнатуру класса, значения полей и массивов объекта, а также замыкание любых других объектов, на которые ссылаются исходные объекты.
Для записи объекта в поток используется метод writeObject. Любой объект, включая строки и массивы, записывается с помощью writeObject. В поток можно записать несколько объектов или примитивные типы данных. Объекты должны быть прочитаны обратно из соответствующего ObjectInputstream с теми же типами и в том же порядке, в котором они были записаны.
Примитивные типы данных также могут быть записаны в поток с помощью соответствующих методов из DataOutput. Строки также могут быть записаны с помощью метода writeUTF.
По умолчанию механизм сериализации объекта записывает класс объекта, сигнатуру класса и значения всех не-transient и не-static полей. Ссылки на другие объекты (кроме полей transient или static) также вызывают запись этих объектов. Множественные ссылки на один объект кодируются с помощью механизма совместного использования ссылок, чтобы графы объектов можно было восстановить в той же форме, что и при записи исходного объекта.
Например, для записи объекта, который можно прочитать с помощью примера в ObjectInputStream:
FileOutputStream fos = new FileOutputStream("t.tmp");
ObjectOutputStream oos = new ObjectOutputStream(fos);
oos.writeInt(12345);
oos.writeObject("Today");
oos.writeObject(new Date());
oos.close();
Классы, требующие специальной обработки при сериализации и десериализации, должны реализовывать специальные методы с этими точными сигнатурами:
private void readObject(java.io.ObjectInputStream stream)
throws IOException, ClassNotFoundException;
private void writeObject(java.io.ObjectOutputStream stream)
throws IOException
private void readObjectNoData()
throws ObjectStreamException;
Метод writeObject отвечает за запись состояния объекта для его конкретного класса, чтобы соответствующий метод readObject мог восстановить его. Метод не должен беспокоиться о состоянии, относящемся к суперклассам или подклассам объекта. Состояние сохраняется путем записи отдельных полей в ObjectOutputStream с помощью метода writeObject или с помощью методов для примитивных типов данных, поддерживаемых DataOutput.
Сериализация не записывает поля любого объекта, который не реализует интерфейс java.io.Serializable. Подклассы объектов, которые не сериализуемы, могут быть сериализуемыми. В этом случае несериализуемый класс должен иметь конструктор без аргументов, чтобы позволить инициализировать его поля. В этом случае подкласс отвечает за сохранение и восстановление состояния несериализуемого класса. Часто бывает, что поля этого класса доступны (public, package или protected), или есть методы get и set, которые можно использовать для восстановления состояния.
Сериализацию объекта можно предотвратить, реализовав методы writeObject и readObject, которые выбрасывают NotSerializableException. Исключение будет перехвачено ObjectOutputStream и прервет процесс сериализации.
Реализация интерфейса Externalizable позволяет объекту полностью контролировать содержимое и формат сериализованной формы объекта. Методы интерфейса Externalizable, writeExternal и readExternal, вызываются для сохранения и восстановления состояния объекта. При реализации классом они могут записывать и считывать своё состояние, используя все методы ObjectOutput и ObjectInput. Объекты должны обрабатывать любые изменения версии.
Константы перечисления сериализуются по-другому, чем обычные сериализуемые или внешне сериализуемые объекты. Сериализованная форма константы перечисления состоит только из её имени; значения полей константы не передаются. Для сериализации константы перечисления ObjectOutputStream записывает строку, возвращаемую методом name константы. Как и другие сериализуемые или внешне сериализуемые объекты, константы перечисления могут действовать как цели обратных ссылок, появляющиеся впоследствии в потоке сериализации. Процесс сериализации констант перечисления не может быть настроен; любые методы writeObject и writeReplace, специфичные для класса, определённые типами перечислений, игнорируются при сериализации. Аналогично, любые объявления полей serialPersistentFields или serialVersionUID также игнорируются – все типы перечислений имеют фиксированную serialVersionUID 0L.
Примитивные данные, за исключением сериализуемых полей и внешне сериализуемых данных, записываются в ObjectOutputStream в блоках данных. Блок данных состоит из заголовка и данных. Заголовок блока данных содержит маркер и количество байтов, следующих за заголовком. Последовательные записи примитивных данных объединяются в один блок данных. Коэффициент блоков, используемый для блока данных, будет 1024 байта. Каждый блок данных будет заполняться до 1024 байт или записываться всякий раз, когда происходит завершение режима блока данных. Вызовы методов ObjectOutputStream writeObject, defaultWriteObject и writeFields изначально завершают любой существующий блок данных.
Записи сериализуются по-другому, чем обычные сериализуемые или внешне сериализуемые объекты, см. сериализацию записей.
Краткое описание вложенных классов
| Модификатор и тип | Класс | Описание |
|---|---|---|
static class |
ObjectOutputStream.PutField |
Предоставляет программный доступ к постоянным полям, которые будут записаны в ObjectOutput. |
Краткое описание полей
Поля, объявленные в интерфейсе java.io.ObjectStreamConstants
baseWireHandle, PROTOCOL_VERSION_1, PROTOCOL_VERSION_2, SC_BLOCK_DATA, SC_ENUM, SC_EXTERNALIZABLE, SC_SERIALIZABLE, SC_WRITE_METHOD, SERIAL_FILTER_PERMISSION, STREAM_MAGIC, STREAM_VERSION, SUBCLASS_IMPLEMENTATION_PERMISSION, SUBSTITUTION_PERMISSION, TC_ARRAY, TC_BASE, TC_BLOCKDATA, TC_BLOCKDATALONG, TC_CLASS, TC_CLASSDESC, TC_ENDBLOCKDATA, TC_ENUM, TC_EXCEPTION, TC_LONGSTRING, TC_MAX, TC_NULL, TC_OBJECT, TC_PROXYCLASSDESC, TC_REFERENCE, TC_RESET, TC_STRING
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Предоставляет способ для подклассов, полностью переопределяющих ObjectOutputStream, чтобы им не нужно было выделять частные данные, используемые только этим реализацией ObjectOutputStream. |
|
| Создает ObjectOutputStream, который записывает данные в указанный OutputStream. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
protected void |
annotateClass |
Подклассы могут реализовать этот метод, чтобы разрешить хранение данных класса в потоке. |
protected void |
annotateProxyClass |
Подклассы могут реализовать этот метод для хранения пользовательских данных в потоке вместе с дескрипторами для динамических прокси-классов. |
void |
close() |
Закрывает поток. |
void |
defaultWriteObject() |
Записывает нестатические и непеременные поля текущего класса в этот поток. |
protected void |
drain() |
Очищает любые буферизованные данные в ObjectOutputStream. |
protected boolean |
enableReplaceObject |
Включает возможность потоку выполнять замену объектов, записанных в поток. |
void |
flush() |
Очищает поток. |
ObjectOutputStream.PutField |
putFields() |
Получает объект, используемый для буферизации постоянных полей, которые будут записаны в поток. |
protected Object |
replaceObject |
Этот метод позволит доверенным подклассам ObjectOutputStream подменять один объект другим во время сериализации. |
void |
reset() |
Сброс проигнорирует состояние любых объектов, уже записанных в поток. |
void |
useProtocolVersion |
Указывает версию протокола потока, используемую при записи потока. |
void |
write |
Записывает массив байтов. |
void |
write |
Записывает подмассив байтов. |
void |
write |
Записывает байт. |
void |
writeBoolean |
Записывает булево значение. |
void |
writeByte |
Записывает байт 8-битного размера. |
void |
writeBytes |
Записывает строку в виде последовательности байтов. |
void |
writeChar |
Записывает символ 16-битного размера. |
void |
writeChars |
Записывает строку в виде последовательности символов. |
protected void |
writeClassDescriptor |
Записывает указанный дескриптор класса в ObjectOutputStream. |
void |
writeDouble |
Записывает двойное значение 64-битного размера. |
void |
writeFields() |
Записывает буферизованные поля в поток. |
void |
writeFloat |
Записывает число с плавающей точкой 32-битного размера. |
void |
writeInt |
Записывает целое число 32-битного размера. |
void |
writeLong |
Записывает целое число 64-битного размера. |
final void |
writeObject |
Записывает указанный объект в ObjectOutputStream. |
protected void |
writeObjectOverride |
Метод, используемый подклассами для переопределения метода writeObject по умолчанию. |
void |
writeShort |
Записывает короткое целое число 16-битного размера. |
protected void |
writeStreamHeader() |
Метод writeStreamHeader предоставляется, чтобы подклассы могли добавлять или вставлять свой собственный заголовок в поток. |
void |
writeUnshared |
Записывает "необщий" объект в ObjectOutputStream. |
void |
writeUTF |
Запись примитивных данных этой строки в формате изменённого UTF-8. |
Методы, объявленные в классе java.io.OutputStream
nullOutputStream
Подробное описание конструкторов
ObjectOutputStream
public ObjectOutputStream(OutputStream out) throws IOException
Если установлен менеджер безопасности, этот конструктор проверит наличие разрешения "enableSubclassImplementation" SerializablePermission при вызове непосредственно или косвенно конструктором подкласса, который переопределяет методы ObjectOutputStream.putFields или ObjectOutputStream.writeUnshared.
- Параметры:
-
out- поток вывода для записи - Исключения:
-
IOException- если при записи заголовка потока произошла ошибка ввода-вывода -
SecurityException- если недоверенный подкласс неправомерно переопределяет методы, связанные с безопасностью -
NullPointerException- еслиoutявляетсяnull - С тех пор:
- 1.4
- См. также:
ObjectOutputStream
protected ObjectOutputStream() throws IOException, SecurityException
Если установлен менеджер безопасности, этот метод сначала вызывает метод менеджера безопасности checkPermission с разрешением SerializablePermission("enableSubclassImplementation"), чтобы убедиться, что разрешено включение подклассов.
- Исключения:
-
SecurityException- если менеджер безопасности существует и его методcheckPermissionзапрещает включение подклассов. -
IOException- если при создании этого потока произошла ошибка ввода-вывода - См. также:
Подробное описание методов
useProtocolVersion
public void useProtocolVersion(int version) throws IOException
Эта функция предоставляет возможность использовать текущую версию сериализации для записи в формате, обратном совместимом с предыдущей версией формата потока.
Будут предприняты все усилия, чтобы избежать введения дополнительных обратных несовместимостей; однако иногда другого выхода нет.
- Параметры:
-
version- использовать ProtocolVersion из java.io.ObjectStreamConstants. - Исключения:
-
IllegalStateException- если вызвана после сериализации каких-либо объектов. -
IllegalArgumentException- если передана неверная версия. -
IOException- если произошли ошибки ввода-вывода - С тех пор:
- 1.2
- См. также:
writeObject
public final void writeObject(Object obj) throws IOException
Исключения выбрасываются при проблемах с OutputStream и для классов, которые не должны сериализоваться. Все исключения являются фатальными для OutputStream, который находится в неопределённом состоянии, и вызывающая сторона должна игнорировать или восстанавливать состояние потока.
- Определено в:
-
writeObjectв интерфейсеObjectOutput - Параметры:
-
obj- объект, который нужно записать - Исключения:
-
InvalidClassException- что-то не так с классом, используемым сериализацией. -
NotSerializableException- некоторый объект, подлежащий сериализации, не реализует интерфейс java.io.Serializable. -
IOException- любое исключение, выброшенное базовым OutputStream.
writeObjectOverride
protected void writeObjectOverride(Object obj) throws IOException
- Параметры:
-
obj- объект, который нужно записать в базовый поток - Исключения:
-
IOException- если при записи в базовый поток возникли ошибки ввода-вывода - С тех пор:
- 1.2
- См. также:
defaultWriteObject
public void defaultWriteObject() throws IOException
- Исключения:
-
IOException- если при записи в базовыйOutputStreamпроизошли ошибки ввода-вывода
putFields
public ObjectOutputStream.PutField putFields() throws IOException
- Возвращает:
- экземпляр класса Putfield, содержащий сериализуемые поля
- Исключения:
-
IOException- если произошли ошибки ввода-вывода - С тех пор:
- 1.2
writeFields
public void writeFields() throws IOException
- Исключения:
-
IOException- если при записи в базовый поток возникли ошибки ввода-вывода -
NotActiveException- вызывается, когда метод writeObject класса не был вызван для записи состояния объекта. - С тех пор:
- 1.2
reset
public void reset() throws IOException
- Исключения:
-
IOException- если reset() вызван во время сериализации объекта.
annotateClass
protected void annotateClass(Class<?> cl) throws IOException
- Параметры:
-
cl- класс, для которого нужно добавить пользовательские данные - Исключения:
-
IOException- любое исключение, выброшенное базовым OutputStream.
annotateProxyClass
protected void annotateProxyClass(Class<?> cl) throws IOException
Этот метод вызывается ровно один раз для каждого уникального дескриптора прокси-класса в потоке. По умолчанию этот метод в ObjectOutputStream ничего не делает.
Соответствующий метод в ObjectInputStream — resolveProxyClass. Для данного подкласса ObjectOutputStream, переопределяющего этот метод, метод resolveProxyClass в соответствующем подклассе ObjectInputStream должен считывать любые данные или объекты, записанные annotateProxyClass.
- Parameters:
-
cl- прокси-класс, для которого необходимо добавить пользовательские данные - Throws:
-
IOException- любая ошибка, выброшенная базовымOutputStream - Since:
- 1.3
- See Also:
replaceObject
protected Object replaceObject(Object obj) throws IOException
Метод ObjectOutputStream.writeObject принимает параметр типа Object (вместо Serializable), чтобы разрешить случаи, когда несериализуемые объекты заменяются сериализуемыми.
Когда подкласс заменяет объекты, он должен гарантировать, что во время десериализации будет выполнена соответствующая подмена или что заменённый объект совместим со всеми полями, в которых будет храниться ссылка. Объекты, тип которых не является подклассом типа поля или элемента массива, прерывают сериализацию, вызывая исключение, и объект не сохраняется.
Этот метод вызывается только один раз при первом обнаружении каждого объекта. Все последующие ссылки на объект будут перенаправлены на новый объект. Этот метод должен возвращать заменяющий объект или исходный объект.
Возвращение null в качестве заменяющего объекта может вызвать NullReferenceException в классах, содержащих ссылки на исходный объект, так как они могут ожидать объекта, а не null.
- Parameters:
-
obj- объект, который нужно заменить - Returns:
- альтернативный объект, заменяющий указанный
- Throws:
-
IOException- Любое исключение, выброшенное базовым потоком вывода.
enableReplaceObject
protected boolean enableReplaceObject(boolean enable) throws SecurityException
replaceObject(java.lang.Object) вызывается для каждого сериализуемого объекта. Если замена объектов не включена в данный момент, и enable равно true, а менеджер безопасности установлен, этот метод сначала вызывает метод checkPermission менеджера безопасности с разрешением SerializablePermission("enableSubstitution"), чтобы убедиться, что у вызывающего метода есть разрешение на включение замены объектов, записываемых в поток.
- Parameters:
-
enable- true для включения использованияreplaceObjectдля каждого сериализуемого объекта - Returns:
- предыдущее значение до вызова этого метода
- Throws:
-
SecurityException- если менеджер безопасности существует и его методcheckPermissionзапрещает включение замены объектов, записываемых в поток. - See Also:
writeStreamHeader
protected void writeStreamHeader() throws IOException
- Throws:
-
IOException- если при записи в базовый поток произошли ошибки ввода-вывода
writeClassDescriptor
protected void writeClassDescriptor(ObjectStreamClass desc) throws IOException
readClassDescriptor, должен быть переопределен для восстановления дескриптора класса из его пользовательского представления в потоке. По умолчанию этот метод записывает дескрипторы классов в соответствии с форматом, определенным в спецификации сериализации объектов. Обратите внимание, что этот метод будет вызван только в том случае, если ObjectOutputStream не использует старый формат потока сериализации (установленный вызовом метода useProtocolVersion объекта ObjectOutputStream). Если этот поток сериализации использует старый формат (PROTOCOL_VERSION_1), дескриптор класса будет записан внутри способом, который нельзя переопределить или настроить.
- Parameters:
-
desc- дескриптор класса для записи в поток - Throws:
-
IOException- Если произошла ошибка ввода-вывода. - Since:
- 1.3
- See Also:
write
public void write(int val) throws IOException
- Specified by:
-
writeв интерфейсеDataOutput - Specified by:
-
writeв интерфейсеObjectOutput - Specified by:
-
writeв классеOutputStream - Parameters:
-
val- байт, который нужно записать в поток - Throws:
-
IOException- Если произошла ошибка ввода-вывода.
write
public void write(byte[] buf) throws IOException
- Specified by:
-
writeв интерфейсеDataOutput - Specified by:
-
writeв интерфейсеObjectOutput - Overrides:
-
writeв классеOutputStream - Parameters:
-
buf- данные для записи - Throws:
-
IOException- Если произошла ошибка ввода-вывода. - See Also:
write
public void write(byte[] buf, int off, int len) throws IOException
- Specified by:
-
writeв интерфейсеDataOutput - Specified by:
-
writeв интерфейсеObjectOutput - Overrides:
-
writeв классеOutputStream - Parameters:
-
buf- данные для записи -
off- начальный смещение в данных -
len- количество записываемых байтов - Throws:
-
IOException- Если произошла ошибка ввода-вывода.
flush
public void flush() throws IOException
- Specified by:
-
flushв интерфейсеFlushable - Specified by:
-
flushв интерфейсеObjectOutput - Overrides:
-
flushв классеOutputStream - Throws:
-
IOException- Если произошла ошибка ввода-вывода.
drain
protected void drain() throws IOException
- Throws:
-
IOException- если при записи в базовый поток произошли ошибки ввода-вывода
close
public void close() throws IOException
- Specified by:
-
closeв интерфейсеAutoCloseable - Specified by:
-
closeв интерфейсеCloseable - Specified by:
-
closeв интерфейсеObjectOutput - Overrides:
-
closeв классеOutputStream - Throws:
-
IOException- Если произошла ошибка ввода-вывода.
writeBoolean
public void writeBoolean(boolean val) throws IOException
- Specified by:
-
writeBooleanв интерфейсеDataOutput - Parameters:
-
val- булево значение для записи - Throws:
-
IOException- если при записи в базовый поток произошли ошибки ввода-вывода
writeByte
public void writeByte(int val) throws IOException
- Указано:
-
writeByteв интерфейсеDataOutput - Параметры:
-
val- значение байта, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeShort
public void writeShort(int val) throws IOException
- Указано:
-
writeShortв интерфейсеDataOutput - Параметры:
-
val- значение короткого целого числа, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeChar
public void writeChar(int val) throws IOException
- Указано:
-
writeCharв интерфейсеDataOutput - Параметры:
-
val- значение символа, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeInt
public void writeInt(int val) throws IOException
- Указано:
-
writeIntв интерфейсеDataOutput - Параметры:
-
val- значение целого числа, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeLong
public void writeLong(long val) throws IOException
- Указано:
-
writeLongв интерфейсеDataOutput - Параметры:
-
val- значение длинного целого числа, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeFloat
public void writeFloat(float val) throws IOException
- Указано:
-
writeFloatв интерфейсеDataOutput - Параметры:
-
val- значение числа с плавающей точкой, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeDouble
public void writeDouble(double val) throws IOException
- Указано:
-
writeDoubleв интерфейсеDataOutput - Параметры:
-
val- значение числа с плавающей точкой, которое нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeBytes
public void writeBytes(String str) throws IOException
- Указано:
-
writeBytesв интерфейсеDataOutput - Параметры:
-
str- строка байтов, которые нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeChars
public void writeChars(String str) throws IOException
- Указано:
-
writeCharsв интерфейсеDataOutput - Параметры:
-
str- строка символов, которые нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
writeUTF
public void writeUTF(String str) throws IOException
- Указано:
-
writeUTFв интерфейсеDataOutput - Параметры:
-
str- строка, которую нужно записать - Исключения:
-
IOException- если возникают ошибки ввода-вывода во время записи в базовый поток
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/ObjectOutputStream.html