Course contentsShow
← Java
Lesson 2124 of 2,87042. SerializationFree lesson

Declaring an Explicit serialVersionUID

Learn the syntax and conventions for explicitly declaring serialVersionUID as a static final long.

Declaring an Explicit serialVersionUID

What you'll learn: How to explicitly declare a serialVersionUID field in your serializable classes using the correct syntax and naming conventions.


The Proper Declaration Syntax

While Java can compute a default serialVersionUID for you, best practice dictates that you should always declare one explicitly. This gives you control over version compatibility and avoids subtle bugs.

The declaration follows a strict pattern:

private static final long serialVersionUID = 1L;

Let's break down each part:

  • private: The field should be private (not accessible outside the class)
  • static: Belongs to the class itself, not instances
  • final: The value cannot be changed after initialization
  • long: Must be a 64-bit integer type
  • Name: Must be exactly serialVersionUID (case-sensitive)
  • Value: Conventionally starts at 1L (the L suffix indicates a long literal)

A Complete Example

import java.io.Serializable;

public class Employee implements Serializable {
    private static final long serialVersionUID = 1L;
    
    private String name;
    private int id;
    
    public Employee(String name, int id) {
        this.name = name;
        this.id = id;
    }
}

Think of It Like a Version Label

Imagine putting a version sticker on a filing cabinet. When you need to open it later, you check: "Does my key match this cabinet's version?" The serialVersionUID is that sticker—it tells Java, "This is version 1 of the Employee class."

If you later modify the class and want to maintain compatibility, keep the same number. If you make breaking changes, increment it to 2L.

Key Takeaway: Always declare serialVersionUID as private static final long serialVersionUID = 1L; in every Serializable class to maintain explicit version control and avoid default computation inconsistencies.