(스프링) JDBC 이해하기

by

개념을 설명하기 전에 build.gradle에 다음 코드를 추가하여 테스트에서 lombok을 사용하도록 하겠습니다.

dependencies {
    ...

    //테스트에서 lombok 사용
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
}

H2 데이터베이스 설정

H2
: H2 데이터베이스는 개발이나 테스트 목적으로 사용하기 좋은 가볍고 편리한 DB입니다. 그리고 SQL을 실행할 수 있는 웹 화면을 제공합니다.

다운로드 및 설치

'추천 관련글,

https://www.h2database.com/html/download-archive.html

아카이브 다운로드

www.h2database.com

h2 데이터베이스 버전은 스프링 부트 버전과 일치합니다.

MAC, 리눅스 사용자

  • 권한 주기: chmode 755 h2.sh
  • 실행: ./h2.sh

윈도우 런처

  • 실행: h2.bat(파일이 있는 디렉토리에서 실행)

데이터베이스 파일을 만드는 방법


  • 사용자 이름을 sa로 입력
  • JDBC URL에 다음을 입력합니다. jdbc:h2:~/test (처음 한 번 입력, 연결을 직접 누르자)
  • 내 컴퓨터에 ~test.mv.db 파일이 생성됩니다.
  • 이후 jdbc:h2:tcp://localhost/~/test를 통해 접속한다.

H2 데이터베이스가 정상적으로 생성되지 않는 경우
: JDBC URL에 jdbc:h2:~/test를 입력하더라도 오류 메시지가 나타나며 H2 데이터베이스가 생성되지 않을 수 있습니다.

솔루션
1) H2 데이터베이스 종료 및 재시작
2) 웹 브라우저 자동 실행 시 주소창의 포트 번호 앞부분이 숫자가 아닌 localhost로 변경됩니다.

JDBC 이해

JDBC가 등장한 이유
: 어플리케이션을 개발할 때 중요한 데이터는 대부분 데이터베이스에 저장됩니다.

클라이언트, 애플리케이션 서버, DB


클라이언트가 애플리케이션 서버를 통해 데이터를 저장하거나 검색할 때 애플리케이션 서버는 다음과 같은 프로세스를 통해 데이터베이스를 사용합니다.

애플리케이션 서버 및 데이터베이스 – 일반적인 사용법


  1. 연결 연결 : 주로 TCP/IP를 사용하여 연결을 연결합니다.
  2. SQL 전달 : Application Server는 연결된 연결을 통해 DB가 이해할 수 있는 SQL을 DB에 전달한다.
  3. 결과 응답 : DB는 전달받은 SQL을 실행하고 그 결과를 응답한다. 애플리케이션 서버는 응답 결과를 활용합니다.

Application Server 및 DB – DB 변경


문제는 각 데이터베이스마다 연결 방법, SQL 전송 방법, 결과를 응답으로 받는 방법이 다르다는 것입니다. 참고로 수십 개의 관계형 데이터베이스가 있습니다.

2 문제

1) 데이터베이스를 다른 종류의 데이터베이스로 변경하는 경우에는 Application Server에서 개발한 데이터베이스 사용 코드도 변경해야 합니다.

2) 개발자는 각 데이터베이스에 연결하고 SQL을 전달하고 결과를 받는 새로운 방법을 배워야 합니다.

–> 이 문제를 해결하기 위해 JDBC라는 자바 표준이 등장!

JDBC 표준 인터페이스
: JDBC(Java Database Connectivity)는 Java가 데이터베이스에 연결할 수 있도록 하는 Java API입니다. JDBC는 데이터베이스에서 데이터를 쿼리하거나 업데이트하는 방법을 제공합니다.


일반적으로 다음 3가지 기능표준 인터페이스로 정의되어 제공됩니다.

  • java.sql.Connection – 연결
  • java.sql.Statement – SQL을 포함하는 명령문
  • java.sql.ResultSet – SQL 요청 응답

Java는 이와 같은 표준 인터페이스를 정의합니다. 이제부터 개발자는 이 표준 인터페이스를 사용하여 개발하기만 하면 됩니다. 그러나 인터페이스가 있다고 해서 기능이 동작하지 않는다. 각 DB 회사는 이 JDBC 인터페이스를 자신의 DB에 맞게 구현하여 라이브러리로 제공하는데 이를 JDBC 드라이버라고 합니다.

