repository·master·Indexed 25 days ago
https://github.com/vladmihalcea/hypersistence-utilsGeneral-purpose utilities for Spring and Hibernate providing advanced mapping for complex types such as JSON, arrays, and PostgreSQL-specific types. It supports a wide range of Hibernate versions (5.0 through 7.4) and includes features like the @Tsid annotation for time-sorted identifiers, BaseJpaRepository for Spring Data JPA, and StatelessSessionUtil for synchronized Hibernate StatelessSessions.
To migrate from the older Hibernate Types (2.x) to Hypersistence Utils (3.x), follow these three steps:
com.vladmihalcea.hibernate to io.hypersistence.utils.hibernate.com.vladmihalcea.spring to io.hypersistence.utils.spring.If you must use the default JpaRepository, you can extend HibernateRepository to deprecate methods that cause issues.
To enable this, you must 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 BaseJpaRepository is an alternative to the default Spring Data JpaRepository. It avoids problematic methods like findAll() (which can cause performance issues) and save() (which doesn't align with JPA semantics).
To use it, configure your @EnableJpaRepositories to use BaseJpaRepositoryImpl as the repositoryBaseClass:
@Configuration
@EnableJpaRepositories(
value = "your.repository.package",
repositoryBaseClass = BaseJpaRepositoryImpl.class
)
public class JpaConfiguration {
...
}Add the dependency corresponding to your specific Hibernate version. Note that some versions require commercial support.
| Hibernate Version | Maven Artifact ID | Recommended Version |
|---|---|---|
| 7.4, 7.3 | hypersistence-utils-hibernate-73 | 3.15.4 |
| 7.2, 7.1 | hypersistence-utils-hibernate-71 | 3.15.4 |
| 7.0 | hypersistence-utils-hibernate-70 | 3.15.4 (Commercial) |
| 6.6, 6.5, 6.4, 6.3 | hypersistence-utils-hibernate-63 | 3.15.4 |
| 6.2 | hypersistence-utils-hibernate-62 | 3.9.4 (Commercial) |
| 6.1, 6.0 | hypersistence-utils-hibernate-60 | 3.9.4 (Commercial) |
| 5.6, 5.5 | hypersistence-utils-hibernate-55 | 3.9.5 (Commercial) |
| 5.4, 5.3, 5.2 | hypersistence-utils-hibernate-52 | 3.7.6 (Commercial) |
| 5.1, 5.0 | hypersistence-utils-hibernate-5 | 3.7.0 (Commercial) |
Hypersistence Utils requires you to explicitly declare several optional dependencies depending on the features you use. You must manage these versions yourself to ensure security and compatibility.
For Hibernate 7 and 6:
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-jakarta-xmlbind-annotations</artifactId>
<version>${jackson-module-jakarta-xmlbind-annotation}</version>
</dependency>For 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>Range mapping): com.google.guava:guavaMonetaryAmount mapping): org.javamoney:moneta (type pom)inet, hstore, array, interval): org.postgresql:postgresqldocker-compose.yml file to spin up local instances of PostgreSQL, MySQL, SQL Server, and Oracle for testing or development purposes. Each service is configured with specific environment variables for credentials and database names.Use the @Type annotation directly on the entity property. You can map to Map, List, POJO, String, or JsonNode.
@Type(JsonType.class)
private Map<String, String> properties = new HashMap<>();Option 1: Provide the fully-qualified name in @Type:
@Type(type = "io.hypersistence.utils.hibernate.type.json.JsonType")
private Map<String, String> properties = new HashMap<>();Option 2: Define a @TypeDef in your package-info.java to use a shorthand name:
@TypeDef(
name = "json", typeClass = JsonType.class
)
package io.hypersistence.optimizer;
import io.hypersistence.utils.hibernate.type.json.JsonType;
import org.hibernate.annotations.TypeDef;Then use the shorthand in your entity:
@Type(type = "json")
private Map<String, String> properties = new HashMap<>();When mapping JSON to a POJO, List<POJO>, or Map<String, POJO>, ensure the POJO overrides equals and hashCode based on its JSON content to prevent unnecessary Hibernate dirty checking updates.
@Tsid uses FactorySupplier.class to provide the TSID.Factory. If you need to provide a custom implementation of the TSID factory, you can specify the class that implements Supplier<TSID.Factory> in the annotation value.The @Tsid annotation allows you to specify a custom class that provides a TSID.Factory. By default, the annotation uses FactorySupplier.class, which provides a factory configured with TSID.Factory.THREAD_LOCAL_RANDOM_FUNCTION.
To use a custom factory, provide a class that implements Supplier<TSID.Factory> to the @Tsid annotation value.
Use StatelessSessionUtil.statelessSession(EntityManager entityManager) to retrieve a Hibernate StatelessSession that is correctly synchronized with the current Spring transaction.
This utility ensures that the same StatelessSession is reused within the same transaction by binding it to the TransactionSynchronizationManager using a StatelessSessionUtil key. If a session is already bound to the current transaction, it returns the existing one; otherwise, it opens a new StatelessSession using the current connection and binds it.
The @Tsid annotation can be applied to entity identifiers or other fields to automatically assign a time-sorted TSID.
TsidGenerator to handle value generation.TsidValueGenerator to handle value generation.Supported field types:
LongStringTSID (from the io.hypersistence.tsid package)The @Tsid annotation can be applied to entity identifiers or other fields to automatically assign a time-sorted TSID.
TsidGenerator for value generation.TsidValueGenerator.Supported field types include Long, String, or TSID.