A logo showing the text blog.marcnuri.com
Español
Home»Tools»How to generate a serialVersionUID in IntelliJ IDEA

Recent Posts

  • Fabric8 Kubernetes Client 7.2 is now available!
  • Connecting to an MCP Server from JavaScript using AI SDK
  • Connecting to an MCP Server from JavaScript using LangChain.js
  • The Future of Developer Tools: Adapting to Machine-Based Developers
  • Connecting to a Model Context Protocol (MCP) Server from Java using LangChain4j

Categories

  • Artificial Intelligence
  • Front-end
  • Go
  • Industry and business
  • Java
  • JavaScript
  • Legacy
  • Operations
  • Personal
  • Pet projects
  • Tools

Archives

  • May 2025
  • April 2025
  • March 2025
  • February 2025
  • January 2025
  • December 2024
  • November 2024
  • August 2024
  • June 2024
  • May 2024
  • April 2024
  • March 2024
  • February 2024
  • January 2024
  • December 2023
  • November 2023
  • October 2023
  • September 2023
  • August 2023
  • July 2023
  • June 2023
  • May 2023
  • April 2023
  • March 2023
  • February 2023
  • January 2023
  • December 2022
  • November 2022
  • October 2022
  • September 2022
  • August 2022
  • July 2022
  • June 2022
  • May 2022
  • March 2022
  • February 2022
  • January 2022
  • December 2021
  • November 2021
  • October 2021
  • September 2021
  • August 2021
  • July 2021
  • January 2021
  • December 2020
  • November 2020
  • October 2020
  • September 2020
  • August 2020
  • July 2020
  • June 2020
  • May 2020
  • February 2020
  • January 2020
  • December 2019
  • October 2019
  • September 2019
  • July 2019
  • March 2019
  • November 2018
  • July 2018
  • June 2018
  • May 2018
  • April 2018
  • March 2018
  • February 2018
  • December 2017
  • July 2017
  • January 2017
  • December 2015
  • November 2015
  • December 2014
  • March 2014
  • February 2011
  • November 2008
  • June 2008
  • May 2008
  • April 2008
  • January 2008
  • November 2007
  • September 2007
  • August 2007
  • July 2007
  • June 2007
  • May 2007
  • April 2007
  • March 2007

How to generate a serialVersionUID in IntelliJ IDEA

2021-10-17 in Tools tagged IntelliJ IDEA / Java by Marc Nuri | Last updated: 2021-10-25
Versión en Español

Ever since the appearance of Jackson, GSON, and others, Java serialization has lost popularity. Many of these libraries don't even require that your classes implement the Serializable interface. However, it's still a good idea to implement this interface in your Model classes. Frameworks such as Apache Wicket still require it.

Providing a serialVersionUID field is not strictly required, but is highly recommended to declare it when implementing the Serializable interface (Java Serialization). This field is used to enforce compatibility checks when deserializing a serialized object and verify that the object is compatible with the loaded class.

IntelliJ can generate this field for us whenever a class implements the Serializable interface.

How to generate the serialVersionUID field with an IntelliJ plugin?

IntelliJ's marketplace offers a few plugins that implement this feature. I'm using the GenerateSerialVersionUID, which was the only one available when I needed this feature a few years ago. However, there are plenty of alternatives now.

A screenshot of the action pop-up featuring the SerialVersionUID entry
A screenshot of the action pop-up featuring the SerialVersionUID entry

Once you've enabled this plugin, you just need to press Alt+Insert/Command+n when you are in the body of a class implementing the Serializable interface. You should see an option to generate the serialVersionUID field for you.

How to generate serialVersionUID with IntelliJ's built-in features?

If you don't want to install any plugin, IntelliJ has some built-in features that you can enable and use to generate the serialVersionUID field. There is a Serializable inspection that has a quick-fix intention that we can take advantage of.

The first step is to enable the inspection in the settings dialog. Open Settings dialog (Ctrl+Alt+S) and navigate to the Editor | Inspections tab.

IntelliJ IDEA Reference / Settings / Editor / Inspections
IntelliJ IDEA Reference / Settings / Editor / Inspections

With the inspection enabled, a warning is displayed whenever a Serializable class doesn't declare a serialVersionUID field. IntelliJ can now generate the field if you place the cursor on top of the warning. You can then press Alt+Enter and select the Add 'serialVersionUID' field option.

Add 'serialVersionUID' field IntelliJ IDEA intention
Add 'serialVersionUID' field IntelliJ IDEA intention

References

  • java.io.Serializable Javadoc
  • IntelliJ IDEA Reference / Code Inspections / Inspections in detail / List of Java inspections / Serialization issues
Twitter iconFacebook iconLinkedIn iconPinterest iconEmail icon

Post navigation
Eclipse JKube 1.5.1 is now available!How to convert an Iterator or Spliterator to Stream
© 2007 - 2025 Marc Nuri