JDBC 라이브러리를 이용하여 CRUD 구현하기

JDBC 이해
- JDBC 등장 이유
- JDBC 표준 인터페이스
JDBC와 최신 데이터 접근 기술
H2 데이터베이스 설정
데이터베이스 연결하기
- JDBC DriverManager 연결 이해
- DriverManager 커넥션 요청 흐름
JDBC로 CRUD 구현하기
Review
Reference

이 글은 스프링 DB 1편 - 데이터 접근 핵심 원리 강의를 듣고 정리한 내용입니다.

JDBC 이해

JDBC 등장 이유

애플리케이션을 개발할 때 중요한 데이터는 대부분 데이터베이스에 보관한다.

클라이언트가 애플리케이션 서버를 통해 데이터를 저장하거나 조회하면, 애플리케이션 서버는 다음 과정을 통해 데이터베이스를 사용한다.

일반적으로, 애플리케이션 서버와 DB는 아래와 같은 순서로 진행된다.

커넥션 연결: 주로 TCP/IP를 사용해서 커넥션을 연결한다.
SQL 전달: 애플리케이션 서버는 DB가 이해할 수 있는 SQL을 연결된 커넥션을 통해 DB에 전달한다.
결과 응답: DB는 전달된 SQL을 수행하고 그 결과를 응답한다. 애플리케이션 서버는 응답 결과를 활용한다.

하지만 각각의 데이터베이스 마다 사용법(커텍션 연결, SQL 전달, 결과 응답)이 다르다는 문제점을 가지고 있다. (참고로 관계형 데이터베이스는 수십개가 있다)

여기에는 2가지 큰 문제점이 있다.

데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버에 개발된 데이터베이스 사용 코드도 함께 변경해야 한다.
개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답 받는 방법을 새로 학습해야 한다.

이러한 문제를 해결하기 위해 JDBC 라는 자바 표준이 등장하게 되었다.

JDBC 표준 인터페이스

JDBC(Java Database Connectivity)는 자바에서 데이터베이스에 접속할 수 있도록 하는 자바 API다. JDBC는 데이터베이스에서 자료를 쿼리하거나 업데이트하는 방법을 제공한다. - 위키백과 -

대표적으로 다음 3가지 기능을 표준 인터페이스로 정의해서 제공한다.

java.sql.Connection - 연결
java.sql.Statement - SQL을 담은 내용
java.sql.ResultSet - SQL 요청 응답

이 JDBC 인터페이스를 각각의 DB 벤더(회사)에서 자신 의 DB에 맞도록 구현해서 라이브러리로 제공하는데, 이를 JDBC 드라이버라 한다.

예를 들어서 MySQL DB에 접근 할 수 있는 것은 MySQL JDBC 드라이버라 하고, Oracle DB에 접근할 수 있는 것은 Oracle JDBC 드라이버라 한다.

MySQL 드라이버를 사용하면 아래와 같은 그림을 볼 수 있다.

정리하면 JDBC의 등장으로 두 가지 주요 문제가 해결되었다.

데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버의 데이터베이스 사용 코드도 함께 변경 해야하는 문제
- 해결 방안: 애플리케이션 로직은 이제 JDBC 표준 인터페이스에만 의존한다. 따라서 데이터베이스를 다른 종류의 데이터베이스로 변경하고 싶으면 JDBC 구현 라이브러리만 변경하면 된다. 따라서 다른 종류의 데이터베이스로 변경해도 애플리케이션 서버의 사용 코드를 그대로 유지할 수 있다.
개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답 받는 방법을 새로 학습해야하는 문제
- 해결 방안: 개발자는 JDBC 표준 인터페이스 사용법만 학습하면 된다. 한번 배워두면 수십개의 데이터베이스에 모두 동일하게 적용할 수 있다.

(참고로 JPA(Java Persistence API)를 사용하면 이렇게 각각의 데이터베이스마다 다른 SQL를 정의해야 하는 문제도 많은 부분을 해결할 수 있다)

JDBC와 최신 데이터 접근 기술

JDBC는 1997년에 출시될 정도로 오래된 기술이고, 사용하는 방법도 복잡하다.

그래서 최근에는 JDBC를 직접 사용하기 보다는 JDBC를 편리하게 사용하는 다양한 기술이 존재한다. 대표적으로 SQL Mapper와 ORM 기술로 나눌 수 있다.

SQL Mapper

