[JPA] Entity Custom ID Generator (@GenericGenerator)

Entity의 기본키 (primary key)를 생성하는 방법으로 보통 Auto Increment 방식이나 UUID 방식을 많이 사용한다. 

 

• Auto Increment

: 구현이 간단하고 재정렬이 필요없다(순서가 보장된다.)

: 한대의 DB에서 생성하기 때문에 스케일아웃을 통한 확장이 불가능하다. (처리 성능 확정이 어려움)

: insert 후에야 PK 값을 생성할 수 있다.

 

: 보통 bigint로 구현. 

: 외부에 노출될 경우 사용하면 안된다. (다른 id를 유추 가능하기 때문에)

 

 

• UUID

: 네트워크 상에서 고유성이 보장되는 ID를 만들기 위한 표준 규약

: 128 bit 데이터로 표현 (16 Byte)

: 멀티 환경에서도 병렬로 동작하여 유일한 ID를 생성할 수 있다.

: 128bit로 데이터베이스에 많은 공간을 차지하며 인덱스 구축에 적합하지않다.

: 키의 의미를 갖기 어렵다.

 

 

• SnowFlake

: Twitter에서 OSS로 공개하고 있는 ID 생성기

: Time-base로 한 ID

(1밀리초 이내에 동시에 생성된 일련번호를 포함하여, 같은 시간, 같은 머신에서 중복되는는 것을 방지 - 12bit)

: 64 Bit의 Long 값으로 데이터로 표현

: 멀티 환경에서도 병렬로 동작하여 유일한 ID를 생성할 수 있다.

: timestamp 값을 기초로 하기 때문에 ID 정렬이 가능하다.

: id를 통해 생성시를 timestamp 값으로 복원가능하다.

: OS의 시각 차이에 약하며 시간이 잘못 역전될 경우 고장이 발생할 수 있다.

(분산 시스템에 있는 모든 인스턴스가 같은 시스템의 시간을 보장할 수 있어야한다.)

 

generate_id : https://github.com/callicoder/java-snowflake

 

Twitter에서 제공한 SnowFlake 방식은 UUID 보다 작은 크기로 랜덤한 값을 제공하기때문에 좋아보이지만 git repo에 업데이드가 안된지 꽤 된것으로 보아 지금 사용하기는 힘들어보인다.

 

 

 

✅ Custom ID

 

보통 UUID 값을 많이 사용하지만 특정 방식으로 키값을 관리해야하는 경우가 있을 수 있다. 예를 들어 주문 번호처럼 일정 패턴으로 생성하는 값을 키 값으로 사용하는 경우가 있을 수 있다.

날짜가 포함된 Naver Pay 주문 번호

 

 

JPA Hibernate에서는 Custom ID 생성를 생성할 수 있는 인터페이스를 제공한다.

 

기본 전략을 사용하고 싶지 않을때, 이를 위해 IdentifierGenerator 인터페이스를 구현하여 사용자 지정 생성기를 정의할 수 있다.

public class MyGenerator implements IdentifierGenerator {

    private String prefix;

    // 키를 생성하는 로직을 가지는 메소드
    @Override
    public Serializable generate(
        SharedSessionContractImplementor session, Object obj)
        throws HibernateException {

        return prefix + System.currentTimeMillis() + (int)(Math.random() * 1000);

    }

     // 키를 생성하는 프로시저에 값을 넘겨주기위한 메소드. 전달받을 파라미터가 없다면 Override하지 않아도 된다.
     @Override
     public void configure(Type type, Properties properties, 
      ServiceRegistry serviceRegistry) throws MappingException {

        prefix = properties.getProperty("prefix");

    }
}

중복 Id를 생성하지 않는 것이 중요하기 때문에 currentTimeMillis에 랜덤 값을 더해 구현해 보았습니다. millisecond안에 얼마나 많은 요청이 들어올지는 모르겠지만 random값은 중복을 허용하기 때문에 희박한 확률로 중복값이 나올수도 있을 것 같습니다.

 

 

