jackson-playground

📚 Learning and exploring Jackson https://github.com/FasterXML/jackson.

Description

NOTE: This project was developed on macOS. It is for my own personal use.

This project explores the Jackson (https://github.com/FasterXML/jackson) umbrella of serialization/deserialization libraries which are often a core component of a Java application that deals with JSON. For example, it illustrates how to use the new Records Java language feature https://openjdk.java.net/jeps/359 with Jackson.

A number of Jackson projects are included in this project as Git submodules because we want to use the latest "edge version" of Jackson to get the latest and greatest features. After all, a "📚 Learning and exploring" repository is often about learning new things! These Jackson projects must be built locally and saved to your local maven repository (a.k.a the .m2/directory or mavenLocal() in Gradle terminology). Instructions to build these projects are in Instructions.

Instructions

Follow these instructions to build the project and run the demo programs:

1. Pre-requisite: Java 20
2. After cloning the repo for the first time, you need to also clone the submodules:

   • git submodule update --init --recursive

3. Update the submodules
   • If you had previously cloned the project and now want to update the submodules, then use the following command.

   • git submodule update --remote

4. Build the "edge version" of the Jackson artifacts:

   • ./build-jackson-artifacts.sh

5. Generate some test data (some of the tests depend on this):

   • ./generate-test-data.sh

6. Build the project and execute the tests:

   • ./gradlew build

7. (Optional) If the tests had previously run and passed and no source code has changed then Gradle might choose to skip your tests when you would otherwise prefer to actually have your tests execute. Force Gradle to run the tests cleaning them out and then running the tests:

   • ./gradlew cleanTest

   • ./gradlew build

   • or,

     ./gradlew test

Wish List

General clean-ups, TODOs and things I wish to implement for this project:

• DONE Use Jackson's CSV support for serializing
• DONE Use Jackson's CSV support for deserializing
• DONE Experiment with serializing from Records to a string, not just deserializing from a string into Records
• DONE Migrate to Gradle's Kotlin DSL (use https://github.com/dgroomes/gradle-playground as reference)
• DONE Generate "Points" (x,y) in the test data generation script instead of the arbitrary "DummyType" type
• (this was already done? I just have a hard time understanding git submodules like most folks) Fix on a specific commit in the submodules instead of "master"

Reference

• Pro Git Chapter 7.11: Git Tools - Submodules
• jackson-dataformats-text: Limitations

  Due to the tabular nature of CSV format, deeply nested data structures are not well supported.