[H2DB] h2 데이터베이스 환경 설정과 스프링 부트 세팅

 H2DB란?

 

h2 데이터베이스는 자바 기반의 관계형 데이터베이스 관리 시스템(dbms) 입니다. 용량이 가볍고 스프링 부트에 기본적으로 내장되어 있어 단위 테스트나 로컬 환경 테스트에 적합합니다. in-memory 모드로 실행 시 설치가 따로 필요 없기 때문에 사용하기 편리하지만 애플리케이션이 종료 되면서 같이 데이터가 휘발되는 단점이 있습니다. 

파일로 데이터베이스를 관리하여 애플리케이션을 반복하여 실행하더라도 데이터를 관리할 수 있게 하고 여러 애플리케이션에서도 사용할  수 있는 방법을 알아 봅시다. 또한 콘솔 모드를 통해 데이터를 파악하고 스프링 부트에서 어떻게 h2를 세팅할 수 있는지 알아 보겠습니다.

 

 h2 설치하기

 

h2 데이터베이스는 별도의 설치 없이도 스프링에 기본적으로 내장되어 있기 때문에 설정을 통해 바로 사용할 수 있습니다. 하지만 이 경우 애플리케이션의 생명주기와 같게 되요. 애플리케이션이 종료되면 데이터가 초기화 됩니다. 이를 In-memory 모드라고 합니다. 우선은 h2를 설치하여 Server 모드로 테스트 환경을 구축해 보겠습니다. 그 후 In-memory 구축 방법도 알아 봅시다.

 

h2 의존성 설정하기

 

스프링 부트에서 h2를 사용해 주기 위해 build.gradle 파일에 dependency를 추가해 줍니다. 

 

runtimeOnly 'com.h2database:h2'

 

 

(인텔리제이 기준) 프로젝트 네비게이터를 확인해 보면 External Libraries가 있습니다. 

 

 

그 중 com.h2.database:h2:[h2 version]가 있습니다. 여기서 버전 확인이 가능합니다. 이름 뒷부분에서 메이저, 마이너, 패치 버전을 확인 할 수 있는데 위 사진에서 버전은 2.2.224가 됩니다. dependency 설정 시 버전을 따로 명시하지 않아 현재 기준 최신 버전이 설치되었습니다. 따로 버전을 명시하여 dependency를 설정하면 해당 버전의 library가 추가된 걸 확인할 수 있습니다.

 

h2 데이터베이스 엔진 다운로드

 

https://h2database.com/html/main.html

H2 Database Engine

 

이제 위 사이트로 이동합니다. h2 데이터베이스 엔진을 다운로드 받을 수 있는 사이트 입니다. 이 사이트에 중간 쯤에 이렇게 생긴 부분이 있는데 

 

 

추가된 라이브러리와 버전이 동일하다면 다운로드 버튼을 눌러 진행해 주면 됩니다. 윈도우에 경우 Windows Installer, 다른 운영체제를 사용 중이라면 All Platforms를 눌러 다운로드 받습니다. 

만약 버전이 맞지 않다면 All Downloads 버튼을 눌러 줍니다. 

 

All Downloads 버튼을 누르면 위 사이트로 이동하는데, 최신 버전 2개 정도가 리스트에 보이게 됩니다. 여기에도 원하는 버전이 없다면 Archive Downloads 섹션에 링크를 눌러줍니다. 

 

이전 버전을 다운로드 받을 수 있습니다. Windows의 경우 Windows Installer를 사용하면 되고 맥의 경우 Platform-Independent Zip을 눌러 zip 파일을 다운로드 받아 주세요. 

 

 

 

압축을 풀어 줍니다. h2 폴더를 확인할 수 있습니다. 

 

h2 콘솔 사용하기

 

압축을 풀면 h2 폴더를 확인할 수 있는데, 터미널을 사용해서 해당 폴더로 이동해 줍니다. 폴더 이동후 bin 까지 이동해 주세요. 그러면 경로가 ~/지정한 경로/h2/bin이 되어 있을 거에요. 

 

 

이 상태에서 실행 권한을 바꿔 주겠습니다. 

 

chmod 755 h2.sh

 

해당 경로에서 ls 명령어를 입력하면 h2.sh 파일을 확인할 수 있습니다. 

 

./h2.sh

 

위 명령어를 입력하여 h2를 실행해 줍니다. 

 

실행하게 되면 웹 브라우저를 통해 콘솔에 접속하게 됩니다. 최초 접근시에는 파일로 바로 접속해야 합니다. 최초 1회만 파일로 접근합니다. 위 경로로 연결하면 사용자 계정 디렉토리에 test.mv.db 파일이 생성됩니다. 파일이 생성되고 나면 tcp 소캣을 사용하여 접속해 줍니다. 이렇게 해야 콘솔과 애플리케이션을 동시에 접근했을 때 오류가 발생하지 않습니다. 

 

 

> tcp로 접속

 

데이터베이스 파일이 자동 생성되지 않는 경우

파일로 바로 접속시 not found, either pre-create it or allow remote database creation (not recommended in secure enviroments) 에러가 발생할 경우 직접 데이터베이스 파일을 생성하여 해결할 수 있습니다. 

 

 