장점: JDBC를 편리하게 사용하도록 도와준다.
- SQL 응답 결과를 객체로 편리하게 변환해준다.
- JDBC의 반복 코드를 제거해준다.
단점: 개발자가 SQL을 직접 작성해야한다.
대표 기술: 스프링 JdbcTemplate, MyBatis

ORM 기술

ORM은 객체를 관계형 데이터베이스 테이블과 매핑해주는 기술이다. 이 기술 덕분에 개발자는 반복적인 SQL을 직접 작성하지 않고, ORM 기술이 개발자 대신에 SQL을 동적으로 만들어 실행 해준다. 추가로 각각 의 데이터베이스마다 다른 SQL을 사용하는 문제도 중간에서 해결해준다.
대표 기술: JPA, 하이버네이트, 이클립스링크
JPA는 자바 진영의 ORM 표준 인터페이스이고, 이것을 구현한 것으로 하이버네이트와 이클립스 링크 등의 구현 기술이 있다.

여기서 중요한 점은 이런 기술들도 내부에서는 모두 JDBC를 사용한다. 따라서 JDBC를 직접 사용하지 않더라도, JDBC가 어떻게 동작하는지 기본 원리는 알아두어야 한다.

그래야 해당 기술들을 더 깊이있게 이해할 수 있고, 무엇보다 문제가 발생했을 때 근본적인 문제를 찾아서 해결할 수 있다.

JDBC는 자바 개발자라면 꼭 알아두어야 하는 필수 기본 기술이다. (사실 이 말은 듣고, 이번 강의를 통해 확실히 알고 넘어가기로 마음 먹었다)

H2 데이터베이스 설정

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

사전에는 H2 데이터베이스를 위한 다운로드 및 설치를 해줘야 한다.

H2 데이터베이스는 스프링 부트 버전에 맞춘다. - H2 다운로드 버전
- 스프링 부트 2.x를 사용하면 1.4.200 버전을 다운로드 받으면 된다.
- 스프링 부트 3.x를 사용하면 2.1.214 버전 이상 사용해야 한다.

MAC, 리눅스 사용자 기준으로 아래와 같은 순서로 진행하면 된다.

cd bin #1. 디렉토리 이동
chmod 755 h2.sh #2. 권한 주기
./h2.sh #3. 실행

그런 다음, 데이터베이스 파일을 생성한다. (참고로, 주소 맨 앞에 localhost 가 아니라면, localhost로 입력하고 Enter를 입력한다, 나머지 부분은 변경해선 안된다)

사용자명은 sa를 입력한다.
JDBC URL 에는 최초로 jdbc:h2:~/test 입력하고, 연결 버튼을 직접 눌러야 한다. (연결 시험을 클릭하면 오류가 발생한다)
연결이 성공되었으면, 이후부터는 jdbc:h2:tcp://localhost/~/test 이렇게 접속한다.

H2 데이터베이스가 연결되면, 테스트를 위한 Member 테이블을 생성한다.

H2 데이터베이스 웹 콘솔에 아래와 같은 SQL 문을 입력하고, 실행한다.

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

insert into member(member_id, money)
values ('memberV1', 10000);
insert into member(member_id, money)
values ('memberV2', 20000);

select *
from member;

그런 다음, 쿼리를 실행해서 저장한 데이터가 잘 나오는지 결과를 확인한다.

데이터베이스 연결하기

먼저 H2 데이터베이스 서버를 실행시켜주고, 아래와 같이 데이터베이스에 접속하는데 필요한 기본 정보를 입력한다.

jdbc > connection 패키지

ConnectionConst
DBConnectionUtil

ConnectionConst 추상 클래스

package hello.jdbc.connection;

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 = "";
}

그리고 JDBC를 사용해서 실제 데이터베이스에 연결하는 코드를 작성한다.

DBConnectionUtil 클래스

@Slf4j
public class DBConnectionUtil {

    public static Connection getConnection() {
        try {
            Connection connection = DriverManager.getConnection(URL, USERNAME, PASSWORD);
            log.info("get connection={}, class={}", connection, connection.getClass());
            return connection;
        } catch (SQLException e) {
            throw new IllegalStateException(e);
        }
    }
}

데이터베이스에 연결하려면 JDBC가 제공하는 DriverManager.getConnection(...)를 사용하면 된다.

이렇게 하면 라이브러리에 있는 데이터베이스 드라이버를 찾아서 해당 드라이버가 제공하는 커넥션을 반환해준다.

여기서는 H2 데이터베이스 드라이버가 작동해서 실제 데이터베이스와 커넥션을 맺고 그 결과를 반환해준다.

DBConnectionUtilTest 클래스(테스트 코드)

