vladmihalcea / hypersistence-utils

The Hypersistence Utils library (previously known as Hibernate Types) gives you Spring and Hibernate utilities that can help you get the most out of your data access layer.

Migrating to version 3

The project name was changed from Hibernate Types to Hypersistence Utils because the scope of the project is much broader now, offering Spring utilities as well.

For this reason, when migrating from the Hibernate Types 2.x to Hypersistence Utils 3.x, you will need to follow these steps:

1. First, you will need to change your Maven or Gradle dependency, as illustrated by the Installation Guide.
2. Second, you will need to change the package name from com.vladmihalcea.hibernate to io.hypersistence.utils.hibernate.
3. Third, you will need to change the package name from com.vladmihalcea.spring to io.hypersistence.utils.spring.

That's it!

Introduction

The Hypersistence Utils project gives you general-purpose utilities for both Spring and Hibernate.

The main advantage of this project is that it supports a broad range of Hibernate versions, spanning from Hibernate ORM 6.4, 6.3 to 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, and Hibernate 5.2.

Installation Guide

Depending on the Hibernate version you are using, you need to add the following dependency:

Hibernate 6.4 and 6.3

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-utils-hibernate-63</artifactId>
    <version>3.7.4</version>
</dependency>

Hibernate 6.2

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-utils-hibernate-62</artifactId>
    <version>3.7.4</version>
</dependency>

Hibernate 6.1 and 6.0

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-utils-hibernate-60</artifactId>
    <version>3.7.4</version>
</dependency>

Hibernate 5.6 and 5.5

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-utils-hibernate-55</artifactId>
    <version>3.7.4</version>
</dependency>

Hibernate 5.4, 5.3 and 5.2

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-utils-hibernate-52</artifactId>
    <version>3.7.4</version>
</dependency>

Optional Maven Dependencies

The Hypersistence Utils project defines a list of optional dependencies that you will have to declare explicitly in your project in order to use them.

The reason why all these dependencies are optional, like Guava, Jackson, or PostgreSQL JDBC Driver, is that not all projects may need them.

Moreover, the dependency version is extremely important because, from time to time, security issues may be discovered that get fixed in newer versions.

So, relying on this library to supply you with the dependency versions is a very dangerous thing to do.

For instance, there have been 65 security issues discovered in the Jackson Data Bind library this project is heavily relying on.

To avoid risking security issues, you need to take the responsibility of constantly upgrading all the dependencies that you are using along with the Hypersistence Utils library.

JSON Optional Maven Dependencies

If you are using JSON Types, then you might be interested in setting the following dependencies based on your Hibernate version:

Hibernate 6

<dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-module-jakarta-xmlbind-annotations</artifactId>
    <version>${jackson-module-jakarta-xmlbind-annotation}</version>
</dependency>

Hibernate 5

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>${jackson-databind.version}</version>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-module-jaxb-annotations</artifactId>
    <version>${jackson-module-jaxb-annotation}</version>
</dependency>

Guava Optional Maven Dependency

If you are mapping a Range using Guava, then you have to provide the Guava dependency explicitly:

<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>${guava.version}</version>
</dependency>

Java Money and Currency API Optional Maven Dependency

If you are mapping a MonetaryAmount, then you have to provide the Moneta dependency explicitly:

<dependency>
    <groupId>org.javamoney</groupId>
    <artifactId>moneta</artifactId>
    <version>${moneta.version}</version>
    <type>pom</type>
</dependency>

PostgreSQL Optional Maven Dependency

If you are mapping a PostgreSQL-specific column type (e.g., inet, hstore, array, interval), then you have to provide the PostgreSQL dependency explicitly:

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>${postgresql.version}</version>
</dependency>

Features

JSON

Generic JSON Type

The JsonType allows you to map JSON column types, no matter if you're using Oracle, SQL Server, PostgreSQL or MySQL.

Hibernate 6

If you're using Hibernate 6, you can map any JSON column to Map, List, POJO, String, or JsonNode entity property:

@Type(JsonType.class)
private Map<String, String> properties = new HashMap<>();

Hibernate 5

If you're using Hibernate 5, you can either provide the fully-qualified name of the Hibernate Type:

@Type(type = "io.hypersistence.utils.hibernate.type.json.JsonType")

Or, you can add the following mapping to your package-info.java class in the same package where your JPA entities are located:

