Hibernate Primary Key (ID) Generator

• How to Implement a Custom, Sequence-Based IdGenerator
• JPA Generated Values (@GeneratedValue, @SequenceGenerator, @TableGenerator)

• 최신버전에서는 hibernate.id.new_generator_mappings=true 프라퍼티를 통해 JPA에 호환성에 부합하는 새로운 방식으로 ID를 생성할 수 있다. 보통은 이 값이 true이면 sequence 시도 안되면 table 시도로 선택한다.
• 구버전과의 호환성을 위한 것이 아니면 이 값을 항상 true로 주고, MySQL 등 AUTO INCREMENT 계열에서는 ID 생성 방식을 AUTO보다는 구체적으로 IDENTITY로 명시하도록 하자.
• In Relation To... New (3.2.3) Hibernate identifier generators
• From JPA to Hibernate's Legacy and Enhanced Identifier Generators
• 하이버네이트는 어떻게 자동 키 생성 전략을 결정하는가 | Popit

• UUID ID 는 기본적으로 Binary로 매핑된다.
• 또한 ID Generator는 UUIDGenerater를 사용한다.
• 해당 컬럼을 문자열로 지정하고 싶다면 @Type(type=“uuid-char”)를 붙인다.

• org.hibernate.id.factory.internal.DefaultIdentifierGeneratorFactory 에서 Hibernate가 제공하는 기본 Custom Generator 목록을 볼 수 있다.

• 기존방식 : SequenceHiLoGenerator ID 생성시 모든 ID마다 Sequence 생성 호출
• 새 방식 : SequenceStyleGenerator 새로운 Sequence ID 생성방식. 한번 호출로 여러 Sequence를 생성하여 최적화하는 듯. 좀 더 확인 필요.

• 기존방식 : TableHiLoGenerator
• 새 방식 : MultipleHiLoPerTableGenerator

@Entity
public class EntityWithIdentityId {
    @Id @GeneratedValue(strategy=GenerationType.IDENTITY) Long id;
     :
}

• DB에서 ID 값을 읽어와야만 Persistence Context 에 저장가능하기 때문에, 객체 생성후 persist() 즉시 commit을 하지 않아도 DB 저장이 일어난다.

@Entity
// Define a sequence - might also be in another class:
@SequenceGenerator(name="seq", initialValue=1, allocationSize=100)
public class EntityWithSequenceId {
    // Use the sequence that is defined above:
    @GeneratedValue(strategy=GenerationType.SEQUENCE, generator="seq")
    @Id Long id;
}

@Entity
@TableGenerator(name="tab", initialValue=0, allocationSize=50)
public class EntityWithTableId {
    @GeneratedValue(strategy=GenerationType.TABLE, generator="tab")
    @Id Long id;
}

• ID 생성기를 Custom으로 만들 수 있다.
• How to implement a custom String-based sequence identifier generator with Hibernate - Vlad Mihalcea
• Custom Hibernate Sequence Generator for Id field
• jpa - Hibernate: How specify custom sequence generator class name using annotations?
• IdentifierGenerator를 상속하여 Custom Generator를 만들고

  public class StockCodeGenerator implements IdentifierGenerator {
   
      private static Logger log = Logger.getLogger(StockCodeGenerator.class);
   
      public Serializable generate(SessionImplementor session, Object object)
              throws HibernateException {
   
          String prefix = "M";
          // 이 Connection 은 Hibernate 가 관리하기 때문에 직접 close는 하지 말것.
          Connection connection = session.connection(); 
          try {
   
              PreparedStatement ps = connection
                      .prepareStatement("SELECT nextval ('seq_stock_code') as nextval");
   
              ResultSet rs = ps.executeQuery();
              if (rs.next()) {
                  int id = rs.getInt("nextval");
                  String code = prefix + StringUtils.leftPad("" + id,3, '0');
                  log.debug("Generated Stock Code: " + code);
                  return code;
              }
   
          } catch (SQLException e) {
              log.error(e);
              throw new HibernateException(
                      "Unable to generate Stock Code Sequence");
          }
          return null;
      }
  }

• 다음과 같은 방식으로 등록해서 사용한다.

  @Id
  @GenericGenerator(name="seq_id", strategy="my.package.StockCodeGenerator")
  @GeneratedValue(generator="seq_id")
  @Column(name = "stock_code", unique = true, nullable = false, length = 20)
  public String getStockCode() {
      return this.stockCode;
  }

• org.hibernate.id.Configurable 인터페이스를 함께 구현하여 @GenericGenerator에 파라미터를 지정하는 것도 가능하다. 이를 자신이 만든 Generator에서 받아서 사용한다.

• An Overview of Identifiers in Hibernate/JPA | Baeldung