[Spring, H2 database] 스프링 앱과 H2 데이터베이스 연결하기

사실상 내가 보려고 정리한 것이지만... 그동안 인강, 수업, 미션 하며 배운 걸 순서대로 차근차근 정리해 보았다.

(H2데이터베이스, 스프링 부트, gradle, JPA 사용)

0. H2 데이터베이스 설치

H2는 개발 및 테스트, 교육 용도의 DB이다. 홈페이지

• 가볍고(용량이 작다) 편리하다
• 웹 화면을 제공해 준다.

위 홈페이지에서 다운로드 및 설치 후 h2.sh파일을 실행한다.

(기본적으로는 홈(~)에 설치된다)

• H2 - bin - h2.sh 실행
  • git bash를 이용하면 편하다. cd ~/H2 - cd bin - ./h2.bat
  • 윈도우는 h2.bat (깃배시에서는 ./h2.bat) 실행
  • 맥은 ./h2.sh 실행
  • 참고 : 종료는 Ctrl + c 로 종료.

그러면 아래와 같은 '웹 콘솔' 창이 나온다.

처음에는 ''데이터베이스 파일(.db)''을 만들어야 한다.

• JDBC URL : 홈으로부터의 파일 경로를 말한다.
  • ~/test 홈에서 test파일을 말함.
  • test부분을 자신의 프로젝트명으로 바꿀 수 있다
• 열린 상태 그대로 [연결]을 누르면 창이 바뀐다.

홈에서 test.mv라는 이름의 .db파일(데이터베이스파일)이 생겼는지 확인한다.(cd, ls 또는 탐색기로 직접 확인)

JDBC URL처럼 파일(test)로 접근하게 되면, 웹 콘솔과 애플리케이션 간 충돌이 일어날 수 있

이를 방지하기 위해 연결을 끊고, 다시 접속하기 전에

JDBC URL 항목을 jdbc:h2:tcp://localhost/~/test 로 바꾼 뒤 다시 [연결]한다.

이렇게 접속하면 파일에 직접 접근하는 게 아닌, 소켓을 통해 접근하게 되어 여러 곳에서 접근 가능해진다.

만약 잘 안 되거나 오류가 발생하면, rm test.mv.db 로 test.mv.db파일을 완전히 삭제 후, 서버를 껐다 켠 다음 처음부터 다시 시도해 본다.

1. build.gradle, application.properties

build.gradle의 dependencies에 아래 의존성을 추가

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

(❗ 수정 후 gradle을 업데이트해야 한다)

application.properties에 아래 설정을 추가

spring.datasource.url=jdbc:h2:tcp://localhost/~/java-qna
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.hibernate.ddl-auto=create-drop

spring.h2.console.enabled=true
spring.h2.console.path=/h2-console

• spring.datasource.url : H2콘솔에서 JDBC URL 에 넣었던 경로와 같아야 한다.
• spring.jpa.show-sql , spring.jpa.properties.hibernate.format_sql: JPA를 사용하더라도 전달되는 쿼리문을 출력하게 하는 옵션
• spring.jpa.hibernate.ddl-auto : 테이블 자동 생성 설정.
  • create-drop : 서버 시작시 DB 테이블을 drop(삭제)후 다시 생성함
  • validate : 서버 시작시 DB 테이블을 drop하지 않음
• spring.h2.console ... : H2 DB 콘솔에 대한 접근 설정

2. DB에 넣을 클래스를 DB테이블과 매핑

자바 객체와 데이터베이스 테이블을 매핑하면, 데이터베이스 테이블이 자동으로 생성된다.

어떻게? JPA라는 도구를 사용하기 때문에 가능함.

데이터베이스와 연결되는 클래스들은 보통 repository 또는 domain 이라는 패키지를 만들어 관리한다.

DB에 넣을 클래스 (여기서는 User)를 DB테이블과 매핑한다.

• JPA는 ORM 기술을 사용한다.

  • ORM : Object Relational Mapping, 객체 - 관계형데이터베이스의 테이블을 맵핑하는 기술.

• 맵핑은 어노테이션을 통해 이루어진다.

import javax.persistence.*;

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

    @Column(nullable = false, length=20)
    private String userId;

    private String password;
    private String name;
    private String email;

    // getter and setter
}

각 어노테이션을 Ctrl+클릭 하면 해당 어노테이션의 기본값(default)를 볼 수 있으니 참고하며 작업하면 좋다.

• @Entity : 해당 클래스가 데이터베이스와 연결되는 클래스임을 명시한다. JPA가 관리하는 엔티티이자 DB의 테이블명이 됨.

• @Id : 해당 인스턴스변수를 PK(Primary Key)로 설정한다.

• Primary Key(PK) : 데이터베이스에서 각 데이터들을 식별하기 위한 고유 식별자를 의미함.

  • 보통은 PK를 자동증가하는 숫자로 사용하며private long id;를 @Id, @GeneratedValue로 설정해 사용한다.

  • @GeneratedValue : 우리가 직접 ++하지 않아도 DB가 자동으로 값을 생성해 더해준다.

• @Column : DB 테이블의 칼럼과 맵핑할 요소를 선언

  • nullable : 생략 가능한지에 대한 속성. 기본적으로 true이다.
  • length : 최대 길이에 대한 속성.

• ❗ 반드시 모든 인스턴스변수에 대한 getter, setter를 구현해 두어야 한다.

  (그래야 스프링이 자동으로 값을 넣고 뺄 수 있다)

3. CRUD 구현 - 인터페이스 선언

import com.codessquad.qna.User;
import org.springframework.data.repository.CrudRepository;

public interface UserReopsitory extends CrudRepository<User, Long> {
}

• CrudRepository<?, ?> : 이 인터페이스를 상속하면 CRUD 기본 기능을 지원받을 수 있다.
  • <?, ?> : 왼쪽 ?에는 DB에 넣고 빼는 객체 (여기서는 User)를, 오른쪽 ?에는 Primary Key(여기서는 id)의 타입(Long)을 넣어 준다.
• 해당 인터페이스를 선언하면 스프링에서 자동으로 그 구현체를 만들고, 스프링 빈에 등록해 준다.

4. Controller에서 DB 사용

• 컨트롤러에서, 선언한 인터페이스의 구현체를 사용하게 한다.

• CrudRepository에서 지원하는 메소드들 - save(), findAll(), findBy...() .. 를 활용해 컨트롤러에 CRUD를 구현한다.

import com.codessquad.qna.User;
import com.codessquad.qna.repository.UserReopsitory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.ArrayList;
import java.util.List;

@Controller
public class UserController {

    @Autowired
    private UserReopsitory userReopsitory;

    @PostMapping("/user/create")
    public String createUser(User user) {
        userReopsitory.save(user); // 저장
        return "redirect:/users";
    }

    @GetMapping("/users")
    public String showUser(Model model) {
        Iterable<User> allUsers = userReopsitory.findAll(); // 모두 조회
        model.addAttribute("users", allUsers);
        return "list";
    }

    @GetMapping("/{id}")
    public ModelAndView showProfile(@PathVariable Long id) {
        ModelAndView modelAndView = new ModelAndView("userProfile");
        modelAndView.addObject("user", userRepository.findById(id).get());
        return modelAndView;
    }

    // codes..
}

• @Autowired private UserReopsitory userReopsitory;

  : 스프링이 자동 생성해 준 UserRepository의 구현체를, 인스턴스변수UserRepository에 주입해 준다

• ModelAndView

이제 스프링 앱을 실행하고 브라우저에서 테스트한 뒤 H2를 확인하면 값이 잘 들어가 있을 것이다.