[SpringDB1] JDBC 이해

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

JDBC 등장 이유

애플리케이션을 개발할 때 중요한 데이터는 대부분 데이터베이스에 보관한다. 애플리케이션 서버가 데이터베이스를 사용하는 과정은 보통 세 단계로 이뤄진다.

1. 커넥션 연결: 주로 TCP/IP를 사용해 커넥션을 연결한다.
2. SQL 전달: 연결된 커넥션을 통해 DB가 이해할 수 있는 SQL을 전달한다.
3. 결과 응답: DB가 SQL을 수행하고 그 결과를 응답한다.

문제는 이 세 단계의 구체적인 방법이 데이터베이스마다 모두 다르다는 점이다. 관계형 데이터베이스만 해도 수십 개가 있다. 여기서 두 가지 문제가 생긴다.

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

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

JDBC 표준 인터페이스

JDBC(Java Database Connectivity)는 자바에서 데이터베이스에 접속할 수 있도록 하는 자바 API다. 대표적으로 다음 세 가지 기능을 표준 인터페이스로 정의해서 제공한다.

• java.sql.Connection : 연결
• java.sql.Statement : SQL을 담은 내용
• java.sql.ResultSet : SQL 요청에 대한 응답

자바는 이렇게 표준 인터페이스를 정의해두었다. 그런데 인터페이스만 있다고 해서 기능이 동작하지는 않는다. 이 JDBC 인터페이스를 각각의 DB 벤더가 자신의 DB에 맞도록 구현해서 라이브러리로 제공하는데, 이것을 JDBC 드라이버라고 한다.

              JDBC 표준 인터페이스
              Connection / Statement / ResultSet
                        ▲          ▲
              구현       │          │       구현
      ┌─────────────────┘          └─────────────────┐
MySQL 드라이버                              Oracle 드라이버
MySQLConnection                            OracleConnection
MySQLStatement                             OracleStatement
MySQLResultSet                             OracleResultSet

MySQL DB에 접근할 수 있는 것은 MySQL JDBC 드라이버, Oracle DB에 접근할 수 있는 것은 Oracle JDBC 드라이버다. 개발자는 표준 인터페이스만 사용해서 개발하고, 실제 구현은 드라이버가 담당한다.

JDBC의 등장으로 앞서 말한 두 가지 문제가 해결된다.

• 애플리케이션 로직은 JDBC 표준 인터페이스에만 의존하므로, 데이터베이스를 변경하고 싶으면 JDBC 구현 라이브러리(드라이버)만 변경하면 된다. 사용 코드는 그대로 유지된다.
• 개발자는 JDBC 표준 인터페이스 사용법만 학습하면 된다. 한번 배워두면 수십 개의 데이터베이스에 동일하게 적용할 수 있다.

표준화의 한계

JDBC의 등장으로 많은 것이 편리해졌지만, 데이터베이스마다 SQL과 데이터 타입 등 일부 사용법은 여전히 다르다. ANSI SQL이라는 표준이 있긴 하지만 일반적인 부분만 공통화했기 때문에 한계가 있다. 대표적으로 실무에서 자주 사용하는 페이징 SQL은 데이터베이스마다 사용법이 다르다.

 

결국 데이터베이스를 변경하면 JDBC 코드는 변경하지 않아도 되지만 SQL은 해당 데이터베이스에 맞게 변경해야 한다. 참고로 JPA를 사용하면 이렇게 데이터베이스마다 다른 SQL을 정의해야 하는 문제도 많은 부분 해결할 수 있다.

JDBC와 최신 데이터 접근 기술

JDBC는 1997년에 출시될 정도로 오래된 기술이고, 사용하는 방법도 복잡하다. 그래서 최근에는 JDBC를 직접 사용하기보다 JDBC를 편리하게 사용하는 기술을 쓴다. 대표적으로 SQL Mapper와 ORM 기술로 나눌 수 있다.

앱 로직 ─── SQL 전달 ───→ JDBC ───→ DB              JDBC 직접 사용

앱 로직 ──→ SQL Mapper ──→ JDBC ──→ DB              SQL Mapper
             JdbcTemplate                          (반복 코드 제거)
             MyBatis

