Hibernate

Void Framework uses Hibernate 6 (or higher), which that means Java persistence is no longer defined by the Java Persistence API under Java EE, but rather by to the Jakarta Persistence 3.0 specification under Jakarta EE. This means the javax.persistence package is no longer available and is replaced by jakarta.persistence package.

Installation

This module adds support for the Transactional annotation as well as setting up an EntityManager provider pre-configured with all the data sources configured via the datasource module. There is no special configuration to apply, just add the voidframework-persistence-hibernate module to the pom.xml file of your project.

<dependency>
    <groupId>dev.voidframework</groupId>
    <artifactId>voidframework-persistence-hibernate</artifactId>
    <version>1.16.0</version>
</dependency>

Configuration

The following configuration key can be used in the configuration file of your application.

voidframework.persistence.modelsJarUrlPattern Pattern to select Jar to scan to find models. For more information, see below the section “Speed-up PersistenceEntityFactory initialization time”. Default value is auto.
voidframework.datasource.default.dialect the Redis server host. Default value is null.

The third segment named "default" represents the name of the data source. Any name can be used as long as it does not contain spaces or special characters.

Working with transaction manually

final EntityManager entityManager = this.entityManagerProvider.get();
final EntityTransaction transaction = entityManager.getTransaction();

transaction.begin();
/* insert/update/delete operations */
transaction.commit();

Identifier generator

Identifier type	Assignable to	Identifier generator annotation
CUID	CUID, String, byte[]	`@CuidGenerator`
UUID	UUID, String, byte[]	`@UuidGenerator`

Exemple

@Entity
@DynamicUpdate
@Table(name = "NEWS")
public class NewsModel extends Model {

    @Id
    @UuidGenerator
    @Column(name = "ID", updatable = false, nullable = false)
    private UUID id;

    @Column(name = "TITLE", nullable = false)
    private String title;

    @Column(name = "CONTENT", nullable = false)
    private String content;

    @Column(name = "PUBLISHED_AT", columnDefinition = "TIMESTAMP", updatable = false, nullable = false)
    private LocalDateTime publishedAt;

    @Override
    public String toString() {
        return this.getClass().getName() + "[id=" + this.id + "]";
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(final String title) {
        this.title = title;
    }

    public String getContent() {
        return content;
    }

    public void setContent(final String content) {
        this.content = content;
    }

    public LocalDateTime getPublishedAt() {
        return publishedAt;
    }

    public void setPublishedAt(final LocalDateTime publishedAt) {
        this.publishedAt = publishedAt;
    }
}

public class NewsRepositoryImpl implements NewsRepository {

    private final Conversion conversion;
    private final Provider<EntityManager> entityManagerProvider;

    @Inject
    public NewsRepositoryImpl(final Conversion conversion,
                              final Provider<EntityManager> entityManagerProvider) {
        this.conversion = conversion;
        this.entityManagerProvider = entityManagerProvider;
    }

    @Overide
    @Transactional(Transactional.TxType.SUPPORTS)
    public List<News> findTop10ByPublishedAtBeforeNowOrderByPublishedAtDesc() {
        final List<NewsModel> newsModelList = entityManagerProvider.get()
                .createQuery("SELECT x FROM NewsModel x WHERE x.publishedAt <= CURRENT_TIMESTAMP ORDER BY x.publishedAt DESC, x.id ASC", NewsModel.class)
                .setMaxResults(10)
                .getResultList();

        return conversion.convert(newsModelList, NewsModel.class, News.class);
    }

Speed-up PersistenceEntityFactory initialization time

By default, Void Framework tells the PersistenceEntityFactory to scan all JARs of the application’s and dependencies. This scan is necessary to detect models. If you want to greatly improve this initialization time, it is advisable to set the voidframework.persistence.modelsJarUrlPattern configuration key to indicate which JARs to keep. The could be null, a regular expression, or auto (default value).

If the configuration is set to null, only the current JAR / classpath (when started in IDE) will be used. auto is like using the regular expression (.*).