@Slf4j
class DBConnectionUtilTest {

    @Test
    void connection() {
        Connection connection = DBConnectionUtil.getConnection();
        assertThat(connection).isNotNull();
    }
}

실행 결과를 보면, class=class org.h2.jdbc.JdbcConnection 부분을 확인할 수 있다. 이것이 바로 H2 데이터베이스 드라이버가 제공하는 H2 전용 커넥션이다. 물론 이 커넥션은 JDBC 표준 커넥션 인터페이스인 java.sql.Connection 인터페이스를 구현하고 있다.

(만약 오류가 발생하면 H2 데이터베이스가 실행되지 않거나 설정에 오류가 있으므로, H2 데이터베이스 설정 부분을 확인한다)

JDBC DriverManager 연결 이해

JDBC는 java.sql.Connection 표준 커넥션 인터페이스를 정의한다.

H2 데이터베이스 드라이버는 JDBC Connection 인터페이스를 구현한 org.h2.jdbc.JdbcConnection 구현체를 제공한다.

DriverManager 커넥션 요청 흐름

JDBC가 제공하는 DriverManager는 라이브러리에 등록된 DB 라이브러리를 관리하고, 커넥션을 획득하는 기능을 제공한다.

애플리케이션 로직에서 커넥션이 필요하면 DriverManager.getConnection() 을 호출한다.
DriverManager 는 라이브러리에 등록된 드라이버 목록을 자동으로 인식한다. 이 드라이버들에게 순서대로 다음 정보를 넘겨서 커넥션을 획득할 수 있는지 확인한다.
- URL: 예) jdbc:h2:tcp://localhost/~/test
- 이름, 비밀번호 등 접속에 필요한 추가 정보
- 여기서 각각의 드라이버는 URL 정보를 체크해서 본인이 처리할 수 있는 요청인지 확인한다.
이렇게 찾은 커넥션 구현체가 클라이언트에 반환된다.

여기서는 H2 데이터베이스 드라이버만 라이브러리에 등록했기 때문에 H2 드라이버가 제공하는 H2 커넥션을 제공받는다.

JDBC로 CRUD 구현하기

이제 본격적으로 JDBC를 사용해서 애플리케이션을 개발해보자.

여기서는 JDBC를 사용해서 회원(Member) 데이터를 데이터베이스에 관리하는 기능을 개발해보자.

JDBC 개발 - 등록

H2 데이터베이스 설정 마지막에 테이블과 샘플 데이터 만들기를 통해 member 테이블을 미리 만들어두어야 한다.

JDBC 개발 - 조회

JDBC 개발 - 수정, 삭제

최종

아래 코드는 이제까지 JDBC 라이브러리를 이용하여 CRUD 개발을 작업한 결과이다.

MemberRepositoryV0(등록, 조회, 수정, 삭제)

package hello.jdbc.repository;

import hello.jdbc.connection.DBConnectionUtil;
import hello.jdbc.domain.Member;
import lombok.extern.slf4j.Slf4j;

import java.sql.*;
import java.util.NoSuchElementException;

/**
 * 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);
        }
    }

    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.prepareStatement(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, null);
        }
    }

    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.info("db error", e);
            throw e;
        } finally {
            close(con, pstmt, null);
        }
    }

    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.prepareStatement(sql);
            pstmt.setString(1, memberId);
            pstmt.executeUpdate();
        } catch (SQLException e) {
            log.info("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(); // Exception
            } catch (SQLException e) {
                log.info("error", e);
            }
        }
        if (con != null) {
            try {
                con.close();
            } catch (SQLException e) {
                log.info("error", e);
            }
        }
    }

    private static Connection getConnection() {
        return DBConnectionUtil.getConnection();
    }
}

Review

JDBC에 대한 개념을 처음부터 학습하고 JDBC 라이브러리를 활용하여 CRUD(등록, 조회, 수정, 삭제) 작업을 직접 구현해보는 경험을 쌓아보았다.

주로 기초적인 부분에 중점을 두어 다루었기 때문에, 더 깊은 내용은 다른 참고서를 참조해야 할 것 같다. 그러나 이 강의를 통해 JDBC의 핵심 개념과 동작 원리를 이해할 수 있었다.

이전에도 JDBC를 이용한 CRUD 개발을 시도해봤지만, 제대로 된 복습 없이 넘어간 부분이 있었다. 따라서 이 강의를 통해 그 과정을 제대로 되짚어 볼 수 있게 되었다.

Reference

스프링 DB 1편 - 데이터 접근 핵심 원리