addserialversionuidtoserializable.md

Add serialVersionUID to a Serializable class when missing

org.openrewrite.staticanalysis.AddSerialVersionUidToSerializable

A serialVersionUID field is strongly recommended in all Serializable classes. If this is not defined on a Serializable class, the compiler will generate this value. If a change is later made to the class, the generated value will change and attempts to deserialize the class will fail.

Tags

• RSPEC-2057

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-static-analysis
• version: 1.0.1

Example

{% tabs %} {% tab title="Example.java" %}

Before

{% code title="Example.java" %}

import java.io.Serializable;

public class Example implements Serializable {
    private String fred;
    private int numberOfFreds;
}

{% endcode %}

After

{% code title="Example.java" %}

import java.io.Serializable;

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

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- Example.java
+++ Example.java
@@ -4,0 +4,1 @@

public class Example implements Serializable {
+   private static final long serialVersionUID = 1;
    private String fred;

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-static-analysis:1.0.1 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("org.openrewrite.staticanalysis.AddSerialVersionUidToSerializable")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-static-analysis:1.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.staticanalysis.AddSerialVersionUidToSerializable</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-static-analysis</artifactId>
            <version>1.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-static-analysis:RELEASE \
  -Drewrite.activeRecipes=org.openrewrite.staticanalysis.AddSerialVersionUidToSerializable

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Tyler Van Gorder
• Patrick
• Sam Snyder
• Knut Wannheden
• Kun Li
• mrbitrary
• Jonathan Schneider

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.