JDBC 이해

    JDBC란?

    JDBC(Java DataBase Connectivity)는 Java에서 데이터베이스를 접속할 수 있도록 해주는 Java API이다.

    등장이유

    애플리케이션을 개발 시 중요 데이터는 데이터베이스에 보관한다.

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

     

    1. 커넥션 연결: 주로 TCP/IP를 사용하여 커넥션을 연결한다.

    2. SQL 전달: 애플리케이션 서버는 DB가 이해할 수 있는 SQL을 연결된 커넥션을 통해 DB에 전달한다.

    3. 결과 응답: DB는 전달된 SQL를 수행하고 그 결과를 응답한다. 애플리케이션 서버는 응답 결과를 활용한다.

     

    문제는 각각의 데이터베이스마다 커넥션 연결방법, SQL 전달방법, 그리고 결과를 응답받는 방법이 모두 다르다.

     

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

    1. 데이터베이스를 다른 데이터베이스로 변경 시 애플리케이션 서버의 데이터베이스 사용코드도 함께 변경해야 한다.

    2. 개발자가 각각의 데이테베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답받는 방법을 새로 학습해야 한다.

     

    위 문제를 해결하기 위해 JDBC라는 자바 표준이 등장했다.

     

    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 드라이버 사용

    Oracle 드라이버 사용

     

    정리

    JDBC 등장으로 아래 2가지 문제가 해결되었다.

    1. 데이터베이스를 다른 종류의 데이터베이스로 변경 시 애플리케이션 서버의 데이터베이스 코드로 함께 변경되는 문제

    -> 애플리케이션 로직은 이제 JDBC 표준 인터페이스에만 의존한다. 따라서 데이터베이스를 다른 종류의 데이터베이스로 변경하고 싶으면 JDBC 구현 라이브러리만 변경하면 된다. 따라서 다른 종류의 데이터 베이스로 변경해도 애플리케이션 서버의 사용코드를 그대로 유지가 가능하다.

     

    2. 개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답받는 방법을 새로 학습하는 문제

    -> 개발자는 JDBC 표준 인터페이스 사용법만 학습하면 됨. 동일하게 적용 가능

     

    BUT -> 데이터베이스 변경 시 JDBC 코드는 변경하지 않아도 되지만 SQL은 해당 데이터베이스에 맞도록 변경해야 한다.

    참고로 JPA(Java Persistence API)를 사용 시 각각의 데이터베이스마다 다른 SQL를 정의해야 하는 문제도 많은 부분 해결가능하다.

     

    JDBC와 최신 데이터 접근 기술

    JDBC의 한계를 극복하기 위해 대표적으로 SQL Mapper와 ORM이라고 하는 기술이 생겼다.

    SQL Mapper

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

    ORM 기술

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

    SQL Mapper vs ORM 기술

    SQL Mapper와 ORM 기술 둘다 각각 장단점이 있다. 쉽게 설명하자면 SQL Mapper는 SQL만 직접 작성하면 나머지 번거로운 일은 SQL Mapper가 대신 해결해준다. SQL Mapper는 SQL만 작성할 줄 알면 금방 배워서 사용할 수 있다. ORM기술은 SQL 자체를 작성하지 않아도 되어서 개발 생산성이 매우 높아진다. 편리한 반면에 쉬운 기술은 아니므로 실무에서 사용하려면 깊이있게 학습해야 한다.

     

    중요

    이런 기술들도 내부에서는 모두 JDBC를 사용한다. 따라서 JDBC를 직접 사용하지는 않더라도, JDBC가 어떻게 동작하는지 기본 원리를 알아두어야 한다. 그래야 해당 기술들을 더 깊이있게 이해할 수 있고, 무엇보다 문제가 발생했을 때 근본적인 문제를 찾아서 해결할 수 있다 JDBC는 자바 개발자라면 꼭 알아두어야 하는 필수 기본 기술이다.

     

    데이터베이스 연결 - H2

    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 = "";
    }
    • H2에 연결하기 위해 상수로 하여 연결 정보 사용할 수 있도록 함(전역패키지로 import해 변수만 사용)
    • 추상 클래스는 상수와 추상메서드만 가질 수 있고 인스턴스화하지 않고 상수에 접근할 수 있다.

    DBConnectionUtil

    package hello.jdbc.connection;
    
    import lombok.extern.slf4j.Slf4j;
    
    import java.sql.Connection;
    import java.sql.DriverManager;
    import java.sql.SQLException;
    
    import static hello.jdbc.connection.ConnectionConst.*;
    
    @Slf4j
    public class DBConnectionUtil {
    
        public static Connection getConnection(){
            try {
                Connection conn = DriverManager.getConnection(URL, USERNAME, PASSWORD);
                log.info("get connection={}, class={}", conn, conn.getClass());
                return conn;
            } catch (SQLException e){
                throw new IllegalStateException(e);
            }
        }
    }

    데이터베이스에 연결하려면 JDBC가 제공하는 DriverManager.getConnection()를 사용하면 된다. 이렇게 작성 시 라이브러리에 있는 데이터베이스 드라이버를 찾아 해당 드라이버가 제공하는 커넥션을 반환해준다. 

     

    간단한 학습용 테스트 코드 작성, 실행해보자

    DBConnectionUtilTest

    package hello.jdbc.connection;
    
    import lombok.extern.slf4j.Slf4j;
    import org.assertj.core.api.Assertions;
    import org.junit.jupiter.api.Test;
    
    import java.sql.Connection;
    
    @Slf4j
    class DBConnectionUtilTest {
    
        @Test
        void connection(){
            Connection conn = DBConnectionUtil.getConnection();
            Assertions.assertThat(conn).isNotNull();
        }
    }

     

    실행결과

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

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

     

    JDBC DriverManager 이해

    각각의 데이터베이스 커넥션은 JDBC Connection 인터페이스를 구현한 DB구현체이다.

     

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

     

    getConnection 과정

    1. 애플리케이션 로직에서 커넥션 필요 시 DriverManager.getConnection()을 호출
    2. DriverManager 는 라이브러리에 등록된 드라이버 목록을 자동으로 인식한다. 이 드라이버들에게 순서대로 다음 정보들을 넘겨 커넥션을 획득할 수 있는지 확인한다.
      1. URL: 예)jdbc:h2:tcp://localhost/~/test
      2. 이름, 비밀번호 등 접속에 필요한 추가 정보
      3. 여기서 각각의 드라이버는 URL 정보를 체크해 본인이 처리할 수 있는 요청인지 확인
      4. 확인 후 실제 데이터베이스에 연결해 커넥션을 획득하고 이 커넥션을 클라이언트에 반환한다.
      5. 만약 URL이 jdbc:h2로 시작했는데 MySql 드라이버가 먼저 실행되면 본인이 처리할 수 없다는 결과 반환하고 다음 드라이버에게 순서가 넘어간다.
    3. 이렇게 찾은 커넥션 구현체가 클라이언트에 반환된다.

    JDBC를 이용한 간단한 CRUD

    JDBC 사용해 DriverManager로 직접 커넥션을 가져와 디비에 연결하여 쿼리를 보내는 로직

     

    Member

    package hello.jdbc.domain;
    
    import lombok.Data;
    
    @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와 해당 회원이 소지한 금액을 표현하는 단순한 클래스이다. 앞서 만들어둔 member 테이블에 데이터를 저 장하고 조회할 때 사용한다.

     

    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 conn = null;
            PreparedStatement pstmt = null;
    
            try {
                conn = getConnection();
                pstmt = conn.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 {
    //            pstmt.close(); //Exception
    //            conn.close();
                close(conn, pstmt, null);
            }
        }
    
        public Member findById(String memberId) throws SQLException {
            String sql = "select * from member where member_id = ?";
    
            Connection conn = null;
            PreparedStatement pstmt = null;
            ResultSet rs = null;
    
            try {
                conn = getConnection();
                pstmt = conn.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.info("db error", e);
                throw e;
            }finally {
                close(conn, pstmt, rs);
            }
        }
    
        public void update(String memberId, int money) throws SQLException {
            String sql = "update member set money = ? where member_id = ? ";
    
            Connection conn = null;
            PreparedStatement pstmt = null;
    
            try {
                conn = getConnection();
                pstmt = conn.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(conn, pstmt, null);
            }
        }
    
        public void delete(String memberId) throws SQLException {
            String sql = "DELETE FROM member WHERE member_id = ?";
    
            Connection conn = null;
            PreparedStatement pstmt = null;
    
            try {
                conn = getConnection();
                pstmt = conn.prepareStatement(sql);
                pstmt.setString(1, memberId);
                pstmt.executeUpdate();
            }catch (SQLException e){
                log.error("db error", e);
                throw e;
            }finally {
                close(conn, pstmt, null);
            }
        }
    
        private void close(Connection conn, 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);
                }
            }
            if (conn != null) {
                try {
                    conn.close();
                }catch (SQLException e){
                    log.info("error", e);
                }
            }
        }
    
        private Connection getConnection() {
            return DBConnectionUtil.getConnection();
        }
    }

    커넥션 획득 

    getConnection(): 이전에 만들어둔 DBConnectionUtil를 통해 데이터베이스 커넥션 획득함.

     

    save() - SQL 전달

    • sql: 데이터베이스에 전달할 SQL을 정의한다. 여기서는 데이터 등록해야 하므로 insert sql를 준비
    • conn.prepareStatement(sql): 데이터베이스에 전달할 SQL과 파라미터로 전달할 데이터들을 준비한다.
      • pstmt.executeUpdate():Statement를 통해 준비된 SQL을 커넥션 통해 실제 데이터베이스에 전달한다. 참고로 executeUpdate()는 int를 반환하는데 영향받은 DB row 수를 반환한다. 여기서는 하나의 row를 등록하였으므로 1을 반환함.

    리소스 정리

    쿼리를 실행하고 나면 리소스를 정리해야 한다. 여기서는 Connection , PreparedStatement를 사용했다. 리소스를 정리할 때는 항상 역순으로 해야한다. Connection을 먼저 획득하고 Connection 을 통해 PreparedStatement를 만들었기 때문에 리소스를 반환할 때는 PreparedStatement를 먼저 종료하고, 그 다음에 Connection을 종료하면 된다. 참고로 여기서 사용하지 않은 ResultSet은 결과를 조회할 때 사용한다.

     

    주의

    리소스 정리는 꼭! 해주어야 한다. 따라서 예외가 발생하든, 하지 않든 항상 수행되어야 하므로 finally구문에 주의해서 작성해야한다. 만약 이 부분을 놓치게 되면 커넥션이 끊어지지 않고 계속 유지되는 문제가 발생할 수 있다. 이런 것을 리소스 누수라고 하는데, 결과적으로 커넥션 부족으로 장애가 발생할 수 있다.

     

    참고

    PreparedStatement는 Statement의 자식 타입인데, ? 를 통한 파라미터 바인딩을 가능하게 해준다. 참고로 SQL Injection 공격을 예방하려면 PreparedStatement를 통한 파라미터 바인딩 방식을 사용해야 한다.

     

    테스트 코드 등록 작성

    MemberRepositoryV0Test

    package hello.jdbc.Repository;
    
    import hello.jdbc.domain.Member;
    import lombok.extern.slf4j.Slf4j;
    import org.assertj.core.api.Assertions;
    import org.junit.jupiter.api.Test;
    
    import java.sql.SQLException;
    import java.util.NoSuchElementException;
    
    import static org.assertj.core.api.Assertions.*;
    import static org.junit.jupiter.api.Assertions.*;
    @Slf4j
    class MemberRepositoryV0Test {
    
        MemberRepositoryV0 repository = new MemberRepositoryV0();
    
        @Test
        void crud() throws SQLException {
            //save
            Member member = new Member("memberV100", 10000);
            repository.save(member);
    
            //findById
            Member findMember = repository.findById(member.getMemberId());
            log.info("findMember={}", findMember);
            log.info("member != findMember = {}", member == findMember);
            log.info("member equals findMember = {}", member.equals(findMember));
            //findMember와 member는 다른 인스턴스이지만 isEqualTo는 equals()를 호출하여 값만 비교한다.
            //@Data는 모든 상태값을 비교할 수 있는 equals와 고유한 hashcode를 자동으로 만들어줌
            assertThat(findMember).isEqualTo(member);
    
            //update: money -> 10000 -> 20000
            repository.update(member.getMemberId(), 20000);
            Member updatedMember = repository.findById(member.getMemberId());
            assertThat(updatedMember.getMoney()).isEqualTo(20000);
    
            //delete
            repository.delete(member.getMemberId());
            assertThatThrownBy(() -> repository.findById(member.getMemberId()))
                                                .isInstanceOf(NoSuchElementException.class);
        }
    }

     

     

    소감: 예전 국비에서 했던 것은 Spring를 제대로 사용하지 않은 것이었구나를 체감한 수업내용이었다.....

     

    댓글