Spec-Zone.ru › OpenJDK 24

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

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

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

  • 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`, являются одним из определённых методов или полей сериализации, объявленных в контексте, и выдавать предупреждение, если это не так.

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

  • поля или методы в классе, который не является сериализуемым
  • поля или методы с правильным структурным объявлением, но неэффективными в типе. Например, типы `Externalizable` определены для наличия метода `writeExternal` и поля `serialVersionUID`, поэтому поле `serialVersionUID`, объявленное в типе `Externalizable`, игнорируется. Пять методов сериализации, определённых выше, также игнорируются для типов `Externalizable`.
  • в классе, который является `Externalizable`:
    • объявления методов `writeExternal`, `readExternal`, и `serialVersionUID`
    • объявление поля `serialVersionUID`
    Хотя интерфейс `Serializable` расширяет интерфейс `Externalizable`, эти три метода и одно поле не используются для классов `Externalizable`.
Обратите внимание, что механизм сериализации обращается к своим назначенным полям и методам рефлексивно, и эти поля и методы могут казаться неиспользуемыми в классе `Serializable`.
С тех пор как:
14
Внешние спецификации
  • Спецификация Java Object Serialization
См. также:
  • Serializable
  • Externalizable

© 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/io/Serial.html

Spec-Zone.ru

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