[TS] JPA error - Specified key was too long; max key length is 1000 bytes

 

프로젝트 개발 도중, 한 사람당 하나의 계정과 멤버 소속을 가질 수 있도록 하기 위해서, unique 키를 설정하려고 했습니다.

당시 unique 키로 지정한 것은, 이름과 tel1, tel2, tel3와 같은 전화번호를 기준으로 unique 키를 선택했습니다. 그러자 하단과 같은 오류가 발생했습니다.

Specified key was too long; max key length is 1000 bytes

 

우선, 당시 Java에서 엔티티 객체를 생성할 때 이름과 tel1, tel2, tel3에 대해서 String 타입으로 설정하고 어떠한 제한을 두지 않았습니다.

JPA에서 spring.jpa.hibernate.ddl-auto=create 옵션으로 자동으로 테이블을 생성할 때 MyISAM 엔진을 사용한다면, 캐릭터셋이 utf8mb4로 만듭니다. utf8 이면 1글자당 3바이트 인 반면, utf8mb4는 4바이트입니다.
따라서 String 타입으로 설정한 해당 컬럼의 타입이 varchar(255)로 설정 되고, 이는 255*4 가 1020 을 잡게되어 1000 바이트를 초과하면서 위와 같은 에러가 발생한 것입니다.

 

첫 번째로 해결한 것은, length 조절입니다.

말 그대로, max key length가 1000 바이트로 제한이 걸려있으니, unique 키로 설정하려는 대상에 대해서 길이 제한을 걸면 됩니다.

이름은 대부분 3글자이며, 아무리 특수한 경우라도 10글자 이상 넘어가지 않습니다. 또한 전화번호와 같은 경우, tel1, tel2, tel는 각각 3자리, 4자리, 4자리를 포함하므로 length로 길이 제한을 두면 됩니다.

 

 

이러한 변화를 준 이후, 해당 오류가 사라지고 잘 설정된 것을 확인할 수 있었습니다. 

 

두 번째 해결 방법으로, InnoDB로의 변경입니다.

기존의 application.yml 설정 중 일부입니다.

 spring:
     jpa:
        database-platform: org.hibernate.dialect.MySQLDialect
     hibernate:
      ddl-auto: create
    properties:
      hibernate:
        format_sql: true
        dialect: org.hibernate.dialect.MySQL5Dialect

 

database-platform과 properties.hibernate.dialect를 MySQL5InnoDBDialect로 변경해주면, MyISAM이 아니라 InnoDB를 사용할 수 있습니다.

 

 spring:
     jpa:
        database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
     hibernate:
      ddl-auto: create
    properties:
      hibernate:
        format_sql: true
        dialect: org.hibernate.dialect.MySQL5InnoDBDialect

 

 

- MyISAM의 유니크 키 바이트 제한 : 1000 바이트 제한
- InnoDB의 유니크 키 바이트 제한 : 3072 바이트 제한 (두 개 이상의 열을 포함하는 인덱스의 경우)

 

따라서, MyISAM에서 InnoDB로의 전환만으로도, 유니크 키의 바이트 제한을 개선시킬 수 있습니다.