Spec-Zone.ru › OpenJDK 21

Интерфейс аннотаций 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
  • ЛЮБОЙ-МОДИФИКАТОР-ДОСТУПА Object writeReplace() throws ObjectStreamException
  • ЛЮБОЙ-МОДИФИКАТОР-ДОСТУПА 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.
Since:
14
Внешние спецификации
  • Спецификация сериализации Java объектов
См. также:
  • Serializable
  • Externalizable

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

Spec-Zone.ru

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