JPA/Hibernate에서 @Column(columnDefinition = "TEXT") 사용하지 않고 MySQL TEXT 타입 설정하기

Posted Jul 15, 2023 Updated Jul 24, 2023

By Seongguk 23 min read

Intro

Spring을 공부하고 있다보니 JPA가 너무 자주보여서 궁금해서 한 번 써봤습니다.

MySQL 을 사용해서 TEXT 타입을 설정하려고 찾아보니, 찾아본거에 한해서는 대체로 @Lob이나 @Column(columnDefinition = “TEXT”)를 설정하라고 합니다.

그런데 MySQL에서는 @Lob만 설정하면 TINYTEXT가 돼버리고, columnDefinition에 TEXT를 지정하는 건 뭔가 마음에 안듭니다.

뭐가 문제야?

JPA를 사용함으로써 얻는 장점 중 하나로 데이터베이스에 대해 신경 쓸 부분을 줄여서, 비즈니스 로직에 집중할 수 있게 해주는 장점이 있습니다. 개인적으로는 여러 장점 중에 이식성이 높다는 게 큰 장점 중에 하나가 아닌가 생각합니다.

그런데 @Column(columnDefinition = “TEXT”) annotation을 사용해서 TEXT 타입을 컬럼의 데이터 타입으로 특정하면, TEXT 타입이 없는 데이터베이스로 마이그레이션할때는 또 하나씩 다 바꿔줘야하는 문제가 발생할 수 있다는 생각이 들었습니다.

그래서 TEXT 타입이 있는 MySQL과 TEXT 타입이 없는 Oracle database 에서 @Column(columnDefinition = “TEXT”)가 아닌 다른 annotation을 사용해서 MySQL의 TEXT 타입, Oracle의 유사한 타입인 CLOB 타입으로 설정하는 실험을 해봤습니다.

참고로 실행 환경은 Spring Boot 3.1.1, Spring Data JPA/Hibernate, MySQL 8.0.32, Oracle Database 23c(Docker), Windows 11을 사용하였습니다.

JPA with MySQL

먼저 @Column(columnDefinition = “TEXT”)을 사용하지 않고, 다른 annotation을 사용하는 방법을 찾아갔던 과정을 살펴보겠습니다.

@Lob

검색해보면 쉽게 볼 수 있는 한 가지 방법인 @Lob 만 먼저 선언해보면, MySQL에서 TEXT가 아닌 TINYTEXT로 설정이 되는 것을 볼 수 있습니다.

  
@Data
@Entity
public class Card {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Lob
    private String front;

    @Lob
    private String back;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "learner")
    private Learner learner;

}

아래는 MySQL을 사용하여 시작한 경우의 로그입니다.

Hibernate: create table card (id bigint not null auto_increment, learner bigint, back tinytext, front tinytext, primary key (id)) engine=InnoDB

TINYTEXT

TINYTEXT 에 대한 MySQL의 문서(링크)를 보면, 아래와 같습니다.

A TEXT column with a maximum length of 255 (28 − 1) characters. The effective maximum length is less if the value contains multibyte characters. Each TINYTEXT value is stored using a 1-byte length prefix that indicates the number of bytes in the value.
최대 길이가 255(2^8 - 1)자인 TEXT 열입니다. 값에 멀티바이트 문자가 포함된 경우 유효 최대 길이는 이보다 짧습니다. 각 TINYTEXT 값은 값의 바이트 수를 나타내는 1바이트 길이 접두사를 사용하여 저장됩니다.

긴 문자열을 저장하고자 TEXT를 사용하는데, 목적과는 많이 멀다는 것을 알 수 있습니다. TEXT 타입도 문서(링크)에 있는 내용을 한 번 보겠습니다.

TEXT

A TEXT column with a maximum length of 65,535 (2^16 − 1) characters. The effective maximum length is less if the value contains multibyte characters. Each TEXT value is stored using a 2-byte length prefix that indicates the number of bytes in the value.
An optional length M can be given for this type. If this is done, MySQL creates the column as the smallest TEXT type large enough to hold values M characters long.
최대 길이가 65,535(2^16 - 1)자인 TEXT 열입니다. 값에 멀티바이트 문자가 포함된 경우 유효 최대 길이는 이보다 짧습니다. 각 TEXT 값은 값의 바이트 수를 나타내는 2바이트 길이 접두사를 사용하여 저장됩니다.
이 타입에 대해 선택적 길이 M을 지정할 수 있습니다. 이렇게 하면 MySQL은 값을 M만큼의 길이로 저장할 수 있을 만큼 충분히 큰 가장 작은 TEXT 유형으로 열을 생성합니다.