@TypeDef(
    name = "json", typeClass = JsonType.class
)
package io.hypersistence.optimizer;

import io.hypersistence.utils.hibernate.type.json.JsonType;
import org.hibernate.annotations.TypeDef;

Later, you can map the Map, List, POJO, String, or JsonNode entity properties to JSON columns like this:

@Type(type = "json")
private Map<String, String> properties = new HashMap<>();

For more details, check out this article.

Best Practices

When mapping a JSON column type to a POJO, List<POJO> or Map<String, POJO>, you need to make sure that the POJO type overrides the default equals and hashCode methods and implements them according to the JSON object content.

Otherwise, the Hibernate dirty checking mechanism may trigger unexpected UPDATE statements. Check out the #134 issue for more details.

Database-specific JSON types

Oracle

When using Oracle, you have several options:

• you can use the generic JsonType that can work with the JSON, VARCHAR, or BLOB column types, as long as you hint the column type using the columnDefinition attribute of the JPA @Column annotation.
• you can use the JsonStringType to map a VARCHAR2 column type storing JSON.
• you can use the JsonBlobType to map a BLOB column type storing JSON.

For more details, check out this article.

SQL Server

When using SQL Server, you can use the generic JsonType or the JsonStringType to map an NVARCHAR column type storing JSON.

For more details, check out this article.

PostgreSQL

When using PostgreSQL, you can use the generic JsonType or the JsonBinaryType to map both jsonb and json column types.

For more details, check out this article.

MySQL

When using MySQL, you can use the generic JsonType or the JsonStringType to map the json column type.

For more details, check out this article.

JSON mapping examples

• How to map a POJO to a JSON column using JPA and Hibernate
• How to map a String JPA property to a JSON column using Hibernate
• How to map a Jackson JsonNode to a JSON column
• How to map JSON collections using JPA and Hibernate
• How to map a Java Map entity property as a JSON column with JPA and Hibernate
• How to map Java Records to JSON columns using Hibernate
• How to map polymorphic JSON objects with JPA and Hibernate
• How to encrypt and decrypt JSON properties with JPA and Hibernate
• Why you should use Hibernate Dynamic Update for JSON properties
• How to map Oracle JSON columns using JPA and Hibernate
• How to map SQL Server JSON columns using JPA and Hibernate
• How to customize the Jackson ObjectMapper used by Hypersistence Utils
• How to customize the JSON Serializer used by Hypersistence Utils
• How to fix the Hibernate No Dialect mapping for JDBC type: 1111 issue when mixing JSON types with native SQL queries
• How to fix the column is of type jsonb but expression is of type record or bytea issue

ARRAY

• How to map a PostgreSQL ARRAY to a Java List with JPA and Hibernate
• How to map the PostgreSQL ARRAY to Java Arrays with JPA and Hibernate
• Multidimensional array mapping with JPA and Hibernate
• How to map the HSQLDB ARRAY type with JPA and Hibernate

PostgreSQL Types (e.g. ENUM, INET, HSTORE, RANGE)

• Java Enum to PostgreSQL Enum Type
• How to map the PostgreSQL Inet type with JPA and Hibernate
• How to map a PostgreSQL HStore entity property with JPA and Hibernate
• How to map a PostgreSQL Enum ARRAY to a JPA entity property using Hibernate
• How to map a PostgreSQL Range column type with JPA and Hibernate
• How to map a PostgreSQL Interval to a Java Duration with Hibernate

Generic Types

• The best way to map MonetaryAmount with JPA and Hibernate
• How to map java.time.YearMonth to DATE or INTEGER column
• How to map java.time.Year and java.time.Month with JPA and Hibernate
• Character to nullable CHAR column
• ImmutableType utility to simplify UserType implementations

Utilities

Spring

• The awesome BaseJpaRepository
• The best Spring Data JpaRepository
• The Spring Data findAll Anti-Pattern
• The Spring @Retry annotation to automatically retry on failure

BaseJpaRepository

The BaseJpaRepository is a much better alternative to the default Spring Data JpaRepository because it does not provide a findAll method or a save method that makes no sense in JPA terminology.

To use the BaseJpaRepository utility, make sure that you provide the repositoryBaseClass attribute in the @EnableJpaRepositories configuration to reference the BaseJpaRepositoryImpl from the Hypersistence Utils project:

