rspec/rules/S6219/java/rule.adoc
2021-04-28 18:08:03 +02:00

34 lines
1.3 KiB
Plaintext

In Records serialization is not done the same way as for ordinary serializable or externalizable classes. Records serialization does not rely on the ``++serialVersionUID++`` field, because the requirement to have this field equal is waived for record classes. By default, all records will have this field equal to ``++0L++`` and there is no need to specify this field with ``++0L++`` value and it is possible to specify it with some custom value to support serialization/deserialization involving ordinary classes.
This rule raises an issue when there is a ``++private static final long serialVersionUID++`` field which is set to ``++0L++`` in a Record class.
== Noncompliant Code Example
----
record Person(String name, int age) implements Serializable {
@Serial
private static final long serialVersionUID = 0L; // Noncompliant
}
----
== Compliant Solution
----
record Person(String name, int age) implements Serializable {} // Compliant
record Person(String name, int age) implements Serializable {
@Serial
private static final long serialVersionUID = 42L; // Compliant
}
----
== See
* https://docs.oracle.com/javase/specs/jls/se15/preview/specs/records-jls.html#jls-8.10[Records specification]
* https://docs.oracle.com/en/java/javase/15/docs/specs/records-serialization.html#serialization-of-records[Serialization of records]