두 내용을 살펴 본 후에 저는 TINYTEXT의 prefix 길이가 1바이트이고, TEXT는 2바이트라는 점에 주목해서 @Column의 length 속성을 수정해보기로 했습니다.

@Column

@Column annotation을 살펴보면, length 속성 default 는 255로 설정되어 있습니다.

  
int length() default 255;

딱 TINYTEXT의 최대 길이 입니다. 그래서 엄하게 큰 값을 주면, TEXT 타입으로 변경하려는 의도가 표현되지 않을 것 같아서 256으로 설정해서 다시 코드를 작성했습니다.

  
@Data
@Entity
public class Card {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Lob
    @Column(nullable = false, length = 256)
    private String front;

    @Column(nullable = false, length = 256)
    private String back;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "learner")
    private Learner learner;

}

front는 @Lob과 같이 사용하고, back은 @Lob 을 제거하여 어떻게 되는지 확인해봤습니다.

Hibernate: create table card (id bigint not null auto_increment, learner bigint, back varchar(256) not null, front text not null, primary key (id)) engine=InnoDB

그 결과 @Lob과 같이 사용했을 때 TEXT가 되고, @Lob이 없으면 VARCHAR(256)이 되는 것을 볼 수 있습니다.

MySQL 에서는 @Lob과 @Column에서 length 를 255보다 큰 값으로 설정하여, 개인적으로 마음에 안드는 @Column(columnDefinition = “TEXT”) 없이 TEXT 타입으로 설정할 수 있는 것을 확인할 수 있었습니다.

다음으로 Oracle database에서 확인해보겠습니다.

Oracle database

Oracle database 도 처음 써보는데, Docker 도 처음 써봐서 엄청 애를 먹었습니다. 저 같은 초보자를 위해 Oracle database 를 Docker 에서 세팅하는 방법을 글 최하단에 첨부하겠습니다.

사용한 Oracle database 버전은 23c 입니다.

먼저 앞서 실행했던 Card 클래스 그대로, Oracle database로 변경만 해서 실행한 결과 아래와 같이 clob 타입으로 설정되는 것을 볼 수 있습니다.

Hibernate: create table card (id number(19,0) generated as identity, back varchar2(256 char) not null, front clob not null, learner number(19,0), primary key (id))

그런데 @Lob은 딱봐도 Oracle database 에 초점을 맞춘 annotation 같은 느낌이 듭니다.

@Lob만 단독으로 해보기

front에서 @Column annotation을 지우고 다시 해봤습니다.

  
@Lob
private String front;

Hibernate: create table card (id number(19,0) generated as identity, learner number(19,0), back varchar2(256 char) not null, front clob, primary key (id))

역시나 clob으로 잘 됩니다.

심지어 length를 기본값인 255로 설정해도 clob으로 설정됩니다.

이거 하나만 가지고 판단하긴 좀 그렇지만, JPA는 Oracle database 와 궁합이 잘 맞지 않을까 싶습니다. JPA가 Oracle 손아귀에 오래 있었으니 당연한 이야기인가…

@Column(columnDefinition = “TEXT”)

설치한김에 Oracle database에서 @Column(columnDefinition = “TEXT”) 를 사용해보면, 아래와 같이 부적합하다는 메시지를 볼 수 있습니다.

org.hibernate.tool.schema.spi.CommandAcceptanceException: Error executing DDL “create table card (id number(19,0) generated as identity, back varchar2(256 char) not null, front TEXT, learner number(19,0), primary key (id))” via JDBC [ORA-00902: 데이터유형이 부적합합니다]

끝내려고 보니 다시 시작되는 궁금증

TEXT 타입에 대한 이식성을 보장하려면, @Lob과 @Column(length = 256) 을 같이 선언해주는게 좋을 것 같습니다. 그런데 TEXT 타입에도 length를 지정할 수 있다고 문서에 써있었는데, GPT-3.5는 TEXT 타입은 길이 지정 안된다고 우겨서, 실험해봤더니 TEXT Type 뒤에 legnth를 지정해도, VARCHAR처럼 세세하게 length 설정이 안됩니다.

MySQL 문서(링크)에 관련 예제가 있기는 합니다.

문서에서 참고할만한 내용은 아래와 같습니다.

스토리지 엔진이 더 큰 행을 지원할 수 있는 경우에도 MySQL 테이블의 내부 표현에는 최대 행 크기 제한이 65,535바이트로 설정되어 있습니다. BLOB 및 TEXT 열은 콘텐츠가 나머지 행과 별도로 저장되므로 행 크기 제한에 9~12바이트만 기여합니다.