ex) MySQL DB에 접근할 수 있는 것을 MySQL JDBC 드라이버라고 하고, Oracle DB에 접근할 수 있는 것을 Oracle JDBC 드라이버라고 합니다.

MySQL 드라이버 사용


오라클 드라이버 사용


정리하다

JDBC의 출현으로 두 가지 문제가 해결되었습니다.

1) 데이터베이스 유형이 변경되면 응용 서버의 데이터베이스 사용 코드도 변경되어야 합니다.

애플리케이션 로직은 이제 JDBC 표준 인터페이스에만 의존합니다. 따라서 데이터베이스를 다른 유형의 데이터베이스로 변경하려면 JDBC 구현 라이브러리만 변경하면 됩니다. 따라서 다른 유형의 데이터베이스로 변경하더라도 Application Server의 사용 코드를 그대로 유지할 수 있습니다.

2) 개발자가 각각의 데이터베이스에 연결하여 SQL을 전송하고 그 결과에 대한 응답을 받는 방법을 배워야 하는 문제.

개발자는 JDBC 표준 인터페이스를 사용하는 방법만 배우면 됩니다. 일단 학습하면 수십 개의 데이터베이스에 동일하게 적용할 수 있습니다.

표준화의 한계
: JDBC의 등장으로 많은 것들이 편리해졌지만 각 데이터베이스는 SQL과 데이터 유형의 용도가 다릅니다. ANSI SQL이라는 표준이 있긴 하지만 일반적인 부분만 공통적으로 사용하기 때문에 한계가 있습니다. 일반적으로 실무에서 기초로 사용되는 페이징 SQL은 데이터베이스마다 용도가 다릅니다. 결국 데이터베이스를 변경하면 JDBC 코드는 변경하지 않아도 되지만 SQL은 데이터베이스에 맞게 변경해야 한다. 참고로 JPA(Java Persistence API)를 사용하면 데이터베이스마다 다른 SQL을 정의하는 문제를 많이 해결할 수 있다.

JDBC 및 최신 데이터 액세스 기술

JDBC는 매우 오래된 기술이며 사용 방법도 복잡합니다. 최근에는 JDBC를 직접 사용하는 것보다 편리하게 사용할 수 있는 다양한 기술이 있으며 SQL Mapper와 ORM 기술로 나눌 수 있다.

JDBC 직접 사용


SQL 매퍼


SQL 매퍼
장점 : JDBC를 편리하게 사용할 수 있도록 도와줍니다.
SQL 응답 결과를 객체로 편리하게 변환합니다.
JDBC 반복 코드를 제거합니다.
불리 : SQL은 개발자가 직접 작성해야 합니다.
대표기술 : 스프링 JdbcTemplate, 마이바티스

ORM 기술


ORM 기술

ORM은 개체를 관계형 데이터베이스 테이블에 매핑하는 기술입니다. 이 기술 덕분에 개발자가 반복되는 SQL을 직접 작성하지 않고, ORM 기술이 개발자 대신 동적으로 SQL을 생성하고 실행합니다. 또한 중간에 데이터베이스마다 다른 SQL을 사용하는 문제를 해결한다.

– 대표기술 : JPA, Hibernate, Eclipse Link

– JPA는 자바 진영의 ORM 표준 인터페이스로 이를 구현한 것으로 Hibernate, Eclipse Link 등의 구현 기술이 있다.

SQL 매퍼 대 ORM 기술

SQL Mapper와 ORM 기술에는 장단점이 있습니다.

SQL Mapper를 사용하면 SQL만 직접 작성하는 경우 SQL Mapper가 나머지 번거로운 작업을 처리합니다. SQL을 작성할 줄 알면 SQL Mapper를 빠르게 배우고 사용할 수 있습니다.

ORM 기술은 SQL 자체를 작성할 필요가 없기 때문에 개발 생산성을 크게 향상시킵니다. 편리하긴 하지만 쉬운 기술은 아니어서 실전에서 활용하려면 깊이 있는 학습이 필요하다.