[데이터베이스 이름].mv.db 파일을 생성해 줍니다. 계정 디렉토리 하위에 생성해 줍니다. 위 과정에서 최초 1회시 파일로 접속하고 그 이후에는 tcp로 접속해야 한다고 했었는데요, 지금의 경우 파일로 접속하여 자동으로 데이터베이스 파일을 생성해 주는 단계를 직접 수동으로 설정해 준 것이기 때문에 tcp로 접속 하면 됩니다. 

 

 

만약 test2.mv.db 파일을 생성했다면 jdbc:h2:tcp://localhost/~/test2로 접속하면 됩니다. 

 

 Spring boot 설정하기

 

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
runtimeOnly 'com.h2database:h2'

 

build.gradle 에 의존성을 설정해 줍니다. jpa를 사용해서 테이블을 생성해 주기 위해 같이 추가해 주었습니다. 

 

Server mode

 

db 엔진을 설치한 후 이 엔진을 구동하는 방식입니다. 앞서 h2 데이터베이스 엔진을 설치하고 설정해 주었으므로 이를 사용해보겠습니다. 

서버 모드를 사용하면 파일로 데이터베이스를 관리하므로 애플리케이션을 종료하더라도 로컬에 데이터가 남아 있습니다. 하나의 애플리케이션 뿐만 아니라 여러개의 애플리케이션에서 접속 가능합니다.

 

spring.datasource.url=jdbc:h2:tcp://localhost/~/[데이터베이스 이름]
spring.datasource.username=[user name]
spring.datasource.password=[password]
spring.datasource.driver-class-name=org.h2.Driver

spring.jpa.hibernate.ddl-auto=update
spring.jpa.properties.hibernate.format_sql=true

spring.h2.console.enabled=true

logging.level.org.hibernate.SQL=debug
logging.level.org.hibernate.type.descriptor.sql=trace

> application.properties

 

만약 데이터베이스의 이름을 test2로 설정했고, 별도의 username과 password를 설정하지 않았다면 아래와 같이 설정됩니다.

 

spring.datasource.url=jdbc:h2:tcp://localhost/~/test2
spring.datasource.username=sa
spring.datasource.password=
spring.datasource.driver-class-name=org.h2.Driver

 

h2를 설정하는 건 첫 4줄 입니다. ddl-auto 의 경우 데이터베이스 생성 전략을 설정하는 것인데 애플리케이션 실행 시 마다 데이터베이스를 새로 생성하는 것이 아닌 업데이트 방식으로 설정하기 위해 ddl-auto를 update로 설정해 주었습니다.

 

 Entity 사용해서 테스트하기

 

package org.youable.personal_study.model;

import jakarta.persistence.Entity;
import jakarta.persistence.Id;

@Entity
public class Member {
    @Id
    private String id;
    private String name;
}

 

테스트용 Entity를 만들어 줍니다. 이후 Application을 실행해 주세요. 

 

 

jpa에 의해 자동으로 테이블이 생성된 것을 콘솔에서 확인할 수 있습니다. 만약 보이지 않는 경우 콘솔을 새로고침 하거나, 재 접속, 혹은 설정이 잘 못 되지 않았는지 확인해봅니다.

---

 

In-memory Mode

 

In-memory mode (이하. 인메모리 모드)는 애플리케이션 내부에 내장되어 있는 DB 엔진을 사용합니다. 애플리케이션의 메모리에 저장되기 때문에 애플리케이션의 생명주기와 같습니다. 애플리케이션을 실행하면 구동되고, 종료하면 데이터가 저장되지 않고 사라집니다. 일회성 테스트, 단위 테스트 등으로 적합한 방식입니다.

 

application.properties에서 spring.datasource.url을 아래와 같이 변경합니다.

 

spring.datasource.url=jdbc:h2:mem:testdb

 

로컬 호스트에서 테스트하는 경우

localhost:8080/h2-console

 

url로 접속

jdbc url은 spring.datasource.url에서 지정해 준 경로와 동일하게 작성해 줍니다. 이후 connect를 눌러 연결해주면 됩니다.

 

인메모리 방식은 애플리케이션이 종료 됨에 따라 데이터가 함께 휘발됩니다. 이 경우 실행시 마다 필요한 데이터를 다시 생성해야 하는 번거로움이 있습니다. 그러나 defer-datasource-initializaion을 사용하면 실행 시 마다 초기에 필요한 데이터를 설정하기 위해 sql을 자동으로 실행해 줄 수 있는 방법이 있습니다.

 

  jpa:
    hibernate:
      ddl-auto: create
    show-sql: true
    properties:
      hibernate.format_sql: true
    defer-datasource-initialization: true # 추가할 부분

 

Hibernate가 초기화 된 이후 data.sql을 실행하는 옵션입니다. data.sql 파일은 resources 폴더에 추가해 줍니다.

insert into member(name)
values ('tester1'),
       ('tester2');

 

data.sql에는 초기에 실행되어야 하는 쿼리문을 작성해 줄 수 있습니다.

 

 Outro

 

간단한 테스트 프로젝트와 개발 환경 셋팅 시 h2 설정을 자주 하게 되는데, 할 때마다 헷갈리는 부분이 있어 한번 정리하면 좋겠다는 생각이 들었습니다. 혹시나 틀린 부분이 있다면 언제든 알려주시면 감사하겠습니다

 

 참고 사이트

https://colabear754.tistory.com/193

[Spring Boot] H2 DB Embedded Mode 사용하기

 

https://phantom.tistory.com/59

[H2DB] H2 Database 설치 및 사용법

 

https://dev-j.tistory.com/10

스프링부트 H2 데이터베이스 설정 방법