그리고 예제로 주어진 sql에서는 VARCHAR 타입으로 한 행에서 65,535바이트가 넘는 것을 방지하기 위해 TEXT 타입을 같이 섞어서 사용합니다.

  
mysql> CREATE TABLE t (a VARCHAR(10000), b VARCHAR(10000),
       c VARCHAR(10000), d VARCHAR(10000), e VARCHAR(10000),
       f VARCHAR(10000), g VARCHAR(6000)) ENGINE=InnoDB CHARACTER SET latin1;
ERROR 1118 (42000): Row size too large. The maximum row size for the used
table type, not counting BLOBs, is 65535. This includes storage overhead,
check the manual. You have to change some columns to TEXT or BLOBs

mysql> CREATE TABLE t (a VARCHAR(10000), b VARCHAR(10000),
       c VARCHAR(10000), d VARCHAR(10000), e VARCHAR(10000),
       f VARCHAR(10000), g TEXT(6000)) ENGINE=InnoDB CHARACTER SET latin1;
Query OK, 0 rows affected (0.02 sec)

그런데 직접 실험해본 결과 TEXT에 length 를 255보다는 크면서(255 이하로 설정하면 자동으로 TINYTEXT로 지정), 65,535 이하인 값으로 설정하면 얼마를 설정하든 최대 길이는 65,535 이기 때문에, TEXT에 length를 설정하는 것은 범위 내의 값인 경우 별 의미가 없었습니다.

컬럼의 최대 길이는 아래 sql을 입력해서 확인할 수 있습니다.

  
SELECT *
FROM INFORMATION_SCHEMA.COLUMNS
WHERE TABLE_SCHEMA = '데이터베이스 또는 스키마 이름' AND TABLE_NAME = '테이블 이름';

꼬리에 꼬리를 무는 의문

MySQL에는 TEXT 보다 큰 MEDIUMTEXT와 LONGTEXT가 있습니다. 그럼 이거는 어떻게 해야하나 의문이 듭니다.

혹시나 해서 @Column의 length를 2^16보다 1 큰 값인 65_536 으로 해보니 MEDIUMTEXT 타입으로 지정이 됩니다.

Hibernate: create table card (id bigint not null auto_increment, learner bigint, back varchar(256) not null, front mediumtext not null, primary key (id)) engine=InnoDB

그리고 2^24보다 1 큰 값인 16_777_217 을 length에 지정하니 LONGTEXT 타입으로 지정이 됩니다.

Hibernate: create table card (id bigint not null auto_increment, learner bigint, back varchar(256) not null, front longtext not null, primary key (id)) engine=InnoDB

그리고 Oracle database 에서 CLOB에 길이를 지정해보니 길이를 지정할 수 없다고 오류가 발생합니다.

  
create table test (test CLOB(500));

ERROR at line 1: ORA-03074: Size cannot be specified for data type CLOB.

Hibernate가 @Lob 과 @Column 을 같이 사용할 때 length 를 지정해도 Oracle database 인 경우에는 알아서 무시해준 것이었습니다.

뭣도 모르고 할 때는 Hibernate에 아쉬움을 느꼈다가 마지막엔 Hibernate 가 정말 잘 만들었음을 느끼고 마무리하게 됩니다.

갑자기 또 postgreSQL 도 궁금해지는데… 궁금하면 차라리 나중에 코드를 까보는게 나을 것 같습니다.

정리

여러번 수정하다보니 글이 너무 난잡해져서 정리하고 마무리 해야겠습니다.

String type의 field에 @Lob 을 지정하면, 데이터베이스에서 문자열을 저장할 수 있는 가장 큰 자료형이 지정됩니다.

Oracle Database에서는 문자열을 저장하는 가장 큰 자료형이 한 가지라 CLOB으로 지정이 됩니다.

MySQL 의 경우 TEXT가 문자열을 저장하는 가장 큰 자료형이지만, TEXT의 종류로 TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT가 있기 때문에 TEXT에 길이를 지정하여 길이에 따른 TEXT 종류를 지정할 수 있습니다. (SQL 사용시에는 직접 구체적인 TEXT 타입을 지정할 수 있습니다.)

JPA에서 field에 지정되는 length의 기본값은 255이고, @Column annotation을 통해 변경할 수 있습니다. 그리고 255는 TINYTEXT의 최대값이기 때문에, @Lob만 사용하는 경우 length가 255인 값을 저장할 수 있을 만큼 충분히 크면서, 가장 작은 TEXT 타입인 TINYTEXT 타입이 지정됩니다.

TINYTEXT보다 한 단계 더 큰 타입인 TEXT 타입을 사용하려면, @Lob과 함께 @Column의 length를 256 이상, 65_535 이하로 설정하여야 합니다.( @Column(length = 256 ~ 65_535) )

MEDIUMTEXT나 LONGTEXT는 그보다 큰 값을 사용하여 지정할 수 있습니다.

