Skip to content

Migrate ULIDIdGenerator to Hibernate ORM 7 (0.3.0-hu) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bauna merged 1 commit into from
Jul 13, 2026
Merged

Migrate ULIDIdGenerator to Hibernate ORM 7 (0.3.0-hu) #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ jobs:
- name: Set up Java
uses: actions/setup-java@v3
with:
java-version: '8'
distribution: 'adopt'
- name: Run chmod to make gradlew executable
run: chmod +x ./gradlew
java-version: '17'
distribution: 'temurin'
- name: Build and test
run: ./mvnw clean package
run: ./mvnw clean verify
48 changes: 0 additions & 48 deletions .github/workflows/release.yml
View file
Open in desktop

This file was deleted.

21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,27 @@ Generate and parse ULIDs in Crockford base32 text and binary representations.

See [ULID specification](https://github.com/ulid/spec) for more info

## Humand fork
This is the Humand fork of [jaspeen/ulid-java](https://github.com/jaspeen/ulid-java), published to Humand CodeArtifact as `co.humand.io.github.jaspeen:ulid-java`.

Fork changes:
* `ULID.randomV7()` generates UUIDv7-compatible ULIDs
* `0.3.0-hu`+ requires Hibernate ORM 7 (new `IdentifierGenerator` APIs); Hibernate 6 users should stay on `0.2.1-hu`

## Key points
* Java 11+
* Java 17+
* API similar to java.util.UUID
* Optional monotonic generator
* Optional hibernate type and ID generator (requires hibernate 6.x)
* Optional hibernate type and ID generator (requires hibernate 7.x)
## Install
### Maven
```xml
<dependency>
<groupId>io.github.jaspeen</groupId>
<groupId>co.humand.io.github.jaspeen</groupId>
<artifactId>ulid-java</artifactId>
<version>0.2.0</version>
<version>0.3.0-hu</version>
</dependency>
```
### Gradle
```groovy
dependencies {
implementation 'io.github.jaspeen:ulid-java:0.2.0'
}
```

## Usage

Expand Down
21 changes: 14 additions & 7 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

<groupId>co.humand.io.github.jaspeen</groupId>
<artifactId>ulid-java</artifactId>
<version>0.2.1-hu</version>
<version>0.3.0-hu</version>
<packaging>jar</packaging>

<name>ulid-java</name>
<description>ULID java implementation</description>
<url>ttps://github.com/HumandDev/ulid-java</url>
<url>https://github.com/HumandDev/ulid-java</url>
<inceptionYear>2023</inceptionYear>

<licenses>
Expand All @@ -35,23 +35,30 @@
</distributionManagement>

<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<dependencies>
<dependency>
<groupId>org.hibernate</groupId>
<groupId>org.hibernate.orm</groupId>
<artifactId>hibernate-core</artifactId>
<version>6.4.4.Final</version>
<version>7.2.19.Final</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.9.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>2.3.232</version>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand All @@ -61,7 +68,7 @@
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<configuration>
<release>11</release>
<release>17</release>
</configuration>
</plugin>
<plugin>
Expand Down
21 changes: 9 additions & 12 deletions src/main/java/io/github/jaspeen/ulid/hibernate/ULIDIdGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

import io.github.jaspeen.ulid.ULID;
import org.hibernate.HibernateException;
import org.hibernate.MappingException;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.generator.GeneratorCreationContext;
import org.hibernate.id.IdentifierGenerator;
import org.hibernate.service.ServiceRegistry;
import org.hibernate.type.Type;

import java.util.Properties;
import java.util.UUID;
Expand Down Expand Up @@ -39,26 +37,25 @@ public class ULIDIdGenerator implements IdentifierGenerator {

private ULIDTypeDescriptor.ValueTransformer valueTransformer;

@Override public void configure(Type type, Properties params, ServiceRegistry serviceRegistry) throws
MappingException {
if (ULID.class.isAssignableFrom(type.getReturnedClass())) {
@Override public void configure(GeneratorCreationContext creationContext, Properties parameters) {
Class<?> idClass = creationContext.getType().getReturnedClass();
if (ULID.class.isAssignableFrom(idClass)) {
valueTransformer = ULIDTypeDescriptor.PassThroughTransformer.INSTANCE;
} else if (UUID.class.isAssignableFrom(type.getReturnedClass())) {
} else if (UUID.class.isAssignableFrom(idClass)) {
valueTransformer = ULIDTypeDescriptor.ToUUIDTransformer.INSTANCE;
} else if (String.class.isAssignableFrom(type.getReturnedClass())) {
} else if (String.class.isAssignableFrom(idClass)) {
valueTransformer = ULIDTypeDescriptor.ToStringTransformer.INSTANCE;
} else if (byte[].class.isAssignableFrom(type.getReturnedClass())) {
} else if (byte[].class.isAssignableFrom(idClass)) {
valueTransformer = ULIDTypeDescriptor.ToBytesTransformer.INSTANCE;
} else {
throw new HibernateException(
"Unanticipated return type [" + type.getReturnedClass().getName() + "] for ULID conversion");
"Unanticipated return type [" + idClass.getName() + "] for ULID conversion");
}
}

@Override public Object generate(SharedSessionContractImplementor session, Object object) throws
HibernateException {
Object id = session.getEntityPersister(null, object)
.getClassMetadata().getIdentifier(object, session);
Object id = session.getEntityPersister(null, object).getIdentifier(object, session);
if (id != null) {
return id;
}
Expand Down
120 changes: 120 additions & 0 deletions src/test/java/io/github/jaspeen/ulid/hibernate/ULIDIdGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
package io.github.jaspeen.ulid.hibernate;

import io.github.jaspeen.ulid.ULID;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
import org.hibernate.SessionFactory;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.JavaType;
import org.hibernate.cfg.Configuration;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

import java.util.UUID;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

class ULIDIdGeneratorTest {

private static SessionFactory sessionFactory;

@BeforeAll
static void setUp() {
sessionFactory = new Configuration()
.addAnnotatedClass(ULIDEntity.class)
.addAnnotatedClass(UUIDEntity.class)
.addAnnotatedClass(StringEntity.class)
.addAnnotatedClass(BytesEntity.class)
.setProperty("hibernate.connection.driver_class", "org.h2.Driver")
.setProperty("hibernate.connection.url", "jdbc:h2:mem:ulid_test;DB_CLOSE_DELAY=-1")
.setProperty("hibernate.hbm2ddl.auto", "create-drop")
.buildSessionFactory();
}

@AfterAll
static void tearDown() {
if (sessionFactory != null) {
sessionFactory.close();
}
}

@Entity(name = "ULIDEntity")
static class ULIDEntity {
@Id
@GeneratedValue(generator = "ulid")
@GenericGenerator(name = "ulid", strategy = "io.github.jaspeen.ulid.hibernate.ULIDIdGenerator")
@JavaType(ULIDTypeDescriptor.class)
ULID id;
}

@Entity(name = "UUIDEntity")
static class UUIDEntity {
@Id
@GeneratedValue(generator = "ulid")
@GenericGenerator(name = "ulid", strategy = "io.github.jaspeen.ulid.hibernate.ULIDIdGenerator")
UUID id;
}

@Entity(name = "StringEntity")
static class StringEntity {
@Id
@GeneratedValue(generator = "ulid")
@GenericGenerator(name = "ulid", strategy = "io.github.jaspeen.ulid.hibernate.ULIDIdGenerator")
String id;
}

@Entity(name = "BytesEntity")
static class BytesEntity {
@Id
@GeneratedValue(generator = "ulid")
@GenericGenerator(name = "ulid", strategy = "io.github.jaspeen.ulid.hibernate.ULIDIdGenerator")
byte[] id;
}

@Test
void generatesULIDId() {
ULIDEntity entity = new ULIDEntity();
sessionFactory.inTransaction(session -> session.persist(entity));
assertNotNull(entity.id);
}

@Test
void generatesUUIDId() {
UUIDEntity entity = new UUIDEntity();
sessionFactory.inTransaction(session -> session.persist(entity));
assertNotNull(entity.id);
assertEquals(7, entity.id.version());
}

@Test
void generatesStringId() {
StringEntity entity = new StringEntity();
sessionFactory.inTransaction(session -> session.persist(entity));
assertNotNull(entity.id);
assertEquals(26, entity.id.length());
}

@Test
void generatesBytesId() {
BytesEntity entity = new BytesEntity();
sessionFactory.inTransaction(session -> session.persist(entity));
assertNotNull(entity.id);
assertEquals(16, entity.id.length);
}

@Test
void returnsExistingIdWhenEntityAlreadyHasOne() {
UUIDEntity entity = new UUIDEntity();
sessionFactory.inTransaction(session -> session.persist(entity));
UUID existing = entity.id;

ULIDIdGenerator generator = new ULIDIdGenerator();
Object generated = sessionFactory.fromTransaction(session ->
generator.generate((SharedSessionContractImplementor) session, entity));
assertEquals(existing, generated);
}
}
Loading