@Configuration
@EnableJpaRepositories(
    value = "your.repository.package",
    repositoryBaseClass = BaseJpaRepositoryImpl.class
)
public class JpaConfiguration {
    ...
}

The your.repository.package is the Java package of your Spring repositories.

HibernateRepository

While the BaseJpaRepository is to be preferred, in case you need to use the default JpaRepository, then you can at least extend the HibernateRepository as well to deprecate the methods that may cause problems.

To use the HibernateRepository, make sure that you include the io.hypersistence.utils.spring.repository package in your @EnableJpaRepositories configuration:

@Configuration
@EnableJpaRepositories(
    value = {
        "io.hypersistence.utils.spring.repository",
        "your.repository.package",
        ...
    }
)
public class JpaConfiguration {
    ...
}

The your.repository.package is the Java package of your Spring repositories.

Identifier Generators

• BatchSequenceGenerator - Hibernate Batch Sequence Generator

Naming Strategy

• CamelCaseToSnakeCaseNamingStrategy - How to map camelCase properties to snake_case column names with Hibernate

DTO Projection and ResultTransformer

• ClassImportIntegrator - How to write a compact DTO projection query with JPA
• ListResultTransformer - The best way to use a Hibernate ResultTransformer
• MapResultTransformer - How to return a Map result from a JPA or Hibernate query

SQL Statement Count Validator

• SQLStatementCountValidator - How to detect the Hibernate N+1 query problem during testing

Query Utilities

• SQLExtract - How to get the SQL query from JPQL or JPA Criteria
• QueryStackTraceLogger - How to find the source of an SQL query generated by Hibernate

Requirements

• Java version supported by the Hibernate ORM version you are using.
• SLF4J
• Jackson Databind

Bug fixes and enhancements

This project is Free, as in Libre, not Gratis.

There is no free-of-charge support. Only the source code and the binaries are available for free.

If you need assistance with a given issue, you will need to purchase either the Coaching Basic or the Coaching Pro programs.

Providing your own fix

Besides the Paid support options, you have the option of providing your own fix. For that, here's what you need to do:

1. Provide a replicating test case using the existing test cases as a template
2. Provide a fix proposal
3. Send a Pull Request with the fix proposal and the test case

However, due to lack of time, I will review the submitted Pull Requests from time to time, so you may need to wait several months until the Pull Request is reviewed and integrated.

Are you struggling with application performance issues?

Imagine having a tool that can automatically detect if you are using JPA and Hibernate properly. No more performance issues, no more having to spend countless hours trying to figure out why your application is barely crawling.

Imagine discovering early during the development cycle that you are using suboptimal mappings and entity relationships or that you are missing performance-related settings.

More, with Hypersistence Optimizer, you can detect all such issues during testing and make sure you don't deploy to production a change that will affect data access layer performance.

Hypersistence Optimizer is the tool you've been long waiting for!

Training

If you are interested in on-site training, I can offer you my High-Performance Java Persistence training, which can be adapted to one, two or three days of sessions. For more details, check out my website.

Consulting

If you want me to review your application and provide insight into how you can optimize it to run faster, then check out my consulting page.

High-Performance Java Persistence Video Courses

If you want the fastest way to learn how to speed up a Java database application, then you should definitely enroll in my High-Performance Java Persistence video courses.

High-Performance Java Persistence Book

Or, if you prefer reading books, you are going to love my High-Performance Java Persistence book as well.

Contributing Guide

The project uses Maven Toolchains as different modules are compiled and tested using different Java versions.

Hypersistence Utils 6 requires Java 11 while the other modules are compiled with Java 8.

To see how to configure Maven Toolchains, check out this article.

The project uses various database systems for integration testing, and you can configure the JDBC connection settings using the DatasourceProvider instances (e.g., PostgreSQLDataSourceProvider), and the project uses Testcontainers to bootstrap a Docker container with the required Oracle, SQL Server, PostgreSQL, or MySQL instance on demand.

If you are a regular contributor, it's advisable to set up the required database locally or use the Docker Compose configuration provided in the docker folder, as bootstrapping the containers on demand is slower, and your tests are going to take longer to run.

If you want to fix an issue or add support for a new feature, please provide the associated integration test case that proves the improvement is working as expected.