Add support for @IdGeneratorType

Fixes #17

Author: marschall

README.md

@@ -38,15 +38,7 @@ You can use this sequence generator like this
 
 ```java
 @Id
-@GenericGenerator(
-        name = "some_column_name_id_generator",
-        strategy = "com.github.marschall.hibernate.batchsequencegenerator.BatchSequenceGenerator",
-        parameters = {
-            @Parameter(name = "sequence", value = "SOME_SEQUENCE_NAME"),
-            @Parameter(name = "fetch_size", value = "SOME_FETCH_SIZE_VALUE")
-        })
-@GeneratedValue(generator = "some_column_name_id_generator")
-@Column(name = "SOME_COLUMN_NAME")
+@BatchSequence(name = "SOME_SEQUENCE_NAME", fetch_size = SOME_FETCH_SIZE_VALUE)
 private Long someColumnName;
 ```
 
@@ -56,11 +48,7 @@ You need to configure the following things
 <dt>SOME_SEQUENCE_NAME</dt>
 <dd>the SQL name of the sequence from which the values should be fetched</dd>
 <dt>SOME_FETCH_SIZE_VALUE</dt>
-<dd>integer, how many values should be fetched at once, this should be equal to the <code>CACHE</code> value of the sequence</dd>
-<dt>SOME_COLUMN_NAME</dt>
-<dd>the SQL name of the column for which the value should be generated</dd>
-<dt>some_column_name_id_generator</dt>
-<dd>unique if of the generator</dd>
+<dd>integer, how many values should be fetched at once, this should be equal to the <code>CACHE</code> value of the sequence, optional, default value is 10</dd>
 </dl>
 
 

pom.xml

@@ -220,7 +220,7 @@
       <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-framework-bom</artifactId>
-        <version>6.1.7</version>
+        <version>6.1.10</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -280,7 +280,7 @@
     <dependency>
       <groupId>org.hsqldb</groupId>
       <artifactId>hsqldb</artifactId>
-      <version>2.7.2</version>
+      <version>2.7.3</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -304,7 +304,7 @@
     <dependency>
       <groupId>org.firebirdsql.jdbc</groupId>
       <artifactId>jaybird</artifactId>
-      <version>5.0.4.java11</version>
+      <version>5.0.5.java11</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -411,7 +411,7 @@
   <properties>
     <project.reporting.outputEncoding>utf-8</project.reporting.outputEncoding>
     <project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
-    <hibernate.version>6.5.1.Final</hibernate.version>
+    <hibernate.version>6.5.2.Final</hibernate.version>
     <project.build.outputTimestamp>2024-01-26T13:19:42Z</project.build.outputTimestamp>
   </properties>
 

src/main/java/com/github/marschall/hibernate/batchsequencegenerator/BatchSequence.java

@@ -0,0 +1,34 @@
+package com.github.marschall.hibernate.batchsequencegenerator;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import org.hibernate.annotations.IdGeneratorType;
+
+/**
+ * Meta annotation to use {@link BatchSequenceGenerator} as an identifier generator.
+ */
+@IdGeneratorType(BatchSequenceGenerator.class)
+@Retention(RUNTIME)
+@Target({ FIELD, METHOD })
+public @interface BatchSequence {
+
+  /**
+   * Returns the name of the sequence to use.
+   * 
+   * @return the name of the sequence to use
+   */
+  String name();
+
+  /**
+   *  Returns how many sequence values to fetch at once.
+   * 
+   * @return how many sequence values to fetch at once, must be positive
+   */
+  int fetchSize() default BatchSequenceGenerator.DEFAULT_FETCH_SIZE;
+
+}

src/main/java/com/github/marschall/hibernate/batchsequencegenerator/BatchSequenceGenerator.java

@@ -18,6 +18,7 @@
 import org.hibernate.HibernateException;
 import org.hibernate.MappingException;
 import org.hibernate.boot.model.relational.Database;
+import org.hibernate.boot.model.relational.ExportableProducer;
 import org.hibernate.boot.model.relational.QualifiedNameParser;
 import org.hibernate.boot.model.relational.SqlStringGenerationContext;
 import org.hibernate.dialect.Dialect;
@@ -27,10 +28,7 @@
 import org.hibernate.id.BulkInsertionCapableIdentifierGenerator;
 import org.hibernate.id.IdentifierGenerationException;
 import org.hibernate.id.IdentifierGenerator;
-import org.hibernate.id.PersistentIdentifierGenerator;
 import org.hibernate.id.enhanced.DatabaseStructure;
-import org.hibernate.id.enhanced.NoopOptimizer;
-import org.hibernate.id.enhanced.Optimizer;
 import org.hibernate.id.enhanced.SequenceStructure;
 import org.hibernate.internal.util.config.ConfigurationHelper;
 import org.hibernate.service.ServiceRegistry;
@@ -40,15 +38,12 @@
  * A sequence generator that uses a recursive query to fetch multiple
  * values from a sequence in a single database access.
  *