앞서 봤던 MySQL 문서에서 TEXT 타입에 나온 아래 설명을 처음에 제대로 이해 못해서 혼란스러웠던 것 같습니다.

이 타입에 대해 선택적 길이 M을 지정할 수 있습니다. 이렇게 하면 MySQL은 값을 M만큼의 길이로 저장할 수 있을 만큼 충분히 큰 가장 작은 TEXT 유형으로 열을 생성합니다.

Outro

가볍게 팁 공유하려고 시작했는데, 쓸데 없이 길어졌습니다. 이럴거면 애초에 코드를 까볼걸 후회가됩니다. 그러고서 더 혼란스러워졌을지도…?

MySQL 사용할 때 TEXT를 사용할거면 최대값인 65_535를 length로 지정하는게 의도가 더 확실한 것 같아서, 저는 @Lob과 함께 @Column에 length를 65_535로 지정하여 쓰기로 했습니다.

글이 원래도 난장판이지만 더 난장판이 됐습니다. 올린 글을 내려야 하나 심각하게 고민이됩니다.

방문자는 없으니 일단 두는걸로…

JPA가 문제가 아니라 주로 사용하는 MySQL에 대해서도 잘 모르고 있었다는 사실을 다시 한 번 확인하는 기회였습니다.

아래는 앞서 말씀드린대로 Docker와 Oracle database 처음 써보시는 분들을 위해 세팅 방법을 추가로 첨부합니다.

뻘짓을 거하게 한 것 같지만, 격하게 설치하기 싫던 Oracle database 를 사용하기 위해, 미루고 미루던 Docker 사용을 해봤으니 조금이나마 위로가 됩니다.

Oracle Database 세팅 방법

제가 Windows 11을 사용하므로, Windows 11을 기준으로 설명드립니다.

Docker 가 설치되어 있지 않다면, Docker Desktop(링크) 을 설치합니다. 설치하고 나면 Windows 에서도 powershell 이나 command prompt 에서 docker 명령어를 사용할 수 있습니다.

개발자용으로 Oracle database는 23c를 무료로 제공한다는 글(링크)이 있어서, 다운로드 페이지(링크)를 참고하여 Docker image를 다운받았습니다.

docker image 다운로드

아래와 같은 명령어를 입력하여 docker image를 다운받습니다.

docker pull container-registry.oracle.com/database/free

docker container 실행

아래와 같이 입력하여 container를 실행시킵니다. 저는 8080 port로 변경했는데, 과거에 oracle 설치하다가 취소했을 때 제대로 롤백이 안됐는지 1521 port가 충돌이 발생해서 8080 port로 설정했습니다.

docker run -p 8080:1521 container-registry.oracle.com/database/free:latest

Oracle database 접속

docker 에 terminal로 접속하려면 또 설정해야할게 많으니, 기존에 세팅이 되어있으신 분이 아니라면 docker desktop 에서 container를 선택하고, terminal 메뉴로 이동합니다. container 실행 설정을 따로 안해놓으면 이름이 랜덤으로 설정되기 때문에, container 이름은 다를 수도 있습니다.

그러면 Oracle database를 처음 사용해보는 사람은 뭘 해야하는지 막막해집니다.

참고자료(링크)를 통해 알아낸 방법을 보겠습니다.

terminal에 아래와 같은 명령어를 입력해서 데이터베이스에 접속합니다.

sqlplus / as sysdba

사용자 생성 및 권한 부여

데이터베이스 접속 이후에는 아래 명령어를 입력하여 사용자를 만들어줍니다.

  
CREATE USER <username> IDENTIFIED BY <password>;
!-- 예) CREATE USER C##limvik IDENTIFIED BY limvik;

예를 들어드린 CREATE 문장에서 C## 을 붙인 이유는 안붙이면 아래 에러가 떠서 그렇습니다. 당장 Oracle을 주력으로 사용할 것도 아니고, 테스트용이니 하라는대로 합니다.

ORA-65096: common user or role name must start with prefix C##

그리고 권한을 몽땅 줍니다.

  
GRANT ALL PRIVILEGES TO <username>;
!-- 예) GRANT ALL PRIVILEGES TO C##limvik

그러면 Grant succeeded. 라는 문장을 볼 수 있습니다.

Spring Boot 설정

다음은 Spring Boot 에서 properties를 설정할때는 아래와 같이 해줍니다. 위에서 생성한 사용자 예제를 기준으로 작성하였습니다.

spring.datasource.url=jdbc:oracle:thin:@localhost:8080:FREE
spring.datasource.username=C##limvik
spring.datasource.password=limvik
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver

url에서 FREE를 써야할 곳에 구버전의 ORACLE_SID인 XE(eXpress Edition) 사용하지 않도록 주의합니다.

Java, JPA

This post is licensed under CC BY 4.0 by the author.