[Database] H2 연결 옵션

 

🎯 Goals

• SpringBoot - H2 DB 간 적절한 연결 방법을 선택할 줄 안다.
• SpringBoot - H2 DB Automatic mixed 연결을 직접 실행해본다.

 

H2 DB 연결 3가지 모드

1. Embedded Mode

이름 그대로 JVM App 내에 DB를 '내장'하는 모드다.

네트워크 IO가 없기 때문에 가장 빠른 대신 외부 클라이언트로 접근이 불가능하다는 단점이 있다.
(심지어 로컬 호스트 내의 다른 앱이라도 불가하다.)

JVM 내에 DB 가 내장된다.

 

2. Server - Client Mode

H2 DB 공식문서에서 추천하는 방식으로 외부에서 접근이 가능하다.

대신, TCP/IP 네트워크 IO 로 데이터 통신이 이뤄지기 때문에 Latency 발생이 불가피하다.

 

 It's recommended to use the client-server model instead,
the client side may interrupt own threads.

3. Mixed Mode

최초 DB Connectino 을 맺은 클라이언트가 서버로 DB를 감싸는 매커니즘이다.

여기서 Mix 는 Embedded + Server 를 혼합했다는 뜻인데

최초로 DB를 연결한 앱이 자체적인 Server 를 띄워 H2 DB 를 Wrapping 하는 방식이다.

 

 

최초 클라이언트는 Embedded DB를 사용하므로 Latency 없이 DB를 사용할 수 있다. 동시에 이 최초 클라이언트 앱이 곧 서버 호스팅을 맞는다.

외부 앱에서 동일한 URL 로 접근 가능하다.

대신, 외부 접근 클라이언트도 Server-Client 모델과 마찬가지로 네트워크 IO로 통신하기 때문에 Latency가 발생한다.

 

 

Mixed 모드는 다시 2가지로 나뉜다.
(1) Client (App) - Server (App) Mode
아직 연결을 해보지 않았다.
(2) Automatic mixed mode
이 글에서 설명하는 방식이다.
아래 사용 방법을 기술했다.

 

 

그럼, 최초 클라이언트가 연결을 끊으면 서버도 해제되나?

맞다. 대신 동시에 연결중인 다른 클라이언트가 서버를 자동 재시작한다.

In-memory 모드를 지원하지 않는다.lock.db 파일로 Private IP/Port 를 관리하게끔 설계 되어있기 때문이다.

 

 

요약 비교

	Embedded Mode	Server - Client Mode	Mixed Mode
URL Example	- jdbc:h2:<file-path> - jdbc:h2:mem:<db-name>	- jdbc:h2:tcp//localhost/~/<db-name> - jdbc:h2:tcp://<server-ip>:<port>/<path>/<db-name>	- jdbc:h2:<url>;AUTO_SERVER=TRUE - jdbc:h2:<db-relative-file-path>;AUTO_SERVER=TRUE
Pros	No Latency	Support remote connect	Fast for server app Support remote connect
Cons	Not support remote connect	Network Latency	Network Latency for seocond clients ~

 

When to use?

Q. IDE에서 단순 Persistence Layer 유닛 테스트 코드를 돌린다?

A. Embedded Mode

 

Q. 로컬 외 외부 입력을 지원해야한다?

A.Server - Client Mode

 

Q. 로컬환경이지만 테스트 코드 외에도 실제 DB 상태를 들여다볼 필요가 있다? (ex. Intellij IDEA 연결)

A. (Automatic) Mixed Mode

 

 

실습 예제

Intellij IDEA - H2 DB Connect using Automatic Mixed mode

Automatic Mixed Mode 의 핵심은 "같은 DB에 모두 동일한 URL 로 접근한다" 이다.

이 때 주의할 점은 반드시 끝에 `AUTO_SERVER=TRUE` 옵션을 지정해야 한다는 것이다.

임의의 포트를 지정하면 Automatic Mixed Mode 가 올바르게 작동하지 않는다.

 

(1) application.yaml 파일 설정

 

하단 URL 로 접속시 `cafe-kiosk.lock.db` 파일이 홈 디렉토리에 생성된다.

lock.db 파일은 오로지 서버로 지정된 하나의 커넥션에서만 접근 가능하다.

따라서 임의의 포트번호로 동일한 `${DB-NAME}` 으로 접근할 경우 lock 파일 때문에 접근 불가능하다.

jdbc:h2:~/cafe-kiosk;AUTO_SERVER=TRUE

 

(2) SpringBoot 실행

실행후 spring.datasource.url 에 명시한  경로로 가보면 ${db-name}.lock.db 파일을 볼 수 있다.

lock.db 파일에서 H2 DB Server 의 Private IP/PORT 를 확인할 수 있다.

 

SpringBoot App 을 구동시키면 SpringBoot App 이 최초의 클라이언트이자 H2 Server 의 호스팅 주체가된다.

SpringBoot App 내에서 맺는 JDBC 연결은 `Embedded` 모드가 되어 네트워크 Latency 가 발생하지 않는다.

 

(3) Intellij IDEA - DB 연결

Intellij IDEA > Database > Data Sources and Drivers > URL

URL 끝에 `AUTO_SERVER=TRUE` 옵션을 지정한다.

이는 2번째 Connection 으로 TCP/IP Network latency 발생한다.

 

(4) 연결 확인

연결 완료

 

 

Conclusion

SpringBoot 로컬 개발 환경에서 Persistency 유닛 테스트 코드를 실행하고, DB 상태값을 IDE 로 확인하고 싶다면 H2 DB 의 Automatic Mixed Mode 를 활용해보자.

 

jdbc:h2:~/<db-name>;AUTO_SERVER=TRUE

설정으로 뚝딱가능하다.

---

🔗 Reference

Features