Скачать или смотреть Solving the Java 14 records JSON Serialization Issue with org.json

Discover how to work around the `Java 14 records` problem when creating JSON objects with the org.json library. Learn to implement a custom converter for seamless integration.
---
This video is based on the question https://stackoverflow.com/q/72672489/ asked by the user 'Lukas' ( https://stackoverflow.com/u/709556/ ) and on the answer https://stackoverflow.com/a/72673008/ provided by the user 'catch23' ( https://stackoverflow.com/u/1498427/ ) 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: Java 14 records with org.json

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.
---
Understanding the Java 14 Records and org.json Issue

As developers, we often encounter challenges when using new features in our programming languages alongside existing libraries. A common problem that has arisen is with Java 14 records and their interaction with the org.json library.

Imagine you're trying to create a new JSON object using the org.json library and you find that the fields are returning null. This scenario typically arises due to how Java records generate their accessors. Unlike traditional Java classes that use getters (like getXYZ()), Java records provide access via their field names directly. This can lead to confusion and headaches, especially when you're not using a library that understands these constructs effectively.

Issue at Hand

When you try to serialize a Java record to JSON, you might run into an unexpected outcome. Here’s the example:

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

Instead of returning the expected JSON object that represents the Order, you get an empty JSON object, like this:

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

Why the Issue Occurs

This issue occurs because the org.json library does not recognize that the fields of a Java record should be treated as properties. It cannot find the old-style getter methods and, as a result, returns null values for each field.

Crafting a Solution: Custom JSON Converter

If you’d like to sidestep using libraries like Jackson or Gson — which are popular solutions for handling JSON but may not be suitable for all projects — you can create your own converter to handle this situation.

Step-by-Step: Writing Your Custom Converter

Create a new class known as JsonConverter.

Implement a static method called toJSON that takes an object and converts it to a JSON string.

Here’s how it looks:

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

Using the Converter

Once you've set up your converter, you can serialize your Order record as follows:

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

Example Output

When you run this snippet, the output should be:

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

The output from your custom converter reveals all the expected values from your record — solving the problem without the need for external libraries.

Conclusion

In summary, while using org.json with Java 14 records may present challenges due to differences in how data is accessed, creating a simple converter can effectively bridge this gap. Implementing the JsonConverter class allows for seamless JSON serialization, retaining all the benefits of Java records without compromising on functionality.

Now, you can confidently stay in the Java ecosystem while utilizing the power of JSON!