중요한 !
: 이러한 모든 기술은 내부적으로 JDBC를 사용합니다. 따라서 JDBC를 직접 사용하지 않더라도 JDBC가 작동하는 기본 원리는 알고 있어야 합니다. 그래야만 기술을 더 깊이 이해할 수 있고, 무엇보다 문제가 발생했을 때 근본적인 문제를 찾아 해결할 수 있습니다. JDBC는 Java 개발자가 반드시 알아야 하는 필수 기본 기술입니다.

데이터베이스 연결

주의
: H2 데이터베이스 서버는 항상 실행 중인 상태로 두어야 합니다.

ConnectionConst – 상수

public abstract class ConnectionConst{
    public static final String URL = "jdbc:h2:tcp://localhost/~/test";
    public static final String USERNAME = "sa";
    public static final String PASSWORD = "";
}
  • DB 접근에 필요한 기본 정보를 일정하게 하여 편리하게 사용할 수 있도록 합니다.
  • 추상화하는 이유는 생성을 방지하기 위함입니다.

DB연결유틸

import static hello.jdbc.connection.ConnectionConst.*;

@Slf4j
public class DBConnectionUtil{
    
    public static Connection getConnection() {
        try {
            Connection con = DriverManager.getConnection(URL, USERNAME, PASSWORD);
            log.info("get connection={}, class={}", con, con.getClass());
            return con;
        }catch(SQLException e){
            throw new IllegalStateException(e);
        }
    }
}
  • 데이터베이스 연결은 JDBC에서 제공하는 DriverManager.getConnection(..)을 사용한다.
  • 라이브러리에서 데이터베이스 드라이버를 찾고 해당 드라이버에서 제공하는 연결을 반환합니다.
  • H2 데이터베이스 드라이버가 작동하고 실제 데이터베이스에 대한 연결을 설정하고 결과를 반환합니다.
  • URL, USERNAME 및 PASSWORD는 getConnection의 인수로 전달됩니다(import static을 사용하므로 ConnectionConst.URL, ConnectionConst.USERNAME …을 사용할 필요가 없습니다).

DB연결유틸테스트

@Slf4j
class DBConnectionUtilTest{
    
    @Test
    void connection(){
        Connection con = DBConnectionUtil.getConnection();
        asserThat(con).isNotNull();
    }
}

실행 결과

DBConnectionUtil - get connection=conn0: url=jdbc:h2:tcp://localhost/~/test 
user=SA, class=class org.h2.jdbc.JdbcConnection

실행 결과를 보면 H2 데이터베이스 드라이버에서 제공하는 H2 전용 연결인 class=class org.h2.jdbc.JdbcConnection을 확인할 수 있다.

JDBC DriverManager 연결 이해

지금까지 코드로 확인했던 과정을 자세히 살펴보겠습니다.

JDBC 연결 인터페이스 및 구현


  • JDBC는 표준 연결 인터페이스 java.sql.Connection을 정의합니다.
  • H2 데이터베이스 드라이버는 JDBC 연결 인터페이스를 구현하는 org.h2.jdbc.JdbcConnection의 구현을 제공합니다.

DriverManager 연결 요청 흐름


JDBC에서 제공하는 DriverManager는 라이브러리에 등록된 DB 드라이버를 관리하고 연결을 획득하는 기능을 제공합니다.

1. 애플리케이션 로직에 연결이 필요한 경우 DriverManager.getConnection()을 부르다

2. DriverManager 라이브러리에 등록된 드라이버 목록을 자동으로 인식하고 해당 드라이버에 다음 정보를 전달하여 연결 가능 여부를 확인합니다.

– URL : 예) jdbc:h2:tcp://localhost/~/test

– 이름, 비밀번호 접근 등에 필요한 추가 정보

– 여기에서 각 드라이버는 URL 정보를 확인하여 드라이버가 요청을 처리할 수 있는지 확인합니다. 예를 들어 URL이

jdbc:h2로 시작하여 h2 데이터베이스에 액세스하기 위한 규칙입니다. 따라서 H2 드라이버는 사용자가 처리합니다.

