JDBC 이해
JDBC 이해
JDBC 등장 이유
애플리케이션을 개발할 때 중요한 데이터는 대부분 데이터베이스에 보관
클라이언트, 애플리케이션 서버, DB
클라이언트가 애플리케이션 서버를 통해 데이터를 저장하거나 조회하면, 애플리케이션 서버는 다음 과정을 통해서 데이터베이스를 사용
애플리케이션 서버와 DB - 일반적인 사용법
- 커넥션 연결: 주로 TCP/IP를 사용해서 커넥션을 연결
- SQL 전달: 애플리케이션 서버는 DB가 이해할 수 있는 SQL을 연결된 커넥션을 통해 DB에 전달
- 결과 응답: DB는 전달된 SQL을 수행하고 그 결과를 응답. 애플리케이션 서버는 응답 결과를 활용
애플리케이션 서버와 DB - DB 변경
그런데 각각의 데이터베이스마다 커넥션을 연결하는 방법, SQL을 전달하는 방법, 그리고 결과를 응답 받는 방법이 모두 다름 참고로 관계형 데이터베이스는 수십 개가 존재.
여기에는 2가지 큰 문제가 있음
- 데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버에 개발된 데이터베이스 사용 코드도 함께 변경해야 함
- 개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답 받는 방법을 새로 학습해야 함
이런 문제를 해결하기 위해 JDBC라는 자바 표준이 등장
JDBC 표준 인터페이스
JDBC(Java Database Connectivity)는 자바에서 데이터베이스에 접속할 수 있도록 하는 자바 API다. 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가지 문제가 해결됨
- 데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버의 데이터베이스 사용 코드도 함께 변경해야 하는 문제
- 애플리케이션 로직은 이제 JDBC 표준 인터페이스에만 의존. 따라서 데이터베이스를 다른 종류의 데이터베이스로 변경하고 싶으면 JDBC 구현 라이브러리만 변경하면 됨. 따라서 다른 종류의 데이터베이스로 변경해도 애플리케이션 서버의 사용 코드를 그대로 유지
- 개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답 받는 방법을 새로 학습해야하는 문제
- 개발자는 JDBC 표준 인터페이스 사용법만 학습. 한번 배워두면 수십 개의 데이터베이스에 모두 동일하게 적용 가능
참고 - 표준화의 한계
JDBC의 등장으로 많은 것이 편리해졌지만, 각각의 데이터베이스마다 SQL, 데이터타입 등의 일부 사용법이 다르다. ANSI SQL이라는 표준이 있기는 하지만 일반적인 부분만 공통화했기 때문에 한계가 있다. 대표적으로 실무에서 기본으로 사용하는 페이징 SQL은 각각의 데이터베이스마다 사용법이 다르다. 결국 데이터베이스를 변경하면 JDBC 코드는 변경하지 않아도 되지만 SQL은 해당 데이터베이스에 맞도록 변경해야한다. 참고로 JPA(Java Persistence API)를 사용하면 이렇게 각각의 데이터베이스마다 다른 SQL을 정의해야 하는 문제도 많은 부분 해결할 수 있다.
JDBC와 최신 데이터 접근 기술
- JDBC는 1997년에 출시될 정도로 오래된 기술이고, 사용하는 방법도 복잡
- 그래서 최근에는 JDBC를 직접 사용하기 보다는 JDBC를 편리하게 사용하는 다양한 기술이 존재
- 대표적으로 SQL Mapper와 ORM 기술로 나눌 수 있음
JDBC 직접 사용
SQL Mapper
- 장점: JDBC를 편리하게 사용하도록 도와줌
- SQL 응답 결과를 객체로 편리하게 변환
- JDBC의 반복 코드를 제거
- 단점: 개발자가 SQL을 직접 작성해야 함
- 대표 기술: 스프링 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는 자바 개발자라면 꼭 알아두어야 하는 필수 기본 기술이다.
데이터베이스 연결
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 = "";
}
데이터베이스에 접속하는데 필요한 기본 정보를 편리하게 사용할 수 있도록 상수로 작성
DBConnectionUtil
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 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
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import java.sql.Connection;
import static org.assertj.core.api.Assertions.assertThat;
@Slf4j
class DBConnectionUtilTest {
@Test
void connection() {
Connection connection = DBConnectionUtil.getConnection();
assertThat(connection).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 커넥션 인터페이스와 구현
- 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 정보를 체크해서 본인이 처리할 수 있는 요청인지 확인. 예를 들어서 URL이 jdbc:h2 로 시작하면 이것은 h2 데이터베이스에 접근하기 위한 규칙
- 따라서 H2 드라이버는 본인이 처리할 수 있으므로 실제 데이터베이스에 연결해서 커넥션을 획득하고 이 커넥션을 클라이언트에 반환. 반면에 URL이 jdbc:h2 로 시작했는데 MySQL 드라이버가 먼저 실행되면 이 경우 본인이 처리할 수 없다는 결과를 반환하게 되고, 다음 드라이버에게 순서가 넘어감
- 이렇게 찾은 커넥션 구현체가 클라이언트에 반환
우리는 H2 데이터베이스 드라이버만 라이브러리에 등록했기 때문에 H2 드라이버가 제공하는 H2 커넥션을 제공받음. 물론 이 H2 커넥션은 JDBC가 제공하는 java.sql.Connection
인터페이스를 구현하고 있음
H2 데이터베이스 드라이버 라이브러리
runtimeOnly 'com.h2database:h2' //h2-x.x.xxx.jar
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)
);
Member
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 - 회원 등록
import hello.jdbc.connection.DBConnectionUtil;
import hello.jdbc.domain.Member;
import lombok.extern.slf4j.Slf4j;
import java.sql.*;
/**
* 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);
}
}
if (con != null) {
try {
con.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
:insert into member(member_id, money) values(?, ?)"
pstmt.setString(1, member.getMemberId())
: SQL의 첫번째?
에 값을 지정. 문자이므로setString
을 사용pstmt.setInt(2, member.getMoney())
: SQL의 두번째?
에 값을 지정한다.Int
형 숫자이므로 setInt를 지정pstmt.executeUpdate()
:Statement
를 통해 준비된 SQL을 커넥션을 통해 실제 데이터베이스에 전달. 참고로executeUpdate()
은int
를 반환하는데 영향받은 DB row 수를 반다. 여기서는 하나의 row를 등록했으므로 1을 반환
executeUpdate()
int executeUpdate() throws SQLException;
리소스 정리 쿼리를 실행하고 나면 리소스를 정리해야 함. 여기서는 Connection
, reparedStatement
를 사용. 리소스를 정리할 때는 항상 역순으로 해야 함. Connection
을 먼저 획득하고 Connection
을 통해 PreparedStatement
를 만들었기 때문에 리소스를 반환할 때는 PreparedStatement
를 먼저 종료하고, 그 다음에 Connection
을 종료하면 됨
주의 리소스 정리는 꼭! 해주어야 한다. 따라서 예외가 발생하든, 하지 않든 항상 수행되어야 하므로
finally
구문에 주의해서 작성해야 한다. 만약 이 부분을 놓치게 되면 커넥션이 끊어지지 않고 계속 유지되는 문제가 발생할 수 있다. 이런 것을 리소스 누수라고 하는데, 결과적으로 커넥션 부족으로 장애가 발생할 수 있다.
참고 PreparedStatement 는 Statement 의 자식 타입인데, ? 를 통한 파라미터 바인딩을 가능하게 해준다. 참고로 SQL Injection 공격을 예방하려면 PreparedStatement 를 통한 파라미터 바인딩 방식을 사용해야 한다.
MemberRepositoryV0Test - 회원 등록
import hello.jdbc.domain.Member;
import org.junit.jupiter.api.Test;
import java.sql.SQLException;
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void crud() throws SQLException {
//save
Member member = new Member("memberV0", 10000);
repository.save(member);
}
}
실행 결과 데이터베이스에서 select * from member
쿼리를 실행하면 데이터가 저장된 것을 확인할 수 있음. 참고로 이 테스트는 2번 실행하면 PK 중복 오류가 발생하므로 delete from member
쿼리로 데이터를 삭제한 다음에 다시 실행
PK 중복 오류
org.h2.jdbc.JdbcSQLIntegrityConstraintViolationException: Unique index or primary key violation: "PUBLIC.PRIMARY_KEY_8 ON PUBLIC.MEMBER(MEMBER_ID) VALUES 9"; SQL statement:
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.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);
}
}
findById() - 쿼리 실행
sql
: 데이터 조회를 위한 select SQL을 준비rs = pstmt.executeQuery()
데이터를 변경할 때는executeUpdate()
를 사용하지만, 데이터를 조회할 때는executeQuery()
를 사용.executeQuery()
는 결과를ResultSet
에 담아서 반환
executeQuery()
ResultSet executeQuery() throws SQLException;
ResultSet
ResultSet
은 다음과 같이 생긴 데이터 구조. 보통 select 쿼리의 결과가 순서대로 들어감.- 예를 들어서
select member_id, money
라고 지정하면member_id
,money
라는 이름으로 데이터가 저장 - 참고로
select *
을 사용하면 테이블의 모든 컬럼을 다 지정
- 예를 들어서
ResultSet
내부에 있는 커서(cursor
)를 이동해서 다음 데이터를 조회rs.next()
: 이것을 호출하면 커서가 다음으로 이동. 참고로 최초의 커서는 데이터를 가리키고 있지 않기 때문에rs.next()
를 최초 한번은 호출해야 데이터를 조회할 수 있음rs.next()
의 결과가true
면 커서의 이동 결과 데이터가 있음rs.next()
의 결과가false
면 더 이상 커서가 가리키는 데이터가 없음
rs.getString("member_id")
: 현재 커서가 가리키고 있는 위치의member_id
데이터를String
타입으로 반환rs.getInt("money")
: 현재 커서가 가리키고 있는 위치의money
데이터를int
타입으로 반환
ResultSet 결과 예시
참고로 이 ResultSet 의 결과 예시는 회원이 2명 조회되는 경우
1-1
에서rs.next()
를 호출1-2
의 결과로cursor
가 다음으로 이동. 이 경우cursor
가 가리키는 데이터가 있으므로true
를 반환2-1
에서rs.next()
를 호출2-2
의 결과로cursor
가 다음으로 이동. 이 경우cursor
가 가리키는 데이터가 있으므로true
를 반환3-1
에서rs.next()
를 호출3-2
의 결과로cursor
가 다음으로 이동. 이 경우cursor
가 가리키는 데이터가 없으므로false
를 반환
findById()
에서는 회원 하나를 조회하는 것이 목적. 따라서 조회 결과가 항상 1건이므로 while
대신에 if
를 사용. 다음 SQL을 보면 PK인 member_id
를 항상 지정 SQL: select * from member where member_id = ?
MemberRepositoryV0Test - 회원 조회 추가
import hello.jdbc.domain.Member;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import java.sql.SQLException;
import static org.assertj.core.api.Assertions.assertThat;
@Slf4j
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void crud() throws SQLException {
//save
Member member = new Member("memberV0", 10000);
repository.save(member);
//findById
Member findMember = repository.findById(member.getMemberId());
log.info("findMember={}", findMember);
assertThat(findMember).isEqualTo(member);
}
}
실행 결과
MemberRepositoryV0Test - findMember=Member(memberId=memberV0, money=10000)
- 회원을 등록하고 그 결과를 바로 조회해서 확인
- 참고로 실행 결과에
member
객체의 참조 값이 아니라 실제 데이터가 보이는 이유는 롬복의@Data
가toString()
을 적절히 오버라이딩 해서 보여주기 때문 isEqualTo()
:findMember.equals(member)
를 비교. 결과가 참인 이유는 롬복의@Data
는 해당 객체의 모든 필드를 사용하도록equals()
를 오버라이딩 하기 때문
참고 이 테스트는 2번 실행하면 PK 중복 오류가 발생하므로 delete from member
쿼리로 데이터를 삭제한 다음에 다시 실행
JDBC 개발 - 수정, 삭제
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);
}
}
executeUpdate()
는 쿼리를 실행하고 영향받은 row수를 반환. 여기서는 하나의 데이터만 변경하기 때문에 결과로 1이 반환됨. 만약 회원이 100명이고, 모든 회원의 데이터를 한번에 수정하는 update sql을 실행하면 결과는 100
MemberRepositoryV0Test - 회원 수정 추가
@Test
void crud() throws SQLException {
//save
Member member = new Member("memberV0", 10000);
repository.save(member);
//findById
Member findMember = repository.findById(member.getMemberId());
assertThat(findMember).isEqualTo(member);
//update: money: 10000 -> 20000
repository.update(member.getMemberId(), 20000);
Member updatedMember = repository.findById(member.getMemberId());
assertThat(updatedMember.getMoney()).isEqualTo(20000);
}
회원 데이터의 money
를 10000 → 20000으로 수정하고, DB에서 데이터를 다시 조회해서 20000으로 변경 되었는지 검증
실행 로그
MemberRepositoryV0 - resultSize=1
pstmt.executeUpdate()
의 결과가 1인 것을 확인할 수 있음. 이것은 해당 SQL에 영향을 받은 로우 수가 1개라는 의미
데이터베이스에서 조회하면 memberV0 의 money 가 20000으로 변경된 것을 확인할 수 있음
참고 이 테스트는 2번 실행하면 PK 중복 오류가 발생. 이 경우 delete from member
쿼리로 데이터를 삭제한 다음에 다시 실행
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.prepareStatement(sql);
pstmt.setString(1, memberId);
pstmt.executeUpdate();
} catch (SQLException e) {
log.error("db error", e);
throw e;
} finally {
close(con, pstmt, null);
}
}
MemberRepositoryV0Test - 회원 삭제 추가
import hello.jdbc.domain.Member;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import java.sql.SQLException;
import java.util.NoSuchElementException;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
@Slf4j
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void crud() throws SQLException {
//save
Member member = new Member("memberV0", 10000);
repository.save(member);
//findById
Member findMember = repository.findById(member.getMemberId());
log.info("findMember={}", findMember);
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);
}
}
회원을 삭제한 다음 findById() 를 통해서 조회. 회원이 없기 때문에 NoSuchElementException
이 발생. assertThatThrownBy
는 해당 예외가 발생해야 검증에 성공
참고 마지막에 회원을 삭제하기 때문에 테스트가 정상 수행되면, 이제부터는 같은 테스트를 반복해서 실행할 수 있다. 물론 테스트 중간에 오류가 발생해서 삭제 로직을 수행할 수 없다면 테스트를 반복해서 실행할 수 없다. 트랜잭션을 활용하면 이 문제를 깔끔하게 해결할 수 있다.