Spec-Zone.ru › OpenJDK 25

Интерфейс аннотации Serial

@Target({METHOD,FIELD}) @Retention(SOURCE) public @interface Serial
Указывает, что аннотированное поле или метод является частью механизма сериализации, определённого в Спецификации сериализации объектов Java. Этот тип аннотации предназначен для проверки во время компиляции объявлений, связанных с сериализацией, подобно проверке, включаемой типом аннотации Override для проверки переопределения методов. Для классов Serializable рекомендуется использовать аннотации @Serial, чтобы помочь компилятору обнаруживать ошибочные объявления полей и методов, связанных с сериализацией, которые в противном случае может быть трудно выявить.

В частности, аннотации этого типа следует применять к методам и полям, связанным с сериализацией, в классах, объявленных как Serializable. Пять методов, связанных с сериализацией:

  • private void writeObject(java.io.ObjectOutputStream stream) throws IOException
  • private void readObject(java.io.ObjectInputStream stream) throws IOException, ClassNotFoundException
  • private void readObjectNoData() throws ObjectStreamException
  • ANY-ACCESS-MODIFIER Object writeReplace() throws ObjectStreamException
  • ANY-ACCESS-MODIFIER Object readResolve() throws ObjectStreamException
Два поля, связанные с сериализацией:
  • private static final ObjectStreamField[] serialPersistentFields
  • private static final long serialVersionUID
Компиляторам рекомендуется проверять, является ли метод или поле, помеченное аннотацией @Serial, одним из определённых методов или полей, связанных с сериализацией и объявленных в подходящем контексте, и выдавать предупреждение в противном случае.

Применение этой аннотации к другим полям или методам является семантической ошибкой, в том числе в следующих случаях:

  • поля или методы в классе, который не является Serializable
  • поля или методы с правильной структурой объявления, но в типе, в котором они не оказывают эффекта. Например, для типов enum определено значение serialVersionUID, равное 0L, поэтому поле serialVersionUID, объявленное в типе enum, игнорируется. Пять указанных выше методов, связанных с сериализацией, также игнорируются для типа enum.
  • в классе, который является Externalizable:
    • объявления методов writeObject, readObject и readObjectNoData
    • объявление поля для serialPersistentFields
    Хотя интерфейс Externalizable расширяет Serializable, три указанных выше метода и одно поле не используются для внешне сериализуемых классов.
Обратите внимание, что механизм сериализации обращается к предназначенным для него полям и методам с помощью рефлексии, поэтому в классе Serializable эти поля и методы могут казаться неиспользуемыми.
С:
14
Внешние спецификации
  • Спецификация сериализации объектов Java
См. также:
  • Serializable
  • Externalizable

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, в том числе концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.base/java/io/Serial.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API