따라서 실제 데이터베이스에 연결하고 연결을 획득한 다음 클라이언트에 반환합니다.

3. 이렇게 찾은 연결 구현은 클라이언트로 반환됩니다.

JDBC 개발 – 등록

이제 본격적으로 JDBC를 이용한 애플리케이션 개발을 시작해 보자. JDBC를 이용하여 간단하게 데이터베이스의 멤버 데이터를 관리하는 기능을 개발해 보자.

schema.sql – 멤버 테이블

drop table member if exists cascade;
create table member {
    member_id varchar(10);
    money integer not null default 0,
    primary key (member_id)
};

구성원 – 도메인

@Data
public class Member {
    
    private String memberId;
    private int money;
    
    public Member(){}
    
    public Member(String memberId , int money){
        this.memberId = memberId;
        this.money = money;
    }
}
  • 회원 ID와 회원이 보유한 금액을 나타내는 간단한 클래스입니다.

MemberRepositoryV0 – 회원 등록

/ **
  * JDBC - DriverManager 사용
  */
@Slf4j
public class MemberRepositoryV0 {
    
    public Member save(Member member) throws SQLException {
        String sql = "insert into member(member_id, money) values(?, ?)";
        
        Connection con = null;
        PreparedStatement pstmt = null;
        
        try{
            con = getConnection();
            pstmt = con.prepareStatement(sql);
            pstmt.setString(1, member.getMemberId());
            pstmt.setInt(2, member.getMoney());
            pstmt.executeUpdate();
            return member;
        }catch (SQLException e){
            log.error("db error", e);
            throw e;
        }finally {
            close(con, pstmt, null);
        }
    }
    
    private void close(Connection con, Statement stmt , ResultSet rs){
        if(rs != null){
            try{
               rs.close();
            } catch(SQLException e){
               log.info("error", e);
            }
        }
        
        if(stmt != null){
            try{
              stmt.close();
            }catch(SQLException e){
              log.info("error", e);
            }
        }
    }
    
    private Connection getConnection(){
        return DBConnectionUtil.getConnection();
    }
}

연결 획득

  • getConnection() : 앞에서 생성한 DBConnectionUtil을 통해 데이터베이스 연결을 획득한다.

save() – SQL 전달

  • SQL : 데이터베이스에 전달할 SQL을 정의하고 여기에 데이터를 등록해야 하므로 insert sql을 준비한다.
  • con.prepareStatement(SQL) : 데이터베이스로 전송할 SQL과 파라미터로 전송할 데이터를 준비한다.
    • sql : member(member_id, money) 값(?, ?)에 삽입;
    • pstmt.setString(1, member.getMemberId()) : 첫 번째 ? SQL에서는 문자이기 때문에 setString을 사용합니다.
    • pstmt.setInt(2, member.getMoney()): 두 번째 SQL ?에 값을 할당하고 Int 유형의 숫자이므로 setInt를 지정합니다.
  • pstmt.executeUpdate() : Statement를 통해 작성된 SQL은 연결을 통해 실제 데이터베이스로 전달된다. 참고로 executeUpdate()는 int를 반환하고 영향을 받는 DB 행의 수를 반환합니다. 여기에 하나의 행이 등록되어 있으므로 1이 반환됩니다.

리소스 정리
: 쿼리를 실행한 후 리소스를 정리해야 합니다. 여기에서는 Connection 및 PreparedStatement를 사용했습니다. 리소스를 정리할 때는 항상 역순으로 수행해야 합니다. 연결을 먼저 획득하고 연결을 통해 PreparedStatement를 생성하므로 리소스 반환 시 PreparedStatement를 먼저 닫은 후 연결을 닫을 수 있습니다. ResultSet은 결과를 검색하는 데 사용됩니다.

주의 !
: 자원을 정리하세요! should do 예외 발생 여부와 상관없이 항상 실행되어야 하므로 finally 문은 주의해서 작성해야 합니다. 이를 리소스 누수라고 하며 결과적으로 연결 부족으로 인해 장애가 발생할 수 있습니다.

