Skip to content

Enable custom Serial Version UID #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timtebeek merged 3 commits into from
May 4, 2025
Merged

Enable custom Serial Version UID #541

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
337b4b6
Enable custom Serial Version UID
yuri1969 May 4, 2025
506ce1a
Apply suggestions from code review
timtebeek May 4, 2025
dd0a436
Minor polish
timtebeek May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added rewrite.yml
View file
Open in desktop
Empty file.
21 changes: 19 additions & 2 deletions src/main/java/org/openrewrite/staticanalysis/AddSerialVersionUidToSerializable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
*/
package org.openrewrite.staticanalysis;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.internal.ListUtils;
Expand All @@ -32,8 +34,19 @@
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;

@Value
@EqualsAndHashCode(callSuper = false)
public class AddSerialVersionUidToSerializable extends Recipe {

@Option(displayName = "New serial version UID",
description = "Value of the added serial version UID.",
example = "42L",
required = false)
@Nullable
String uid;

private static final String DEFAULT_NEW_UID = "1";

@Override
public String getDisplayName() {
return "Add `serialVersionUID` to a `Serializable` class when missing";
Expand All @@ -54,7 +67,11 @@ public Set<String> getTags() {
@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return new JavaIsoVisitor<ExecutionContext>() {
final JavaTemplate template = JavaTemplate.builder("private static final long serialVersionUID = 1;").build();
final String newUid = uid != null ? uid : DEFAULT_NEW_UID;
final JavaTemplate template = JavaTemplate.builder(
String.format("private static final long serialVersionUID = %s;", newUid)
)
.build();

@Override
public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) {
Expand Down Expand Up @@ -103,7 +120,7 @@ private J.VariableDeclarations maybeFixVariableDeclarations(J.VariableDeclaratio
varDecls = varDecls.withModifiers(Arrays.asList(
new J.Modifier(Tree.randomId(), Space.EMPTY, Markers.EMPTY, null, J.Modifier.Type.Private, Collections.emptyList()),
new J.Modifier(Tree.randomId(), Space.SINGLE_SPACE, Markers.EMPTY, null, J.Modifier.Type.Static, Collections.emptyList()),
new J.Modifier(Tree.randomId(), Space.SINGLE_SPACE, Markers.EMPTY, null, J.Modifier.Type.Final, Collections.emptyList())
new J.Modifier(Tree.randomId(), Space.SINGLE_SPACE, Markers.EMPTY, null, J.Modifier.Type.Final, Collections.emptyList())
));
}
if (TypeUtils.asPrimitive(varDecls.getType()) != JavaType.Primitive.Long) {
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/openrewrite/staticanalysis/AddSerialAnnotationToSerialVersionUIDTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ class Example implements Serializable {
void shouldAddToNewFieldWhenChained() {
rewriteRun(
spec -> spec.recipes(
new AddSerialVersionUidToSerializable(),
new AddSerialVersionUidToSerializable(null),
new AddSerialAnnotationToSerialVersionUID()),
//language=java
java(
Expand Down
49 changes: 48 additions & 1 deletion src/test/java/org/openrewrite/staticanalysis/AddSerialVersionUidToSerializableTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class AddSerialVersionUidToSerializableTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec.recipe(new AddSerialVersionUidToSerializable());
spec.recipe(new AddSerialVersionUidToSerializable(null));
}

@DocumentExample
Expand Down Expand Up @@ -57,6 +57,34 @@ public class Example implements Serializable {
);
}

@DocumentExample
@Test
void addCustomSerialVersionUID() {
rewriteRun(
spec -> spec.recipe(new AddSerialVersionUidToSerializable("1L")),
//language=java
java(
"""
import java.io.Serializable;

public class Example implements Serializable {
private String fred;
private int numberOfFreds;
}
""",
"""
import java.io.Serializable;

public class Example implements Serializable {
private static final long serialVersionUID = 1L;
private String fred;
private int numberOfFreds;
}
"""
)
);
}

@Test
void doNothingNotSerializable() {
rewriteRun(
Expand Down Expand Up @@ -171,6 +199,25 @@ public class Example implements Serializable {
);
}

@Test
void customUidKeepsUidAlreadyPresent() {
rewriteRun(
spec -> spec.recipe(new AddSerialVersionUidToSerializable("1L")),
//language=java
java(
"""
import java.io.Serializable;

public class Example implements Serializable {
private static final long serialVersionUID = 1;
private String fred;
private int numberOfFreds;
}
"""
)
);
}

@Test
void methodDeclarationsAreNotVisited() {
rewriteRun(
Expand Down