우선 https://start.spring.io/에서 프로젝트를 다음과 같이 생성한다.
또한 h2 DB를 사용할 것이기 때문에 h2 DB를 설치해주도록 하자.
h2 DB는 다음의 포스팅을 참고하여 설치한다.
https://surrealcode.tistory.com/87
스프링 회원 관리 예제 2
https://surrealcode.tistory.com/86 스프링 회원 관리 예제이번엔 회원 관리 예제를 만들어보려 한다.기본 환경설정에 관한 내용은 아래를 참고하자.https://surrealcode.tistory.com/85 스프링 입문 - 프로젝트
surrealcode.tistory.com
h2 DB에 연결을 시도해보고 연결이 된다면 다음과 같은 쿼리를 실행하여 확인해보자.
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 ('hi1',10000);
insert into member(member_id, money) values ('hi2',20000);
select * from member; 시에 값이 제대로 나오는 것을 확인할 수 있다.
JDBC 이해
JDBC 등장 이유
애플리케이션을 개발할 때 중요한 데이터는 대부분 DB에 보관한다.
클라이언트가 애플리케이션 서버를 통해 데이터를 저장하거나 조회하면, 애플리케이션 서버는 다음 과정을 통해서 데이터 베이스를 사용한다.
1. 커넥션 연결 : 주로 TCP/IP를 사용하여 커넥션을 연결한다.
2. SQL 전달 : 애플리케이션 서버는 DB가 이해할 수 있는 SQL을 연결된 커넥션을 통해 DB에 전달한다.
3. 결과 응답 : DB는 전달된 SQL을 수행하고, 그 결과를 응답한다. 애플리케이션 서버는 응답 결과를 활용한다.
문제는 각각의 데이터베이스마다 커넥션을 연결하는 방법, SQL을 전달하는 방법, 결과를 응답 받는 방법이 모두 다르다는 점이다.
참고로 관계형 데이터베이스는 수십개가 존재한다.
문제
1. 데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버에 개발된 데이터 베이스 사용 코드도 함께 변경해야 한다.
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 드라이버라 한다.
정리
JDBC의 등장으로 다음 2가지 문제가 해결되었다.
1. 데이터베이스를 다른 종류의 데이터베이스로 변경하면 애플리케이션 서버의 데이터베이스 사용 코드도 함께 변경해야 하는 문제
- 애플리케이션 로직은 이제 JDBC 표준 인터페이스에만 의존한다. 따라서 데이터베이스를 다른 종류의 데이터베이스로 변경하고 싶으면, JDBC 구현 라이브러리만 변경하면 된다. 따라서 다른 종류의 데이터베이스로 변경해도 애플리케이션 서버의 사용 코드를 그대로 유지할 수 있다.
2. 개발자가 각각의 데이터베이스마다 커넥션 연결, SQL 전달, 그리고 그 결과를 응답 받는 방법을 새로 학습해야하는 문제
- 개발자는 JDBC 표준 인터페이스 사용법만 학습하면 된다. 한번 배워두면 수십개의 데이터베이스에 모두 동일하게 적용할 수 있다.
*참고 : JDBC의 등장으로 많은 것이 편리해졌지만, 각각의 데이터베이스마다 SQL, 데이터타입 등의 일부 사용법이 다르다. ANSI SQL이라는 표준이 있기는 하지만, 일반적인 부분만 공토화했기 때문에 한계가 존재한다. 대표적으로 실무에서 기본으로 사용하는 페이징SQL은 각각의 데이터베이스마다 사용법이 다르다. 결국 데이터베이스를 변경하면 JDBC코드는 변경하지 않아도 되지만, SQL은 해당 데이터베이스에 맞도록 변경해야 한다. 참고로 JPA를 사용하면 각각의 데이터베이스마다 다른 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 표준 인터페이스이고, 이것을 구현한 것으로 하이버네이트와 이클립스 링크 등의 구현 기술이 있다.
SQL Mapper vs ORM 기술
SQL Mapper와 ORM 기술 둘 다 각각 장단점이 있다.
쉽게 설명하자면 SQL Mapper는 SQL만 직접 작성하면 나머지 번거로운 일은 SQL Mapper가 대신 해결해준다.
SQL Mapper는 SQL만 작성할 줄 알면 금방 배워서 사용할 수 있다.
ORM 기술은 SQL 자체를 작성하지 않아도 되어서 개발 생산성이 매우 높아진다. 편리한 반면에 쉬운 기술은 아니므로 실무에서 사용하려면 깊이있게 학습해야 한다.
**중요
이런 SQL Mapper, ORM 기술들도 내부에서는 모두 JDBC를 사용한다. 따라서 JDBC를 직접 사용하지는 않더라도, JDBC가 어떻게 동작하는지 기본 원리를 알아두어야 한다. 그래야 해당 기술들을 더 깊이있게 이해할 수 있고, 무엇보다 문제가 발생했을 때 근본적인 문제를 찾아서 해결할 수 있다. JDBC는 자바 개발자라면 꼭 알아두어야 하는 필수 기본 기술이다.
데이터베이스 연결
애플리케이션과 데이터베이스를 연결해보자.
주의 : H2 데이터베이스 서버를 먼저 실행해두도록 해야한다.
패키지 구조는 위와 같다.
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 = "";
}
데이터베이스에 접속하는데 필요한 기본 정보를 편리하게 사용할 수 있도록 상수로 만들었다.
이제 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 데이터베이스 드라이버가 작동해서 실제 데이터베이스와 커넥션을 맺고 그 결과를 반환해준다.
간단한 학습용 테스트 코드를 만들어서 실행해보도록 하자.
@Slf4j
class DBConnectionUtilTest {
@Test
public void connection() throws Exception{
Connection connection = DBConnectionUtil.getConnection();
assertThat(connection).isNotNull();
}
}09:48:29.474 [Test worker] INFO hello.jdbc.connection.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는 java.sql.Connection표준 커넥션 인터페이스를 정의한다.
- H2 데이터베이스 드라이버는 JDBC Connection 인터페이스를 구현한 org.h2.jdbc.JdbcConnection 구현체를 제공한다.
JDBC가 제공하는 DriverManager는 라이브러리에 등록된 DB 드라이버들을 관리하고, 커넥션을 획득하는 기능을 제공한다.
1. 애플리케이션 로직에서 커넥션이 필요하면 DriverManager.getConnection()을 호출한다.
2. DriverManager는 라이브러리에 등록된 드라이버 목록을 자동으로 인식한다. 이 드라이버들에게 순서대로 다음 정보를 넘겨서 커넥션을 획득할 수 있는지 확인한다.
- URL : ex) jdbc:h2:tcp://localhost/~/test
- 이름, 비밀번호 등 접속에 필요한 추가 정보
- 여기서 각각의 드라이버는 URL 정보를 체크해서 본인이 처리할 수 있는 요청인지 확인한다. 예를 들어 URL이 jdbc:h2로 시작하면 이것은 h2 데이터베이스에 접근하기 위한 규칙이다. 따라서 H2 드라이버는 본인이 처리할 수 있으므로, 실제 데이터 베이스에 연결해서 커넥션을 획득하고, 이 커넥션을 클라이언트에 반환한다. 반면 URL이 jdbc:h2로 시작했는데 MySQL 드라이버가 먼저 실행되면, 이 경우 본인이 처리할 수 없다는 결과를 반환하고, 다음 드라이버에게 순서가 넘어간다.
3. 이렇게 찾은 커넥션 구현체가 클라이언트에 반환된다.
우리는 H2데이터베이스 드라이버만 라이브러리에 등록했기 때문에 H2드라이버가 제공하는 H2커넥션을 제공받는다. 물론 이 H2 커넥션은 JDBC가 제공하는 java.sql.Connection 인터페이스를 구현하고 있다.
JDBC 개발 - 등록
이제 본격적으로 JDBC를 사용해서 애플리케이션을 개발해보자.
여기서는 JDBC를 사용해서 회원(Member) 데이터를 데이터베이스에 관리하는 기능을 개발해보자.
주의! : H2 데이터베이스 설정 마지막에 있는 테이블과 샘플 데이터 만들기를 통해서 member 테이블을 미리 만들어두어야 한다.
drop table member if exists cascade;
create table member (
member_id varchar(10),
money integer not null default 0,
primary key (member_id)
);
패키지 구성은 다음과 같다.
/**
* 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 static 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을 반환하게 된다.
int executeUpdate() throws SQLException;
리소스 정리
쿼리를 실행하고 나면 리소스를 정리해주어야 한다. 여기서는 Connection, PreparedStatement를 사용했다. 리소스를 정리할때는 항상 역순으로 해야한다. Connection을 먼저 획득하고, Connection을 통해 PreparedStatement를 만들었기 때문에 리소스를 반환할 때는 PreparedStatement를 먼저 종료하고, 그 다음 Connection을 종료하면 된다. 참고로 여기서 사용하지 않은 ResultSet은 결과를 조회할 때 사용한다. 조금 뒤에 조회 부분에서 알아보자.
**주의 : 리소스 정리는 꼭 해주어야 한다. 따라서 예외가 발생하든, 하지 않든 항상 수행되어야 하므로 finally 구문에 주의해서 작성해야 한다. 만약 이 부분을 놓치게 되면, 커넥션이 끊어지지 않고 계속 유지되는 문제가 발생할 수 있다. 이런 것을 리소스 누수라고 하는데, 결과적으로 커넥션 부족으로 장애가 발생할 수 있다.
참고 : PreparedStatement는 Statement의 자식 타입인데, ?를 통한 파라미터 바인딩을 가능하게 해준다. 참고로 SQL Injection 공격을 예방하려면 PreapredStatement를 통한 파라미터 바인딩 방식을 사용해야 한다.
이제 테스트 코드를 사용하여 JDBC로 회원을 데이터베이스에 등록해보자.
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void save() throws SQLException {
Member member = new Member("userA", 10000);
repository.save(member);
}
}
실행결과 DB에 Select * from member쿼리를 실행해보면 데이터가 저장된 것을 확인할 수 있다.
참고로 이 테스트는 2번 실행하면 PK 중복 오류가 발생한다. 이 경우 delete from member 쿼리로 데이터를 삭제한 다음에 다시 실행하자.
JDBC 개발 - 조회
이번에는 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);
}
}
findById() - 쿼리 실행
- sql : 데이터 조회를 위한 select SQL을 준비한다.
- rs : pstmt.executeQuery() 데이터를 변경할 때는 executeUpdate()를 사용하지만, 데이터를 조회할 때는 executeQuery()를 사용한다. executeQuery()는 결과를 ResultSet에 담아서 반환한다.
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") : 현재 커서가 가리키고 있는 위치의 emmber_id 데이터를 String 타입으로 반환한다.
findById()에서는 회원하나를 조회하는 것이 목적이다. 따라서 조회 결과가 항상 한건이므로 while 대신에 if를 사용한다. 다음 SQL을 보면 PK인 member_id를 항상 지정하는 것을 확인할 수 있다.
SQL : select * from member where member_id = ?
테스트 코드를 통해 확인해보자.
@Slf4j
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void crud() throws SQLException {
//save
Member member = new Member("userB", 10000);
repository.save(member);
//findById
Member findMember = repository.findById(member.getMemberId());
log.info("findMember={}", findMember);
Assertions.assertThat(findMember).isEqualTo(member);
}
}
09:50:17.742 [Test worker] INFO hello.jdbc.repository.MemberRepositoryV0Test --findMember=Member(memberId=userB, money=10000)
- 회원을 등록하고, 그 결과를 바로 조회해서 확인해보았다.
- 참고로 실행 결과에 member 객체의 참조 값이 아니라 실제 데이터가 보이는 이유는 롬복의 @Data가 toString()을 적절히 오버라이딩 해서 보여주기 때문이다.
- isEqualTo() : findMember.equals(member)를 비교한다. 결과가 참인 이유는 롬복의 @Data는 해당 객체의 모든 필드를 사용하도록 equals()를 오버라이딩 하기 때문이다.
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);
pstmt.executeUpdate();
int resultSize = pstmt.executeUpdate();
log.info("resultSize={}", resultSize);
} catch (SQLException e) {
log.error("db error", e);
throw e;
} finally {
close(con, pstmt, pstmt.getResultSet());
}
}
executeUpdate()는 쿼리를 실행하고 영향 받은 row수를 반환한다. 여기서는 하나의 데이터만 변경하기 때문에 결과로 1이 반환된다. 만약 회원이 100명이고, 모든 회원의 데이터를 한번에 수정하는 update sql을 날리면 결과는 100이 될 것이다.
@Slf4j
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void crud() throws SQLException {
//save
Member member = new Member("userF", 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);회원 데이터의 money를 10000 -> 20000으로 수정하고, DB에서 데이터를 다시 조회해서 20000으로 변경되었는지 검증한다.
실행 로그
10:33:38.848 [Test worker] INFO hello.jdbc.repository.MemberRepositoryV0 -- resultSize=1
pstmt.executeUpdate()의 결과가 1인 것을 확인할 수 있다. 이것은 해당 SQL에 영향을 받은 로우 수가 1개라는 뜻이다.
데이터베이스에서 조회하면 memberV0의 money가 20000으로 변경된 것을 확인할 수 있다.
이번엔 회원을 삭제해보자.
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, pstmt.getResultSet());
}
}
약간의 쿼리 변경만 있을뿐 내용은 비슷하다.
@Slf4j
class MemberRepositoryV0Test {
MemberRepositoryV0 repository = new MemberRepositoryV0();
@Test
void crud() throws SQLException {
//save
Member member = new Member("userF", 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는 핻3ㅏㅇ 예외가 발생해야 검증에 성공한다.
참고 : 마지막에 회원을 삭제하기 때문에 테스트가 정상 수행되면, 이제부터는 같은 테스트를 반복해서 실행할 수 있다. 물론 테스트 중간에 오류가 발생해서 삭제 로직을 수행할 수 없다면, 테스트를 반복해서 실행할 수 없다. 트랜잭션을 활용하면 이 부분을 깔끔하게 해결 가능하다.
'공부 > Spring' 카테고리의 다른 글
| 트랜잭션 이해 (1) | 2025.05.15 |
|---|---|
| 커넥션풀과 데이터소스 이해 (1) | 2025.05.08 |
| 파일 업로드 (1) | 2025.04.21 |
| 스프링 타입 컨버터 (1) | 2025.04.15 |
| API 예외 처리 (0) | 2025.04.14 |