SQL 인젝션 방지
: PreparedStatement는 Statement의 자식 타입으로 ?를 통한 파라미터 바인딩을 가능하게 한다. 참고로 SQL 인젝션 공격을 방지하기 위해서는 PreparedStatement를 통한 파라미터 바인딩 방식을 사용해야 합니다.

MemberRepositoryV0Test – 회원 등록

class MemberRepositoryV0Test {

    MemberRepositoryV0 repository = new MemberRepositoryV0();
    
    @Test
    void crud() throws SQLException {

        //save
        Member member = new Member("memberV0", 10000);
        repository.save(member);
    }
}

실행 결과


– memberV0, 10000의 데이터가 성공적으로 저장되었습니다.

– 참고로 두 번 실행하면 중복 PK 오류가 발생합니다. 이 경우 데이터를 삭제하고 다시 실행하십시오.

JDBC 개발 – 쿼리

이번에는 JDBC를 통해 이전에 저장된 데이터를 불러오는 기능에 대해 알아보겠습니다.

MemberRepositoryV0 – 구성원 조회 추가

...
public Member findById(String memberId) throws SQLException {
    String sql = "select * from member where member_id = ?";
    
    Connection con = null;
    PreparedStatement pstmt = null;
    ResultSet rs = null;
    
    try {
        con = getConnection();
        pstmt = con.preparedStatement(sql);
        pstmt.setString(1, memberId);
        
        rs = pstmt.executeQuery();
        
        if(rs.next()){
            Member member = new Member();
            member.setMemberId(rs.getString("member_id"));
            member.setMoney(rs.getInt("money"));
            return member;
        }else {
            throw new NoSuchElementException("member not found memberId =" + memberId);
        }
    }catch(SQLException e){
        log.error("db error", e);
        throw e;
    }finally{
        close(con,pstmt,rs);
    }
}
...

findById() – 쿼리 실행

  • sql: 데이터 조회를 위해 선택 SQL 준비
  • rs = pstmt.executeQuery() executeUpdate()는 데이터를 변경하는 데 사용되지만 executeQuery()는 데이터를 검색하는 데 사용됩니다. executeQuery()는 결과를 ResultSet에 넣고 반환합니다.

결과 집합

  • 결과 집합는 다음과 같은 데이터 구조입니다. 일반적으로 선택 쿼리의 결과는 순서대로 입력됩니다.
    • 예를 들어 member_id를 선택하면 money를 지정하면 member_id, money라는 이름으로 데이터가 저장됩니다.
    • select *는 테이블의 모든 열을 지정합니다.
  • 결과 집합 내부에 커서 다음 데이터로 이동하여 검색할 수 있습니다.
  • rs.next() : 호출하면 커서가 다음으로 이동합니다. 참고로 첫 번째 커서가 데이터를 가리키고 있지 않기 때문에 rs.next() 데이터를 검색하려면 처음으로 한 번 호출해야 합니다.
    • rs.next()의 결과가 true이면 커서 이동 결과 데이터가 있음을 의미합니다.
    • rs.next()의 결과가 false이면 커서가 가리키는 데이터가 더 이상 없다는 의미입니다.
  • rs.getString(“구성원 ID”) : 현재 커서 위치의 member_id 데이터를 String 타입으로 변환
  • rs.getInt(“돈”) : 현재 커서 위치의 money 데이터를 int형으로 변환

ResultSet 예


rs.next()가 처음 호출되면 커서가 가리키는 곳에 member1이 존재하므로 커서가 이동하여 true를 반환합니다.

rs.next()를 두 번 호출하면 커서가 가리키는 곳에 member2가 존재하므로 커서가 이동하여 true를 반환합니다.

rs.next()를 세 번 호출하면 커서가 가리키는 위치에 데이터가 없기 때문에 커서가 이동하며 false를 반환한다.

findById()의 목적은 하나의 멤버를 찾는 것이므로 검색 결과는 항상 1이므로 while 대신 if를 사용합니다.

MemberRepositoryV0Test – 구성원 조회 추가

...

// findById
Member findMember = repository.findById(member.getMemberId());
log.info("findMember={}", findMember);
asserThat(findMember).isEqualTo(member);

...

실행 결과

