1. JDBC 이해
#Spring/DB/Jdbc
정리
JDBC 등장이유
클라이언트가 애플리케이션 서버를 통해 데이터를 저장하거나 조회하면, 애플리케이션 서버는 다음 과정을 통해서 데이터베이스를 사용한다.
애플리케이션 서버와 DB - 일반적인 사용법
- 커넥션 연결: 주로 TCP/IP를 사용해서 커넥션을 연결한다.
- SQL 전달: 애플리케이션 서버는 DB가 이해할 수 있는 SQL을 연결된 커넥션을 통해 DB에 전달한다.
- 결과 응답: DB는 전달된 SQL을 수행하고 그 결과를 응답한다. 애플리케이션 서버는 응답 결과를 활용한다.
문제는 각각의 데이터베이스마다 커넥션을 연결하는 방법, SQL을 전달하는 방법, 그리고 결과를 응답 받는 방법이 모두 다르다는 점이다
또한, 데이터베이스 종류를 변경하면 애플리케이션 서버에 개발된 데이터베이스 사용 코드도 함께 변경해야 하고, 개발자가 각각의 데이터베이스마다 커넥션 연결, 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 드라이버라고 한다.
JDBC의 등장으로 해결한 문제
- 데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버의 데이터베이스 사용 코드도 함께 변경해야 하는 문제
- 개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답 받는 방법을 새로 학습해야 하는 문제
인터페이스를 통해 추상화 하였기 때문에 해결할 수 있는 문제들이다.
하지만 해결하지 못한 부분도 존재한다.
각각의 데이터베이스마다 SQL, 데이터타입 등의 일부 사용법이 다르다. ANSI SQL이라는 표준이 있기는 하지만 일반적인 부분만 공통화했기 때문에 한계가 있다.
대표적으로 실무에서 기본으로 사용하는 페이징 SQL은 각각의 데이터베이스마다 사용법이 다르다.
결국 데이터베이스를 변경하면 JDBC 코드는 변경하지 않아도 되지만 SQL은 해당 데이터베이스에 맞도록 변경해야 한다.
JDBC와 최신 데이터 접근 기술
JDBC는 굉장히 오래된 기술이고, 이를 편리하게 사용하는 다양한 기술들이 존재한다.
대표적으로 SQL Mapper와 ORM 기술로 나눌 수 있다.
SQL Mapper
- 장점:
- JDBC를 편리하게 사용하도록 도와준다.
- SQL 응답 결과를 객체로 편리하게 변환해준다.
- JDBC의 반복 코드를 제거해준다.
- 단점:
- 개발자가 SQL을 직접 작성해야 한다.
- 대표 기술: 스프링
JdbcTemplate,MyBatis
ORM 기술
- ORM은 객체를 관계형 데이터베이스 테이블과 매핑해주는 기술이다.
- 이 기술 덕분에 개발자는 반복적인 SQL을 직접 작성하지 않고, ORM 기술이 개발자 대신에 SQL을 동적으로 만들어 실행해준다.
- 추가로 각각의 데이터베이스마다 다른 SQL을 사용하는 문제도 중간에서 해결해준다.
- 대표 기술:
JPA, 하이버네이트, 이클립스링크- JPA가 자바 ORM 표준이고, 구현체로 하이버네이트, 이클립스 링크 등의 기술이 있다.
뭔가 ORM이 무조건 좋을 것 같다고 생각할 수 있는데, SQL Mapper와 ORM 기술 둘 다 장단점이 있다.
중요한 건, 이런 기술들은 내부에서 모두 JDBC를 사용한다. JDBC가 어떻게 동작하는지 기본 원리를 알아두어야 해당 기술들을 더 깊이 있게 이해할 수 있고, 무엇보다 문제가 발생했을 때 근본적인 문제를 찾아서 해결할 수 있다.
이제부터는 Jdbc를 이용해 직접 코드를 작성해서 DB에 연결해보고 쿼리를 날려보자.
데이터베이스 연결
@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(..)를 사용하면 된다.
DriverManager는 라이브러리에 있는 드라이버를 찾아서, 해당 드라이버가 제공하는 커넥션을 반환해준다. (Connection도 JDBC 표준 커넥션 인터페이스다)
구체적으로 살펴보자면
각 데이터베이스 드라이버는 JDBC Connection 인터페이스를 구현한 구현체를 제공한다.
- 애플리케이션 로직에서 커넥션이 필요하면
DriverManager.getConnection()을 호출한다. DriverManager는 라이브러리에 등록된 드라이버 목록을 자동으로 인식한다.
이 드라이버들에게 순서대로 다음 정보를 넘겨서 커넥션을 획득할 수 있는지 확인한다.- URL: 예)
jdbc:h2:tcp://localhost/~/test, NAME, PASSWORD- URL 정보를 체크해서 본인이 처리할 수 있는 요청인지 확인
- 위 예시에서는 h2이니까 H2 드라이버가 url을 보고 본인이 처리할 수 있으므로 실제 데이터베이스에 연결해서 커넥션을 획득하고 이 커넥션을 클라이언트에 반환한다.
- 반면에 URL이
jdbc:h2로 시작했는데 MySQL 드라이버가 먼저 실행되면 이 경우 본인이 처리할 수 없다는 결과를 반환하게 되고, 다음 드라이버에게 순서가 넘어간다- Spring MVC 핸들러 어댑터를 찾는 과정과 비슷한 듯.
- URL: 예)
- 이렇게 찾은 커넥션 구현체가 클라이언트에 반환된다.
데이터베이스에 쿼리
Insert
@Slf4j
public class FutureBoxRepository {
public FutureBox save(FutureBox futureBox) throws SQLException {
String sql =
"INSERT INTO future_box (uuid, receiver, sender, is_opened, future_movie_type, future_gifticon_type, future_invention_type, created_at) "
+ "VALUES (?, ?, ?, ?, ?, ?, ?, ?) RETURNING id";
Connection con = null;
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
con = getConnection();
pstmt = con.prepareStatement(sql);
pstmt.setObject(1, futureBox.getUuid());
pstmt.setString(2, futureBox.getReceiver());
pstmt.setString(3, futureBox.getSender());
pstmt.setBoolean(4, futureBox.getOpen());
pstmt.setInt(5, futureBox.getFutureMovieType());
pstmt.setInt(6, futureBox.getFutureGifticonType());
pstmt.setInt(7, futureBox.getFutureInventionType());
pstmt.setTimestamp(8, futureBox.getCreatedTime());
rs = pstmt.executeQuery();
if (rs.next()) {
futureBox.setId(rs.getLong("id"));
} else {
throw new SQLException("Creating FutureBox failed, no ID obtained.");
}
return futureBox;
} 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();
}
(김영한님 강의 내용을 참고해 필자가 진행하는 프로젝트 테이블을 조회하는 쿼리를 바탕으로 코드를 작성해봤다)
con.prepareStatement(sql): 데이터베이스에 전달할 SQL과 파라미터로 전달할 데이터들을 준비한다.- SQL:
insert into member(member_id, money) values(?, ?)" pstmt.setString(1, member.getMemberId()): SQL의 첫 번째?에 값을 지정한다. 문자이므로setString을 사용함.pstmt.executeUpdate(): Statement를 통해 준비된 SQL을 커넥션을 통해 실제 데이터베이스에 전달한다. 참고로executeUpdate()는int를 반환하는데 영향받은 DB row 수를 반환한다. 여기서는 하나의 row를 등록했으므로1을 반환한다.
- SQL:
- 참고로 prepareStatement는 Statement에서 파라미터 바인딩 하는 기능이 추가된 것이다
리소스 정리
쿼리를 실행하고 나면 리소스를 정리해야 한다. 그리고 리소스를 정리할 때는 항상 역순으로 해야 한다.
예외가 발생하든, 하지 않든 항상 수행되어야 하므로 finally 구문에 주의해서 작성해야 한다.
이 부분을 놓치게 되면 커넥션이 끊어지지 않고 계속 유지되는 문제가 발생할 수 있다.
이런 것을 리소스 누수라고 하는데, 결과적으로 커넥션 부족으로 장애가 발생할 수 있다.
Statement 대신 PreparedStatement를 사용하자.
SQL Injection 공격을 예방하려면 PreparedStatement를 통한 파라미터 바인딩 방식을 사용해야 한다. pstmt를 안쓰고 values (“+ memberId +”, “+money+”) 이런식으로 적으면 memberId와 money에 sql을 주입하여 DB가 다 털릴 수 있다. pstmt를 사용하면 파라미터가 단순 문자열로 처리되기 때문에 sql에 영향을 주지 않는다.
select
public FutureBox findById(Long id) throws SQLException {
String sql = "SELECT * FROM future_box WHERE id = ?";
Connection con = null;
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
con = getConnection();
pstmt = con.prepareStatement(sql);
pstmt.setLong(1, id);
rs = pstmt.executeQuery();
if (rs.next()) {
FutureBox futureBox = new FutureBox();
futureBox.setId(rs.getLong("id"));
futureBox.setUuid(java.util.UUID.fromString(rs.getString("uuid")));
futureBox.setReceiver(rs.getString("receiver"));
futureBox.setSender(rs.getString("sender"));
futureBox.setOpen(rs.getBoolean("is_opened"));
futureBox.setFutureMovieType(rs.getInt("future_movie_type"));
futureBox.setFutureGifticonType(rs.getInt("future_gifticon_type"));
futureBox.setFutureInventionType(rs.getInt("future_invention_type"));
futureBox.setCreatedTime(rs.getTimestamp("created_at"));
return futureBox;
} else {
throw new NoSuchElementException("No such future box with id: " + id);
}
} catch (SQLException e) {
log.error("db error", e);
throw e;
} finally {
close(con, pstmt, rs);
}
}
- sql : 데이터 조회를 위한
selectSQL을 준비한다. rs = pstmt.executeQuery()
데이터를 변경할 때는executeUpdate()를 사용하지만, 데이터를 조회할 때는executeQuery()를 사용한다.executeQuery()는 결과를ResultSet에 담아서 반환한다.executeUpdate()는 쿼리를 실행하고 영향받은 row 수를 반환한다.
ResultSet
ResultSet 내부에 있는 커서(cursor)를 이동해서 다음 데이터를 조회할 수 있다.
rs.next(): 이것을 호출하면 커서가 다음으로 이동한다.
참고로 최초의 커서는 데이터를 가리키고 있지 않기 때문에rs.next()를 최초 한번은 호출해야 데이터를 조회할 수 있다.rs.next()의 결과가true면 커서의 이동 결과 데이터가 있다는 뜻이다.rs.next()의 결과가false면 더 이상 커서가 가리키는 데이터가 없다는 뜻이다.
findById() 에서는 레코드 하나를 조회하는 것이 목적이다. 따라서 조회 결과가 항상 1건이므로 while 대신에 if를 사용한다.