Скачать или смотреть Spring Boot Enum JSON Serializer

Learn how to serialize enums in Spring Boot to create the desired JSON format using derived properties in your DTOs.
---
This video is based on the question https://stackoverflow.com/q/64771483/ asked by the user 'Mateusz Sobczak' ( https://stackoverflow.com/u/5168582/ ) and on the answer https://stackoverflow.com/a/64771923/ provided by the user 'Andreas' ( https://stackoverflow.com/u/5221149/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Spring Boot enum JSON serializer

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Spring Boot Enum JSON Serializer: A Complete Guide

Working with enums in Java, especially in the context of JSON serialization using Spring Boot, can sometimes be challenging. In this guide, we’ll explore how to convert a specific Java object, which includes an enum, into the desired JSON format. We will break down the problem and provide a clear solution to achieve the output you need.

The Problem

Let’s say you have a Java class TestDto that contains an enum ResponseType. You want to serialize this class into a JSON format that includes specific properties derived from the enum. An example of the JSON response you aim to create is as follows:

[[See Video to Reveal this Text or Code Snippet]]

In this JSON:

The code field points to the name of the enum (e.g., TEST1),

The message field retrieves the corresponding message from the enum.

The Solution

To achieve this, we can create derived getters and setters in the TestDto class while suppressing the actual serialization of the enum field. Let’s break this down into clear steps.

Step 1: Modify the TestDto Class

Start by adding the necessary derived properties to handle the conversion. Below is a modified version of the TestDto class:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Create and Test the Serialization

Next, here’s how you can create an instance of TestDto, set the properties, and then use Jackson’s ObjectMapper to serialize it into JSON:

[[See Video to Reveal this Text or Code Snippet]]

Expected Output

When you run the above code, you should see an output like this:

[[See Video to Reveal this Text or Code Snippet]]

And for the console output after deserialization:

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

By following these steps, you can effectively serialize enums within Spring Boot into a JSON format that meets specific requirements. The key takeaway in this approach is the use of derived properties to control how data is presented in the output format.

With this knowledge, you can now confidently handle enum serialization in your Spring Boot applications!