Spec-Zone.ru › OpenJDK 17

Интерфейс аннотаций 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, три метода и одно поле выше не используются для классов externalizable.
Обратите внимание, что механизм сериализации обращается к своим назначенным полям и методам рефлективно, и эти поля и методы могут показаться иными как неиспользуемые в Serializable классе.
С:
14
См. также:
  • Serializable
  • Externalizable

© 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/Serial.html

Spec-Zone.ru

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