MemberRepositoryV0Test - findMember=Member(memberId=memberV0, money=10000)

  • 회원가입 후 즉시 결과 확인
  • 참고로 멤버 객체의 참조 값이 아닌 실행 결과에 실제 데이터가 나타나는 이유는 Lombok의 @Data가 toString()을 제대로 오버라이드하여 보여주기 때문입니다.
  • 동일하다() : findMember.equals(멤버)를 비교합니다. 결과가 true인 이유는 Lombok의 @Data가 객체의 모든 필드를 사용하도록 equals()를 재정의하기 때문입니다.
  • 마찬가지로 2회 실행 시 PK 중복 오류 –> 데이터 삭제 후 재실행

JDBC 개발 – 수정, 삭제

편집 및 삭제는 등록과 유사하지만 등록, 수정 및 삭제와 같이 데이터를 변경하는 쿼리에 대해 executeUpdate()를 사용할 수 있습니다.

MemberRepositoryV0 – 구성원 편집 추가

public void update(String memberId, int money) throws SQLException{
    String sql = "update member set money=? where member_id=?";
    
    Connection con = null;
    PreparedStatement pstmt = null;
    
    try {
        con = getConnection();
        pstmt = con.prepareStatement(sql);
        pstmt.setInt(1, money);
        pstmt.setString(2, memberId);
        int resultSize = pstmt.executeUpdate();
        log.info("resultSize={}", resultSize);
    }catch(SQLException e){
        log.error("db error", e);
        throw e;
    }finally {
	    close(con,pstmt, null);
    }
}

실행 쿼리()
: 쿼리를 실행하고 영향을 받는 행 수를 반환합니다. 여기서는 하나의 데이터만 변경하였기 때문에 결과적으로 1이 반환되며, 멤버가 100명일 때 전체 멤버의 데이터를 한번에 수정하는 업데이트 SQL을 실행하면 결과는 100이 됩니다.

MemberRepositoryV0Test – 구성원 편집 추가

...

// update: money : 10000 --> 20000
repository.update(member.getMemberId(), 20000);
Member updatedMember = repository.findById(member.getMemberId());
assertThat(updatedMember.getMoney()).isEqualTo(20000);

...
  • 멤버 데이터의 돈을 10000 –> 20000으로 수정하고 DB에서 데이터를 불러와 20000으로 변경된 것을 확인한다.

실행 로그

MemberRepositoryV0 - resultSize=1

MemberRepositoryV0 – 삭제 멤버 추가

public void delete(String memberId) throws SQLException {
    
    String sql = "delete from member where member_id=?";
    
    Connection con = null;
    PreparedStatement pstmt = null;
    
    try {
        con = getConnection();
        pstmt = con.preparedStatement(sql);
        pstmt.setString(1, memberId);
        
        pstmt.executeUpdate();
    }catch (SQLException e){
        log.error("db error", e);
        throw e;
    }finally {
        close(con,pstmt, null);
    }
}

MemberRepositoryV0Test – 삭제 멤버 추가

...

// delete
repository.delete(member.getMemberId());
asserThatThrownBy(() -> repository.findById(member.getMemberId()))
                                  .isInstanceOf(NoSuchElementException.class);

...
  • 회원 삭제 후 findById()로 검색합니다. 멤버가 없으므로 NoSuchElementException이 발생합니다.
  • assertThatThrownBy는 해당 예외가 발생한 경우에만 검증에 성공합니다.

마지막에 멤버가 삭제되어 테스트가 정상적으로 실행된다면, 앞으로 동일한 테스트를 반복 실행할 수 있습니다. 물론 테스트 도중에 오류가 발생하여 삭제 로직을 수행할 수 없는 경우 테스트를 반복 실행할 수 없습니다. 트랜잭션은 이 문제를 해결할 수 있으며 다음에 살펴보겠습니다.

참고 자료

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-db-1/dashboard

Spring DB Part 1 – 데이터 액세스 핵심 원칙 – 인프라 | 강의

백엔드 개발에 필요한 DB 데이터 접근 기술을 기초부터 이해하고 완성할 수 있습니다. Spring DB 접근 기술의 원리와 구조를 이해하고 보다 깊이 있는 백엔드 개발자로 성장할 수 있습니다.

www.inflearn.com