Skip to main content

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​

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringuidOptional. Value of the added serial version UID.42L

Example​

Parameters​
ParameterValue
uidnull
Before​
import java.io.Serializable;

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

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

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-static-analysis in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-static-analysis:2.9.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Tyler Van Gorder, Patrick, Sam Snyder, yuri, Jonathan Schnéider, Knut Wannheden, Tim te Beek, mrbitrary