앱 로직 ─ 객체 전달 →  JPA → JPA 구현체 → JDBC → DB    ORM
                          하이버네이트              (SQL 자동 생성)
                          이클립스링크

SQL Mapper

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

ORM 기술

ORM은 객체를 관계형 데이터베이스 테이블과 매핑해주는 기술이다. 개발자가 반복적인 SQL을 직접 작성하지 않고, ORM 기술이 대신 SQL을 동적으로 만들어 실행해준다. 데이터베이스마다 다른 SQL을 사용하는 문제도 중간에서 해결해준다.

• 대표 기술: JPA, 하이버네이트, 이클립스링크
• JPA는 자바 진영의 ORM 표준 인터페이스이고, 이를 구현한 것이 하이버네이트와 이클립스링크다.

SQL Mapper는 SQL만 직접 작성하면 나머지 번거로운 일은 대신 해결해주기 때문에, SQL만 작성할 줄 알면 금방 배워서 사용할 수 있다. ORM 기술은 SQL 자체를 작성하지 않아도 되어 개발 생산성이 높아지지만, 쉬운 기술은 아니므로 실무에서 사용하려면 깊이 있게 학습해야 한다.

 

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

데이터베이스 연결

데이터베이스에 접속하는 데 필요한 기본 정보를 상수로 분리한다.

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가 제공하는 DriverManager.getConnection()을 사용해 커넥션을 획득한다.

@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);
        }
    }
}

DriverManager.getConnection()을 호출하면 라이브러리에 있는 드라이버를 찾아 해당 드라이버가 제공하는 커넥션을 반환한다. 실행 결과를 보면 class=org.h2.jdbc.JdbcConnection을 확인할 수 있는데, 이것이 H2 드라이버가 제공하는 H2 전용 커넥션이다. 물론 이 커넥션은 JDBC 표준 커넥션 인터페이스인 java.sql.Connection을 구현한 것이다.

 

만약 Connection is broken: java.net.ConnectException: Connection refused 같은 오류가 발생하면 H2 데이터베이스가 실행되지 않았거나 설정에 문제가 있는 것이다.

DriverManager 커넥션 요청 흐름

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

앱 로직
  │ ① getConnection() 호출
  ▼
DriverManager ── 등록된 드라이버 목록을 순서대로 확인
  │
  │  ② "이 URL 처리 가능?"
  │      ┌──→ H2 드라이버     jdbc:h2 로 시작 → 처리 가능 → 커넥션 생성
  │      └──→ MySQL 드라이버  jdbc:h2 아님   → 다음 드라이버로 넘김
  ▼
③ 처리 가능한 드라이버가 만든 커넥션을 앱에 반환

1. 애플리케이션 로직에서 커넥션이 필요하면 DriverManager.getConnection()을 호출한다.
2. DriverManager는 등록된 드라이버 목록을 자동으로 인식하고, 순서대로 URL과 접속 정보를 넘겨 처리할 수 있는지 확인한다. 각 드라이버는 URL을 보고 자신이 처리할 요청인지 판단한다. URL이 jdbc:h2로 시작하면 H2 드라이버가 처리하고, 처리할 수 없으면 다음 드라이버로 순서가 넘어간다.
3. 처리 가능한 드라이버가 실제 데이터베이스에 연결해 커넥션을 반환한다.

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

JDBC 개발 - 등록

회원 데이터를 표현하는 도메인 클래스를 만든다.

@Data
public class Member {
    private String memberId;
    private int money;

    public Member() {
    }

    public Member(String memberId, int money) {
        this.memberId = memberId;
        this.money = money;
    }
}

JDBC를 사용해 회원을 데이터베이스에 저장한다.

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

• con.prepareStatement(sql) : 데이터베이스에 전달할 SQL과 파라미터로 전달할 데이터들을 준비한다.
• pstmt.setString(1, ...) : SQL의 첫 번째 ?에 값을 지정한다. 문자이므로 setString을 사용한다.
• pstmt.setInt(2, ...) : 두 번째 ?에 값을 지정한다. 숫자이므로 setInt를 사용한다.
• pstmt.executeUpdate() : 준비된 SQL을 커넥션을 통해 실제 데이터베이스에 전달한다. 반환값은 영향받은 row 수이며, 한 건을 등록했으므로 1을 반환한다.