- * <h2>Parameters</h2>
- * The following configuration parameters are supported:
- * <dl>
- * <dt>{@value #SEQUENCE_PARAM}</dt>
- * <dd><strong>mandatory</strong>, name of the sequence to use</dd>
- * <dt>{@value #FETCH_SIZE_PARAM}</dt>
- * <dd>optional, how many sequence numbers should be fetched at a time,
- * default is {@value #DEFAULT_FETCH_SIZE}</dd>
- * </dl>
+ * <h2>Configuration</h2>
+ * <pre><code>
+ * &commat;Id
+ * &commat;BatchSequence(name = "SOME_SEQUENCE_NAME", fetch_size = SOME_FETCH_SIZE_VALUE)
+ * private Long someColumnName;
+ * </code></pre>
  *
  * <h2>SQL</h2>
  * Per default the generated SELECT will look something like this
@@ -136,16 +131,22 @@
  * In theory any RDBMS that supports {@code WITH RECURSIVE} and
  * sequences is supported.
  */
-public class BatchSequenceGenerator implements BulkInsertionCapableIdentifierGenerator, PersistentIdentifierGenerator {
+public final class BatchSequenceGenerator implements BulkInsertionCapableIdentifierGenerator, IdentifierGenerator, ExportableProducer {
 
   /**
    * Indicates the name of the sequence to use, mandatory.
+   * 
+   * @deprecated use {@link BatchSequence}
    */
+  @Deprecated
   public static final String SEQUENCE_PARAM = "sequence";
 
   /**
    * Indicates how many sequence values to fetch at once. The default value is {@link #DEFAULT_FETCH_SIZE}.
+   * 
+   * @deprecated use {@link BatchSequence}
    */
+  @Deprecated
   public static final String FETCH_SIZE_PARAM = "fetch_size";
 
   /**
@@ -154,27 +155,40 @@ public class BatchSequenceGenerator implements BulkInsertionCapableIdentifierGen
   public static final int DEFAULT_FETCH_SIZE = 10;
 
   private final Lock lock = new ReentrantLock();
+  private final BatchSequence annotation;
 
   private String select;
   private int fetchSize;
   private IdentifierPool identifierPool;
   private IdentifierExtractor identifierExtractor;
   private DatabaseStructure databaseStructure;
-  private NoopOptimizer optimizer;
+  
+  public BatchSequenceGenerator(BatchSequence annotation) {
+    this.annotation = annotation;
+  }
+  
+  public BatchSequenceGenerator() {
+    this.annotation = null;
+  }
 
   @Override
   public void configure(Type type, Properties params, ServiceRegistry serviceRegistry) {
 
     JdbcEnvironment jdbcEnvironment = serviceRegistry.getService(JdbcEnvironment.class);
     Dialect dialect = jdbcEnvironment.getDialect();
-    String sequenceName = determineSequenceName(params);
-    this.fetchSize = determineFetchSize(params);
+    String sequenceName;
+    if (this.annotation != null) {
+      sequenceName = this.annotation.name();
+      this.fetchSize = this.annotation.fetchSize();
+    } else {
+      sequenceName = determineSequenceName(params);
+      this.fetchSize = determineFetchSize(params);
+    }
 
     this.select = buildSelect(sequenceName, dialect);
     Class<?> returnedClass = type.getReturnedClass();
     this.identifierExtractor = IdentifierExtractor.getIdentifierExtractor(returnedClass);
     this.identifierPool = IdentifierPool.empty();
-    this.optimizer = new NoopOptimizer(returnedClass, 1);
 
     this.databaseStructure = this.buildDatabaseStructure(type, sequenceName, jdbcEnvironment, params);
   }
@@ -281,11 +295,6 @@ public Serializable generate(SharedSessionContractImplementor session, Object ob
     }
   }
 
-  @Override
-  public Optimizer getOptimizer() {
-    return this.optimizer;
-  }
-
   private String getSequenceName() {
     return this.databaseStructure.getPhysicalName().getObjectName().getCanonicalName();
   }

src/test/java/com/github/marschall/hibernate/batchsequencegenerator/configurations/HibernateConfiguration.java

@@ -29,6 +29,8 @@ public LocalContainerEntityManagerFactoryBean entityManager() {
     bean.setPersistenceUnitName(this.environment.getProperty(PERSISTENCE_UNIT_NAME));
     bean.setJpaDialect(this.jpaDialect());
     bean.setJpaVendorAdapter(new HibernateJpaVendorAdapter());
+//    Map<String, Object> jpaProperties = Map.of(AvailableSettings.PHYSICAL_NAMING_STRATEGY, new CamelCaseToUnderscoresNamingStrategy());
+//    bean.setJpaPropertyMap(jpaProperties);
     bean.setDataSource(this.dataSource);
     return bean;
   }

src/test/java/com/github/marschall/hibernate/batchsequencegenerator/entities/ParentEntity.java

@@ -1,17 +1,12 @@
 package com.github.marschall.hibernate.batchsequencegenerator.entities;
 
-import static com.github.marschall.hibernate.batchsequencegenerator.BatchSequenceGenerator.FETCH_SIZE_PARAM;
-import static com.github.marschall.hibernate.batchsequencegenerator.BatchSequenceGenerator.SEQUENCE_PARAM;
-
 import java.util.HashSet;
 import java.util.Set;
 
-import org.hibernate.annotations.GenericGenerator;
-import org.hibernate.annotations.Parameter;
+import com.github.marschall.hibernate.batchsequencegenerator.BatchSequence;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
-import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.Id;
 import jakarta.persistence.JoinColumn;
 import jakarta.persistence.OneToMany;
@@ -20,14 +15,7 @@
 public class ParentEntity {
 
   @Id
-  @GenericGenerator(
-          name = "parent_id_generator",
-          strategy = "com.github.marschall.hibernate.batchsequencegenerator.BatchSequenceGenerator",
-          parameters = {
-              @Parameter(name = SEQUENCE_PARAM, value = "SEQ_PARENT_ID"),
-              @Parameter(name = FETCH_SIZE_PARAM, value = "50")
-          })
-  @GeneratedValue(generator = "parent_id_generator")
+  @BatchSequence(name = "SEQ_PARENT_ID", fetchSize = 50)
   @Column(name = "PARENT_ID")
   private Long parentId;