Add @Serial annotation to all serialVersionUID fields.

- Enhance code readability and maintainability - Improve static analysis capabilities - Ensure proper declaration of serialVersionUID fields Closes #3584
spring-projects · Aug 20, 2024 · 2e6e1cf · 2e6e1cf
1 parent ccbe208
commit 2e6e1cf
Show file tree

Hide file tree

Showing 14 changed files with 33 additions and 15 deletions.
diff --git a/spring-data-envers/src/test/java/org/springframework/data/envers/sample/QCountry.java b/spring-data-envers/src/test/java/org/springframework/data/envers/sample/QCountry.java
@@ -23,14 +23,16 @@
 
 import static com.querydsl.core.types.PathMetadataFactory.forVariable;
 
+import java.io.Serial;
+
 /**
  * Query class for Country domain.
  *
  * @author Dmytro Iaroslavskyi
  */
 public class QCountry extends EntityPathBase<Country> {
 
-	private static final long serialVersionUID = -936338527;
+	@Serial private static final long serialVersionUID = -936338527;
 
 	private static final PathInits INITS = PathInits.DIRECT2;
 

diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/JpaSort.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/JpaSort.java
@@ -22,6 +22,7 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
+import java.io.Serial;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -39,7 +40,7 @@
  */
 public class JpaSort extends Sort {
 
-	private static final long serialVersionUID = 1L;
+	@Serial private static final long serialVersionUID = 1L;
 
 	private JpaSort(Direction direction, List<Path<?, ?>> paths) {
 		this(Collections.<Order>emptyList(), direction, paths);
@@ -316,7 +317,7 @@ public String toString() {
 	 */
 	public static class JpaOrder extends Order {
 
-		private static final long serialVersionUID = 1L;
+		@Serial private static final long serialVersionUID = 1L;
 
 		private final boolean unsafe;
 

diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/Specification.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/Specification.java
@@ -20,6 +20,7 @@
 import jakarta.persistence.criteria.Predicate;
 import jakarta.persistence.criteria.Root;
 
+import java.io.Serial;
 import java.io.Serializable;
 import java.util.Arrays;
 import java.util.stream.StreamSupport;
@@ -40,7 +41,7 @@
  */
 public interface Specification<T> extends Serializable {
 
-	long serialVersionUID = 1L;
+	@Serial long serialVersionUID = 1L;
 
 	/**
 	 * Negates the given {@link Specification}.

diff --git a/...in/java/org/springframework/data/jpa/repository/query/InvalidJpaQueryMethodException.java b/...in/java/org/springframework/data/jpa/repository/query/InvalidJpaQueryMethodException.java
@@ -15,6 +15,8 @@
  */
 package org.springframework.data.jpa.repository.query;
 
+import java.io.Serial;
+
 /**
  * Signals that we encountered an invalid query method.
  *
@@ -23,7 +25,7 @@
  */
 public class InvalidJpaQueryMethodException extends RuntimeException {
 
-	private static final long serialVersionUID = 1L;
+	@Serial private static final long serialVersionUID = 1L;
 
 	/**
 	 * Creates a new {@link InvalidJpaQueryMethodException} with the given message.

diff --git a/...pa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java b/...pa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java
@@ -31,6 +31,7 @@
 import jakarta.persistence.criteria.Predicate;
 import jakarta.persistence.criteria.Root;
 
+import java.io.Serial;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -952,7 +953,7 @@ private static long executeCountQuery(TypedQuery<Long> query) {
 	@SuppressWarnings("rawtypes")
 	private static final class ByIdsSpecification<T> implements Specification<T> {
 
-		private static final long serialVersionUID = 1L;
+		@Serial private static final long serialVersionUID = 1L;
 
 		private final JpaEntityInformation<T, ?> entityInformation;
 
@@ -981,7 +982,7 @@ public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuild
 	 */
 	private static class ExampleSpecification<T> implements Specification<T> {
 
-		private static final long serialVersionUID = 1L;
+		@Serial private static final long serialVersionUID = 1L;
 
 		private final Example<T> example;
 		private final EscapeCharacter escapeCharacter;

diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Account.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Account.java
@@ -15,6 +15,8 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
+
 import jakarta.persistence.Entity;
 
 import org.springframework.data.jpa.domain.AbstractPersistable;

diff --git a/...src/test/java/org/springframework/data/jpa/domain/sample/EmbeddedIdExampleEmployeePK.java b/...src/test/java/org/springframework/data/jpa/domain/sample/EmbeddedIdExampleEmployeePK.java
@@ -15,6 +15,7 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 import jakarta.persistence.Column;
@@ -25,7 +26,7 @@
  */
 @Embeddable
 public class EmbeddedIdExampleEmployeePK implements Serializable {
-	private static final long serialVersionUID = 1L;
+	@Serial private static final long serialVersionUID = 1L;
 
 	@Column(nullable = false) private Long employeeId;
 

diff --git a/...pa/src/test/java/org/springframework/data/jpa/domain/sample/IdClassExampleEmployeePK.java b/...pa/src/test/java/org/springframework/data/jpa/domain/sample/IdClassExampleEmployeePK.java
@@ -15,13 +15,14 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 /**
  * @author Thomas Darimont
  */
 public class IdClassExampleEmployeePK implements Serializable {
-	private static final long serialVersionUID = 1L;
+	@Serial private static final long serialVersionUID = 1L;
 
 	private long empId;
 	private long department;

diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/ItemId.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/ItemId.java
@@ -15,6 +15,7 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 /**
@@ -25,7 +26,7 @@
  */
 public class ItemId implements Serializable {
 
-	private static final long serialVersionUID = -2986871112875450036L;
+	@Serial private static final long serialVersionUID = -2986871112875450036L;
 
 	private Integer id;
 	private Integer manufacturerId;

diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/ItemSiteId.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/ItemSiteId.java
@@ -15,6 +15,7 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 /**
@@ -25,7 +26,7 @@
  */
 public class ItemSiteId implements Serializable {
 
-	private static final long serialVersionUID = 1822540289216799357L;
+	@Serial private static final long serialVersionUID = 1822540289216799357L;
 
 	private ItemId item;
 	private Integer site;

diff --git a/...pa/src/test/java/org/springframework/data/jpa/domain/sample/PersistableWithIdClassPK.java b/...pa/src/test/java/org/springframework/data/jpa/domain/sample/PersistableWithIdClassPK.java
@@ -17,6 +17,7 @@
 
 import static org.springframework.util.ObjectUtils.*;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 /**
@@ -25,7 +26,7 @@
  */
 public class PersistableWithIdClassPK implements Serializable {
 
-	private static final long serialVersionUID = 23126782341L;
+	@Serial private static final long serialVersionUID = 23126782341L;
 
 	private Long first;
 	private Long second;

diff --git a/.../test/java/org/springframework/data/jpa/domain/sample/PersistableWithSingleIdClassPK.java b/.../test/java/org/springframework/data/jpa/domain/sample/PersistableWithSingleIdClassPK.java
@@ -17,14 +17,15 @@
 
 import static org.springframework.util.ObjectUtils.*;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 /**
  * @author Mark Paluch
  */
 public class PersistableWithSingleIdClassPK implements Serializable {
 
-	private static final long serialVersionUID = 23126782341L;
+	@Serial private static final long serialVersionUID = 23126782341L;
 
 	private Long first;
 

diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleEntityPK.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleEntityPK.java
@@ -15,6 +15,7 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
 import java.io.Serializable;
 
 import jakarta.persistence.Column;
@@ -25,7 +26,7 @@
 @Embeddable
 public class SampleEntityPK implements Serializable {
 
-	private static final long serialVersionUID = 231060947L;
+	@Serial private static final long serialVersionUID = 231060947L;
 
 	@Column(nullable = false)
 	private String first;

diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Site.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Site.java
@@ -15,6 +15,8 @@
  */
 package org.springframework.data.jpa.domain.sample;
 
+import java.io.Serial;
+
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.Id;
@@ -31,7 +33,7 @@
 @Table
 public class Site implements java.io.Serializable {
 
-	private static final long serialVersionUID = 1L;
+	@Serial private static final long serialVersionUID = 1L;
 
 	@Id @GeneratedValue Integer id;