github.com/FasterXML/jackson-datatype-hibernate @jackson-datatype-hibernate-parent-3.2.0

Project to build Jackson module to support JSON serialization and deserialization of Hibernate (https://hibernate.org) specific data types and properties; and features like lazy-loading.

Status

Module is usable and supported for Jackson 2.x and 3.x and used by non-trivial number of developers and projects.

Note: Hibernate 4.x, 5.x, 6.x and 7.x are supported but they require different jars, and Maven artifact names (and jar names differ).

This document refers to "Hibernate 5" version, but changes with 4.x/6.x/7.x should require little more than replacing "5" in names with "4", "6" or "7".

See also "Hibernate 5 Jakarta" variant (for Hibernate 5.5 and beyond); see below for more information.

JDK requirements

Java 17 or above is required.

Javax vs Jakarta

Due to changes related to Java EE to Jakarta EE transition (also known as "JAXB to Jakarta" etc etc), there are 2 variants of Hibernate 5 module:

• One that works with "old" JAXB/JavaEE APIs: jackson-datatype-hibernate5
• One that works with "new" Jakarta APIs: jackson-datatype-hibernate5-jakarta

Note that for Hibernate 4.x only old APIs matter; and for 6.x and later only new (Jakarta) APIs are used -- so there are no separate modules.

Usage

Maven dependency

To use module on Maven-based projects, use following dependency (with whatever is the latest version available):

<dependency>
  <groupId>tools.jackson.datatype</groupId>
  <artifactId>jackson-datatype-hibernate5</artifactId>
  <version>3.0.1</version>
</dependency>

or whatever version is most up-to-date at the moment;

Note that you need to use "jackson-datatype-hibernate4" for Hibernate 4.x.

<dependency>
  <groupId>tools.jackson.datatype</groupId>
  <artifactId>jackson-datatype-hibernate4</artifactId>
  <version>3.0.1</version>
</dependency>

if you plan to use Hibernate 5.5 with the Jakarta Persistence API 3.0; you will need the jakarta suffixed dependency for Hibernate 5.5:

<dependency>
  <groupId>tools.jackson.datatype</groupId>
  <artifactId>jackson-datatype-hibernate5-jakarta</artifactId>
  <version>3.0.1</version>
</dependency>

but you will need to use "jackson-datatype-hibernate6" for Hibernate 6.x: (for which only "jakarta" version exists).

<dependency>
  <groupId>tools.jackson.datatype</groupId>
  <artifactId>jackson-datatype-hibernate6</artifactId>
  <version>3.0.1</version>
</dependency>

and finally, for Hibernate 7.x

<dependency>
    <groupId>tools.jackson.datatype</groupId>
    <artifactId>jackson-datatype-hibernate7</artifactId>
    <version>3.0.1</version>
</dependency>

Registering module

Like all standard Jackson modules (libraries that implement Module interface), registration is done as follows:

ObjectMapper mapper = new ObjectMapper();
// for Hibernate 4.x:
mapper.registerModule(new Hibernate4Module());
// OR newer style
ObjectMapper mapper = JsonMapper.builder()
    .addModule(new Hibernate4Module()));
    .build();

// or, for Hibernate 5.x
ObjectMapper mapper = JsonMapper.builder()
    .addModule(new Hibernate5Module()));
    .build();

// or, for Hibernate 5.5+ with Jakarta
ObjectMapper mapper = JsonMapper.builder()
    .addModule(new Hibernate5JakartaModule()));
    .build();

// or, for Hibernate 6.x
ObjectMapper mapper = JsonMapper.builder()
    .addModule(new Hibernate6Module()));
    .build();

// or, for Hibernate 7.x
ObjectMapper mapper = JsonMapper.builder()
    .addModule(new Hibernate7Module()));
    .build();

after which functionality is available for all normal Jackson operations.

Avoiding infinite loops

• https://www.baeldung.com/jackson-bidirectional-relationships-and-infinite-recursion

Using with Spring MVC

Although more common way would be to register the module explicitly, it is alternatively possible to just sub-class ObjectMapper and register the module in constructor.

public class HibernateAwareObjectMapper extends ObjectMapper {
    public HibernateAwareObjectMapper() {
        // This for Hibernate 5; change 5 to 4 if you need to support
        // Hibernate 4 instead
        registerModule(new Hibernate5Module());
    }
}

Then add it as the objectmapper to be used

    <mvc:annotation-driven>
        <mvc:message-converters>

            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="objectMapper">
                    <bean class="path.to.your.HibernateAwareObjectMapper" />
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

If mvc:annotation-driven is not being used, it can be added as a jsonconverter to the messageconverters of RequestMappingHandlerAdapter.

Other

Project Wiki contains links to Javadocs and downloadable jars (from Central Maven repository).