• IdentifierGenerator 인터페이스구현 클래스는 반드시 public으로 선언된 기본 생성자가 있어야 합니다.

 

• Properties 클래스의 getProperty() 메소드는 String 값만을 반환하지만, ConfigurationHelper 클래스에는 getString(), getBoolean() 등의 다양한 값을 반환하는 메소드들이 있어서 사용할수 있습니다.

 prefix = ConfigurationHelper.getString(SEQ_GENERATOR_PARAM_KEY, params);

 

• 매개변수 session을 이용해서 쿼리를 실행하는 형태로 작성할 수 있다. connetction을 가져올 수 있지만 이 Connection 은 Hibernate 가 관리하기 때문에 직접 close는 하지 말것.

Connection connection = session.connection();

 

 

 

해당 Generator는 @GenericGenerator 어노테이션을 사용하여 modifier에 구현 클래스 명을 선언해주면 사용가능하다. 

@Id
@GeneratedValue(generator = "order-generator")
@GenericGenerator(name = "orderId-generator", 
            	strategy = "com.prgrms.bdbks.domain.order.MyGenerator")
private String orderId;

 

파라미터를 전달할 경우

@Id
@GeneratedValue(generator = "order-generator")
@GenericGenerator(name = "orderId-generator", 
                parameters = @Parameter(name = "prefix", value = "prod"), 
                strategy = "com.prgrms.bdbks.domain.order.MyGenerator")
private String orderId;

 

---

 

다른 예제 들을 살펴보자

public class StockCodeGenerator 
  implements IdentifierGenerator {
 
    @Override
    public Serializable generate(
    	SessionImplementor session, Object object)
            throws HibernateException {
 
        String prefix = "M";
        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');
                return code;
            }
        } catch (SQLException e) {
            log.error(e);
            throw new HibernateException(
                    "Unable to generate Stock Code Sequence");
        }
        return null;
    }
}

https://kwonnam.pe.kr/wiki/java/hibernate/id_generator

prefix를 파라미터가 아닌 고정값으로 지정하였고, DB에 접근하여 시퀀스 값을 가져온다음 다음 시퀀스 값을 prefix와 합하여 id로 반환해준다.

 

 

public class MyGenerator 
  implements IdentifierGenerator {

    private String prefix;

    @Override
    public Serializable generate( 
      SharedSessionContractImplementor session, Object obj) 
      throws HibernateException {

        String query = String.format("select %s from %s", 
            session.getEntityPersister(obj.getClass().getName(), obj)
              .getIdentifierPropertyName(),
            obj.getClass().getSimpleName());

        Stream ids = session.createQuery(query).stream();

        Long max = ids.map(o -> o.replace(prefix + "-", ""))
          .mapToLong(Long::parseLong)
          .max()
          .orElse(0L);

        return prefix + "-" + (max + 1);
    }

    @Override
    public void configure(Type type, Properties properties, 
      ServiceRegistry serviceRegistry) throws MappingException {
        prefix = properties.getProperty("prefix");
    }
}

https://www.baeldung.com/hibernate-identifiers

QueryDSL을 이용한 구현인것 같다. id값을 가져와 'prefix-'를 제거한 후 max+1 해서 다시 prefix를 붙여서 반환. 

 

 

 

중복을 제거할 수 있는 방식으로 다양하게 커스텀 할 수 있을 것같다.

http://www.gisdeveloper.co.kr/?p=5623 

https://toshi15shkim.github.io/articles/2019-10/java-unique-id

 

 

 

reference.

https://www.baeldung.com/hibernate-identifiers

https://zet-it-story.tistory.com/1

https://techblog.woowahan.com/2607/

https://kapentaz.github.io/jpa/Hibernate에서-Custom-ID-생성하기/#

 

 

잘못된 정보가 있다면 댓글을 통해 알려주세요. 감사합니다.