JDBC 개발 - 조회

저장한 데이터를 조회한다.

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, rs);
    }
}

데이터를 변경할 때는 executeUpdate()를 사용하지만, 데이터를 조회할 때는 executeQuery()를 사용한다. executeQuery()는 결과를 ResultSet에 담아 반환한다.

 

ResultSet은 내부에 있는 커서(cursor)를 이동시켜 데이터를 조회한다.

            cursor (최초에는 데이터를 가리키지 않음)
rs.next() ──→ member1 / 10000    true  (데이터 있음)
rs.next() ──→ member2 / 20000    true  (데이터 있음)
rs.next() ──→ (끝)               false (데이터 없음)

• rs.next() : 호출하면 커서가 다음으로 이동한다. 최초의 커서는 데이터를 가리키고 있지 않으므로, 최초 한 번은 rs.next()를 호출해야 데이터를 조회할 수 있다.
• rs.next()의 결과가 true면 커서 이동 결과 데이터가 있다는 뜻이고, false면 더 이상 데이터가 없다는 뜻이다.
• rs.getString("member_id") : 현재 커서가 가리키는 위치의 데이터를 String 타입으로 반환한다.
• rs.getInt("money") : 현재 커서가 가리키는 위치의 데이터를 int 타입으로 반환한다.

findById()는 회원 하나를 조회하는 것이 목적이므로 조회 결과가 항상 1건이다. 따라서 while 대신 if를 사용한다.

JDBC 개발 - 수정, 삭제

수정과 삭제는 등록과 비슷하다. 데이터를 변경하는 쿼리이므로 executeUpdate()를 사용한다.

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

executeUpdate()는 영향받은 row 수를 반환한다. 한 건만 변경하면 1을 반환하고, 회원 100명을 한 번에 수정하면 100을 반환한다.

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

삭제는 쿼리만 바뀌고 내용은 거의 같다.

PreparedStatement와 SQL Injection

PreparedStatement는 Statement의 자식 타입으로, ?를 통한 파라미터 바인딩을 가능하게 해준다. SQL Injection 공격을 예방하려면 문자열을 직접 이어 붙이지 말고 PreparedStatement를 통한 파라미터 바인딩 방식을 사용해야 한다.

리소스 정리

쿼리를 실행하고 나면 리소스를 정리해야 한다. 리소스를 정리할 때는 항상 역순으로 한다. Connection을 먼저 획득하고 그 다음 Statement, ResultSet을 만들었으므로, 반환할 때는 다음 순서로 종료한다.

획득 순서   Connection ──→ Statement ──→ ResultSet
반납 순서   ResultSet  ──→ Statement ──→ Connection   (역순)

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);
        }
    }
    if (con != null) {
        try {
            con.close();
        } catch (SQLException e) {
            log.info("error", e);
        }
    }
}

리소스 정리는 반드시 해주어야 한다. 예외가 발생하든 안 하든 항상 수행되어야 하므로 finally 구문에 작성한다. 이 부분을 놓치면 커넥션이 끊어지지 않고 계속 유지되는 리소스 누수가 발생하고, 결과적으로 커넥션 부족으로 장애가 발생할 수 있다.

정리

JDBC 개발에서 등록, 수정, 삭제처럼 데이터를 변경하는 쿼리는 executeUpdate()를, 조회 쿼리는 executeQuery()를 사용한다. 커넥션을 얻고, SQL을 준비하고, 파라미터를 바인딩하고, 실행한 뒤, finally에서 리소스를 역순으로 정리하는 흐름은 네 메서드 모두 동일하다.

참고로 테스트 코드에서 마지막에 회원을 삭제하면 같은 테스트를 반복 실행할 수 있다. 하지만 테스트 중간에 오류가 발생해 삭제 로직을 수행하지 못하면 데이터가 남아 반복 실행이 깨진다. 이 문제는 트랜잭션을 활용하면 깔끔하게 해결할 수 있는데, 자세한 내용은 다음에 다룬다.