스프링 DB 1편 - 데이터 접근 핵심 원리 정리(1)

Jim·2023년 7월 27일
DatasourceJDBCSpringbootdb
0

스프링

목록 보기
8/10
post-thumbnail

1. JDBC 이해

1. H2 데이터베이스 설정

H2DB는 자바 기반 오픈 소스 RDBMS(관계형 데이터 베이스 관리 시스템)이다.

이번 주제에서는 H2DB Server Mode를 사용할 것이기 때문에 Server Mode 사용법을 설명하겠다.

다운로드 및 설치, 실행

  • h2 데이터베이스 버전은 스프링 부트 버전에 맞춘다.
  • 윈도우 기준 bin 폴더의 h2w.bat 실행

데이터베이스 파일 생성

  • 사용자명은 sa
  • JDBC URL에 jdbc:h2:~/test 입력 후 연결 (최초 한번)
    • ~/test.mv.db 파일 생성 확인
  • 이후부터는 jdbc:h2:tcp://localhost/~/test 이렇게 접속

2. JDBC 등장 이유

애플리케이션 서버와 DB - 일반적인 사용법

  • 커넥션 연결: 주로 TCP/IP를 사용해서 커넥션을 연결.
  • SQL 전달: 애플리케이션 서버는 DB가 이해할 수 있는 SQL을 연결된 커넥션을 통해 DB에 전달.
  • 결과 응답: DB는 전달된 SQL을 수행하고 그 결과를 응답한다. 애플리케이션 서버는 응답 결과를 활용한다.

애플리케이션 서버와 DB - DB 변경

  • 각각의 데이터베이스마다 커넥션을 연결하는 방법, SQL을 전달하는 방법, 결과를 응답 받는 방법이 모두 다르다.
  • 위의 문제를 해결하기 위해 JDBC라는 자바 표준이 등장.

3. JDBC 표준 인터페이스

  • JDBC(Java Database Connectivity)는 자바에서 데이터베이스에 접속할 수 있도록 하는 자바 API다. JDBC는 데이터베이스에서 자료를 쿼리하거나 업데이트하는 방법을 제공한다. - 위키백과
  • JDBC API는 다음 두 패키지로 구성되어 있다.
    • java.sql
    • javax.sql

JDBC 표준 인터페이스 기능

  • 대표적으로 다음 3가지 기능을 표준 인터페이스로 정의해서 제공.
    • java.sql.Connection - 연결
    • java.sql.Statement - SQL을 담은 내용
    • java.sql.ResultSet - SQL 요청 응답

JDBC 드라이버

  • JDBC 인터페이스를 각각의 DB벤더에서 자신의 DB에 맞도록 구현해서 라이브러리로 제공하는데, 이것을 JDBC 드라이버라 한다.
    • MySQL JDBC 드라이버
    • Oracle JDBC 드라이버

정리

  • 애플리케이션 로직은 이제 JDBC 표준 인터페이스에만 의존한다. 데이터베이스를 다른 종류의 데이터 베이스로 변경하고 싶으면 JDBC 구현 라이브러리만 변경하면 된다. 다른 종류의 데이터베이스로 변경해도 애플리케이션 서버의 사용 코드를 그대로 유지할 수 있다.
  • 개발자는 JDBC 표준 인터페이스 사용법만 학습하면 된다.
  • 표준화의 한계
    • 각각의 데이터베이스마다 SQL, 데이터타입 등의 일부 사용법이 다르다. ANSI SQL이라는 표준이 있기는 하지만 일반적인 부분만 공통화했다. 대표적으로 페이징 SQL은 각각의 데이터베이스마다 사용법이 다르다.
    • 결국 데이터베이스를 변경하면 JDBC 코드는 변경하지 않아도 되지만 SQL은 해당 데이터베이스에 맞도록 변경해야 한다.
    • JPA(Java Persistence API)를 사용하면 각각의 데이터베이스마다 다른 SQL을 정의해야 하는 문제도 많은 부분 해결할 수 있다.

4. JDBC와 최신 데이터 접근 기술

JDBC는 1997년에 출시될 정도로 오래된 기술이고, 사용하는 방법도 복잡하다. 최근에는 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는 SQL만 직접 작성하면 나머지 번거로운 일은 SQL Mapper가 대신 해결해준다. SQL Mapper는 SQL만 작성할 줄 알면 금방 배워서 사용할 수 있다.
  • ORM 기술은 SQL 자체를 작성하지 않아도 되어서 개발 생산성이 매우 높아진다. 편리한 반면에 쉬운 기술은 아니므로 실무에서 사용하려면 깊이있게 학습해야 한다.
  • 이런 기술들도 내부에서는 모두 JDBC를 사용한다. 따라서 JDBC를 직접 사용하지는 않더라도, JDBC가 어떻게 동작하는지 기본 원리를 알아두어야 한다. 그래야 해당 기술들을 더 깊이있게 이해할 수 있고, 무엇보다 문제가 발생했을 때 근본적인 문제를 찾아서 해결할 수 있다.

5. 데이터베이스 연결

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 = "";
}
  • 데이터베이스에 접속하는데 필요한 기본 정보를 편리하게 사용할 수 있도록 상수로 만들었다.

DBConnectionUtil

@Slf4j
public class DBConnectionUtil {

    //JDBC 표준 인터페이스가 제공하는 Connection
    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

@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는 java.sql.Connection 표준 커넥션 인터페이스를 정의한다.
  • H2 데이터베이스 드라이버는 JDBC Connection 인터페이스를 구현한 org.h2.jdbc.JdbcConnection 구현체를 제공한다.

DriverManager 커넥션 요청 흐름

  • JDBC가 제공하는 DriverManager는 라이브러리에 등록된 DB 드라이버들을 관리하고, 커넥션을 획득하는 기능을 제공한다.
    • H2 데이터베이스 드라이버 라이브러리
      runtimeOnly 'com.h2database:h2' //h2-x.x.xxx.jar

6. JDBC 개발 - 등록

JDBC를 사용해서 애플리케이션을 개발해보자.
회원(Member) 데이터를 데이터베이스에 관리하는 기능을 개발해본다.

테이블 생성

drop table member if exists cascade;
create table member (
	member_id varchar(10),
 	money integer not null default 0,
 	primary key (member_id)
);

Member

@Data
public class Member {

    private String memberId;
    private int money;

    public Member() {
    }

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

MemberRepositoryV0 - 회원 등록

/**
 * 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;
        //Statement 에서 파라미터 바인딩 기능 추가
        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을 정의한다.
    • 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 수를 반환한다.
  • executeUpdate()
    • int executeUpdate() throws SQLException;
  • 리소스 정리
    • 리소스를 정리할 때는 항상 역순으로 해야한다. Connection을 먼저 획득하고 Connection을 통해 PreparedStatement를 만들었기 때문에 리소스를 반환할 때는 PreparedStatement를 먼저 종료하고, Connection을 종료한다.
    • 리소스는 꼭! 정리해 주어야 한다. (finally)
    • 만약 이 부분을 놓치게 되면 커넥션이 끊어지지 않고 계속 유지되는 문제가 발생할 수 있다. 이것을 리소스 누수라고 하는데, 커넥션 부족으로 장애가 발생할 수 있다.
  • PreparedStatement는 Statement의 자식 타입, ?를 통한 파라미터 바인딩을 가능하게 해준다.
  • SQL Injection 공격을 예방하려면 PreparedStatement를 통한 파라미터 바인딩 방식을 사용해야 한다.

MemberRepositoryV0Test - 회원 등록

class MemberRepositoryV0Test {
	
    MemberRepositoryV0 repository = new MemberRepositoryV0();
	
    @Test
 	void crud() throws SQLException {
 		//save
 		Member member = new Member("memberV0", 10000);
 		repository.save(member);
 	}
}
  • 이 테스트는 두 번 실행시 PK 중복 오류가 발생. delete from member쿼리로 데이터 삭제 후 다시 실행하자.

7. JDBC개발 - 조회

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() - 쿼리 실행
    • rs = pstmt.executeQuery(): 데이터를 변경할 때는 executeUpdate()를 사용하지만, 데이터를 조회할 때는 executeQuery()를 사용한다. executeQuery()는 결과를 ResultSet에 담아서 반환한다.
  • executeQuery()
    • ResultSet executeQuery() throws SQLException;
  • ResultSet
    • 보통 select 쿼리의 결과가 순서대로 들어간다.
      • 예를 들어 select member_id, money라고 지정하면 member_id, money라는 이름으로 데이터가 저장된다.
    • ResultSet 내부에 있는 커서(cursor)를 이동해서 다음 데이터를 조회할 수 있다.
    • rs.next(): 이것을 호출하면 커서가 다음으로 이동한다. 최초의 커서는 데이터를 가리키고 있지 않기 때문에, rs.next()를 최초 한번은 호출해야 데이터를 조회할 수 있다.
      • rs.next() == true -> 커서의 이동 결과 데이터가 있다.
      • rs.next() == false -> 더이상 커서가 가리키는 데이터가 없다.
    • rs.getString("member_id"): 현재 커서가 가리키고 있는 위치의 member_id 데이터를 String 타입으로 반환.
    • rs.getInt("money"): 현재 커서가 가리키고 있는 위치의 money 데이터를 int 타입으로 반환.

MemberRepositoryV0Test - 회원 조회 추가

//findById
Member findMember = repository.findById(member.getMemberId());
log.info("findMember={}", findMember);
log.info("member == findMember {}", member == findMember); //false
log.info("member equals findMember {}", member.equals(findMember)); //true (EqualsAndHashCode)
assertThat(findMember).isEqualTo(member); //EqualsAndHashCode
  • 이 테스트는 두 번 실행시 PK 중복 오류가 발생. delete from member쿼리로 데이터 삭제 후 다시 실행하자.

8. JDBC 개발 - 수정, 삭제

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

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 수를 반환.

MemberRepositoryV0Test - 회원 수정 추가

//update: money: 10000 -> 20000
repository.update(member.getMemberId(), 20000);
Member updateMember = repository.findById(member.getMemberId());
assertThat(updateMember.getMoney()).isEqualTo(20000);
  • 이 테스트는 두 번 실행시 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 - 회원 삭제 추가

//delete
repository.delete(member.getMemberId());
assertThatThrownBy(() -> repository.findById(member.getMemberId()))
		.isInstanceOf(NoSuchElementException.class);
  • 마지막에 회원을 삭제하기 때문에 이제부터는 같은 테스트를 반복해서 실행할 수 있다.

2. 커넥션풀과 데이터소스 이해

1. 커넥션 풀 이해

데이터베이스 커넥션을 매번 획득

  • 위와 같이 커넥션을 새로 만드는 것은 과정도 복잡하고 시간도 많이 소모되는 일이다. DB는 물론이고 애플리케이션 서버에서도 TCP/IP 커넥션(3 way handshake)을 새로 생성하기 위한 리소스를 매번 사용해야 한다.
  • 진짜 문제는 고객이 애플리케이션을 사용할 때, SQL을 실행하는 시간 뿐만 아니라 커넥션을 새로 만드는 시간이 추가되기 때문에 응답 속도에 영향을 준다.
  • 데이터베이스마다 커넥션을 생성하는 시간은 다르다. 시스템 상황마다 다르지만 MySQL 계열은 수 ms(밀리초) 정도로 매우 빨리 커넥션을 확보할 수 있다. 반면에 수십 밀리초 이상 걸리는 데이터베이스들도 있다.
  • 위의 문제들을 한번에 해결하는 아이디어가 바로 커넥션을 미리 생성해두고 사용하는 커넥션 풀이다.

커넥션 풀 초기화

  • 애플리케이션을 시작하는 시점에 커넥션 풀은 필요한 만큼 커넥션을 미리 확보해서 풀에 보관한다. 얼마나 보관할 지는 서비스의 특징과 서버 스펙에 따라 다르지만 기본값은 보통 10개이다.

커넥션 풀의 연결 상태

  • 커넥션 풀에 들어 있는 커넥션은 TCP/IP로 DB와 커넥션이 연결되어 있는 상태이기 때문에 언제든지 즉시 SQL을 DB에 전달할 수 있다.

커넥션 풀 사용1

  • 애플리케이션 로직에서 이제는 DB 드라이버를 통해서 새로운 커넥션을 획득하는 것이 아니다.
  • 이제는 커넥션 풀을 통해 이미 생성되어 있는 커넥션을 객체 참조로 그냥 가져다 쓰기만 하면 된다.
  • 커넥션 풀에 커넥션을 요청하면 커넥션 풀은 자신이 가지고 있는 커넥션 중에 하나를 반환한다.

커넥션 풀 사용2

  • 애플리케이션 로직은 커넥션 풀에서 받은 커넥션을 사용해서 SQL을 데이터베이스에 전달하고 그 결과를 받아서 처리한다.
  • 커넥션을 모두 사용하고 나면 이제는 커넥션을 종료하는 것이 아니라, 다음에 다시 사용할 수 있도록 해당 커넥션을 그대로 커넥션 풀에 반환하면 된다. 커넥션을 종료하는 것이 아니라 커넥션이 살아있는 상태로 커넥션 풀에 반환해야 한다.

정리

  • 적절한 커넥션 풀 숫자는 서비스의 특징과 애플리케이션 서버 스펙, DB 서버 스펙에 따라 다르기 때문에 성능 테스트를 통해서 정해야 한다.
  • 커넥션 풀은 서버당 최대 커넥션 수를 제한할 수 있다. 따라서 DB에 무한정 연결이 생성되는 것을 막아주어서 DB를 보호하는 효과도 있다.
  • 이런 커넥션 풀은 얻는 이점이 매우 크기 때문에 실무에서는 항상 기본으로 사용한다.
  • 커넥션 풀은 개념적으로 단순해서 직접 구현할 수도 있지만, 사용도 편리하고 성능도 뛰어난 오픈소스 커넥션 풀이 많기 때문에 오픈소스를 사용하는 것이 좋다.
  • 대표적인 커넥션 풀 오픈소스는 commons-dbcp2, tomcat-jdbc pool, HikariCP등이 있다.
  • 성능과 사용의 편리함 측면에서 최근에는 HikariCp를 주로 사용한다. 스프링 부트 2.0부터는 기본 커넥션 풀로 HikariCp를 제공한다. 성능, 사용의 편리함, 안정성 측면에서 이미 검증이 되었기 때문에 커넥션 풀을 사용할 때는 고민할 것 없이 HikariCP를 사용하면 된다.

2. DataSource 이해

커넥션을 얻는 방법은 앞서 학습한 JDBC DriverManager를 직접 사용하거나, 커넥션 풀을 사용하는 등 다양한 방법이 존재한다.

DriverManager를 통해 커넥션 획득하다가 커넥션 풀로 변경시 문제

  • 커넥션을 획득하는 애플리케이션 코드도 함께 변경해야 한다. 의존관계가 DriverManager에서 HikariCP같은 커넥션 풀로 변경되기 때문이다. 물론 둘의 사용법도 조금씩 다를 것이다.

커넥션을 획득하는 방법을 추상화

  • 자바에서는 이런 문제를 해결하기 위해 javax.sql.DataSource라는 인터페이스를 제공한다.
  • DataSource는 커넥션을 획득하는 방법을 추상화 하는 인터페이스이다.
  • 이 인터페이스의 핵심 기능은 커넥션 조회 하나이다.(다른 일부 기능도 있지만 크게 중요하지 않다.)

DataSource 핵심 기능만 축약

public interface DataSource {
	Connection getConnection() throws SQLException;
}

정리

  • 대부분의 커넥션 풀은 DataSource 인터페이스를 이미 구현해두었다. 개발자는 DBCP2 커넥션 풀, HikariCP 커넥션 풀의 코드를 직접 의존하는 것이 아니라 DataSource 인터페이스에만 의존하도록 애플리케이션 로직을 작성하면 된다.
  • 커넥션 풀 구현 기술을 변경하고 싶으면 해당 구현체로 갈아끼우기만 하면 된다.
  • DriverManager는 DataSource 인터페이스를 사용하지 않는다. 따라서 DriverManager는 직접 사용해야 한다. 만약 DriverManager를 사용하다가 DataSource 기반의 커넥션 풀을 사용하도록 변경하면 관련 코드를 다 고쳐야 한다.
  • 스프링은 DriverManager도 DataSource를 통해서 사용할 수 있도록 DriverManagerDataSource라는 DataSource를 구현한 클래스를 제공한다.

3. DataSource 예제 1 - DriverManager

ConnectionTest - 드라이버 매니저

@Slf4j
public class ConnectionTest {
	
    @Test
	void driverManager() throws SQLException {
		Connection con1 = DriverManager.getConnection(URL, USERNAME, PASSWORD);
 		Connection con2 = DriverManager.getConnection(URL, USERNAME, PASSWORD);
 		log.info("connection={}, class={}", con1, con1.getClass());
 		log.info("connection={}, class={}", con2, con2.getClass());
 	}
}
//실행 결과
connection=conn0: url=jdbc:h2:tcp://..test user=SA, class=class 
org.h2.jdbc.JdbcConnection
connection=conn1: url=jdbc:h2:tcp://..test user=SA, class=class 
org.h2.jdbc.JdbcConnection
  • DriverManager를 통해서 커넥션을 획득.

ConnectionTest - 데이터소스 드라이버 매니저 추가

@Test
void dataSourceDriverManager() throws SQLException {
	//DriverManagerDataSource - 항상 새로운 커넥션 획득
 	DriverManagerDataSource dataSource 
    			= new DriverManagerDataSource(URL, USERNAME, PASSWORD);
 	useDataSource(dataSource);
}
 
private void useDataSource(DataSource dataSource) throws SQLException {
	Connection con1 = dataSource.getConnection();
 	Connection con2 = dataSource.getConnection();
 	log.info("connection={}, class={}", con1, con1.getClass());
 	log.info("connection={}, class={}", con2, con2.getClass());
}
//실행 결과
DriverManagerDataSource - Creating new JDBC DriverManager Connection to 
[jdbc:h2:tcp:..test]
DriverManagerDataSource - Creating new JDBC DriverManager Connection to 
[jdbc:h2:tcp:..test]
connection=conn0: url=jdbc:h2:tcp://..test user=SA, class=class 
org.h2.jdbc.JdbcConnection
connection=conn1: url=jdbc:h2:tcp://..test user=SA, class=class 
org.h2.jdbc.JdbcConnection
  • 스프링이 제공하는 DataSource가 적용된 DriverManager인 DriverManagerDataSource 사용
  • DriverManagerDataSource는 DataSource를 통해서 커넥션을 획득.
  • DriverManager는 커넥션을 획득할 때 마다 URL, USERNAME, PASSWORD 같은 파라미터를 계속 전달해야 한다. 반면에 DataSource를 사용하는 방식은 처음 객체를 생성할 때만 필요한 파라미터를 넘겨주고, 커넥션을 획득할 때는 단순히 dataSource.getConnection()만 호출하면 된다.

설정과 사용의 분리

  • 필요한 데이터를 DataSource가 만들어지는 시점에 미리 다 넣어두게 되면, DataSource를 사용하는 곳에서는 dataSource.getConnection()만 호출하면 되므로, URL, USERNAME, PASSWORD 같은 속성들에 의존하지 않아도 된다. DataSource만 주입받아서 getConnection()만 호출하면 된다.
  • 리포지토리(Repository)는 DataSource만 의존하고, 이런 속성을 몰라도 된다.
  • 객체를 설정하는 부분과, 사용하는 부분을 좀 더 명확하게 분리할 수 있다.

4. DataSource 예제 2 - 커넥션 풀

DataSource를 통해 커넥션 풀을 사용하는 예제를 알아보자.

ConnectionTest - 데이터소스 커넥션 풀 추가

 @Test
 void dataSourceConnectionPool() throws SQLException, InterruptedException {
 	//커넥션 풀링: HikariProxyConnection(Proxy) -> JdbcConnection(Target)
    HikariDataSource dataSource = new HikariDataSource();
    dataSource.setJdbcUrl(URL);
    dataSource.setUsername(USERNAME);
    dataSource.setPassword(PASSWORD);
    dataSource.setMaximumPoolSize(10); //default
    dataSource.setPoolName("MyPool");

    useDateSource(dataSource);
    Thread.sleep(1000); //커넥션 풀에서 커넥션 생성 시간 대기
}
  • HikariCP 커넥션 풀을 사용. HikariDataSource는 DataSource 인터페이스를 구현하고 있다.
  • 커넥션 풀에서 커넥션을 생성하는 작업은 애플리케이션 실행 속도에 영향을 주지 않기 위해 별도의 쓰레드에서 작동한다. 별도의 쓰레드에서 동작하기 때문에 테스트가 먼저 종료되어 버린다.
  • 위 처럼 Thread.sleep을 통해 대시 기간을 주어야 쓰레드 풀에 커넥션이 생성되는 로그를 확인할 수 있다.
//실행 결과
//로그 순서는 이해하기 쉽게 약간 수정
#커넥션 풀 초기화 정보 출력
HikariConfig - MyPool - configuration:
HikariConfig - maximumPoolSize................................10
HikariConfig - poolName................................"MyPool"

#커넥션 풀 전용 쓰레드가 커넥션 풀에 커넥션을 10개 채움
[MyPool connection adder] MyPool - Added connection conn0: url=jdbc:h2:.. 
user=SA
[MyPool connection adder] MyPool - Added connection conn1: url=jdbc:h2:.. 
user=SA
[MyPool connection adder] MyPool - Added connection conn2: url=jdbc:h2:.. 
user=SA
[MyPool connection adder] MyPool - Added connection conn3: url=jdbc:h2:.. 
user=SA
[MyPool connection adder] MyPool - Added connection conn4: url=jdbc:h2:.. 
user=SA
...
[MyPool connection adder] MyPool - Added connection conn9: url=jdbc:h2:.. 
user=SA

#커넥션 풀에서 커넥션 획득1
ConnectionTest - connection=HikariProxyConnection@446445803 wrapping conn0: 
url=jdbc:h2:tcp://localhost/~/test user=SA, class=class 
com.zaxxer.hikari.pool.HikariProxyConnection
#커넥션 풀에서 커넥션 획득2
ConnectionTest - connection=HikariProxyConnection@832292933 wrapping conn1: 
url=jdbc:h2:tcp://localhost/~/test user=SA, class=class 
com.zaxxer.hikari.pool.HikariProxyConnection

MyPool - After adding stats (total=10, active=2, idle=8, waiting=0)
  • HikariConfig
    • HikariCP 관련 설정을 확인할 수 있다.
  • MyPool connection adder
    • 별도의 쓰레드 사용해서 커넥션 풀에 커넥션을 채우고 있다. 이렇게 해야 애플리케이션 실행 시간에 영향을 주지 않는다.
  • 커넥션 풀에서 커넥션 획득
    • 커넥션 풀에서 커넥션을 획득하고 그 결과를 출력.
    • 커넥션 풀에서 커넥션을 2개 획득하고 반환하지 않아 풀에 있는 10개의 커넥션 중 2개를 가지고 있는 상태.
  • HikariCP 커넥션 풀에 대한 더 자세한 내용은 공식 사이트 참고.
  • 스프링 부트 3.1 이상일 경우 src/main/resources/logback.xml에 아래 내용을 넣어야 전체 로그가 출력된다.
<configuration>
	
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
 			<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%kvp- %msg%n</pattern>
 		</encoder>
 	</appender>
 
	<root level="DEBUG">
 		<appender-ref ref="STDOUT" />
 	</root>
  
</configuration>
  • 스프링 부트 3.1부터 기본 로그 레벨을 INFO로 빠르게 설정하기 때문에 로그를 확인할 수 없는데, 이렇게 하면 기본 로그 레벨을 DEBUG로 설정해서 전체 로그를 볼 수 있다.

5. DataSource 적용

애플리케이션에 DataSource를 적용.

MemberRepositoryV1

/**
 * JDBC - DataSource 사용, JdbcUtils 사용
 */
@Slf4j
public class MemberRepositoryV1 {
	
    private final DataSource dataSource;
	
    public MemberRepositoryV1(DataSource dataSource) {
    	this.dataSource = dataSource;
 	}
 
 	//save()...
 	//findById()...
 	//update()....
 	//delete()....
 
 	private void close(Connection con, Statement stmt, ResultSet rs) {
 		JdbcUtils.closeResultSet(rs);
 		JdbcUtils.closeStatement(stmt);
 		JdbcUtils.closeConnection(con);
 	}
 
 	private Connection getConnection() throws SQLException {
 		Connection con = dataSource.getConnection();
 		log.info("get connection={}, class={}", con, con.getClass());
 		return con;
 	}
}
  • DataSource 의존관계 주입
    • 외부에서 DataSource를 주입 받아서 사용. 직접 만든 DBConnectionUtil을 사용하지 않는다.
    • DataSource는 표준 인터페이스 이기 때문에 DriverManagerDataSource에서 HikariDataSource로 변경되어도 해당 코드를 변경하지 않아도 된다.
  • JdbcUtils 편의 메서드
    • 스프링은 JDBC를 편리하게 다룰 수 있는 JdbcUtils라는 편의 메서드 제공.
    • JdbcUtils를 사용하면 커넥션을 좀 더 편리하게 닫을 수 있다.

MemberRepositoryV1Test

@Slf4j
class MemberRepositoryV1Test {

    MemberRepositoryV1 repository;

    @BeforeEach
    void beforeEach() {
        //기본 DriverManager - 항상 새로운 커넥션을 획득
//        DriverManagerDataSource dataSource 
//					= new DriverManagerDataSource(URL, USERNAME, PASSWORD);

        //커넥션 풀링
        HikariDataSource dataSource = new HikariDataSource();
        dataSource.setJdbcUrl(URL);
        dataSource.setUsername(USERNAME);
        dataSource.setPassword(PASSWORD);
        repository = new MemberRepositoryV1(dataSource);
    }

    @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); //false
        log.info("member equals findMember {}", member.equals(findMember)); //true (EqualsAndHashCode)
        assertThat(findMember).isEqualTo(member); //EqualsAndHashCode

        //update: money: 10000 -> 20000
        repository.update(member.getMemberId(), 20000);
        Member updateMember = repository.findById(member.getMemberId());
        assertThat(updateMember.getMoney()).isEqualTo(20000);

        //delete
        repository.delete(member.getMemberId());
        assertThatThrownBy(() -> repository.findById(member.getMemberId()))
                .isInstanceOf(NoSuchElementException.class);
    }
}
  • MemberRepositoryV1은 DataSource 의존관계 주입이 필요하다.
//DriverManagerDataSource 사용
get connection=conn0: url=jdbc:h2:.. user=SA class=class 
org.h2.jdbc.JdbcConnection
get connection=conn1: url=jdbc:h2:.. user=SA class=class 
org.h2.jdbc.JdbcConnection
get connection=conn2: url=jdbc:h2:.. user=SA class=class 
org.h2.jdbc.JdbcConnection
get connection=conn3: url=jdbc:h2:.. user=SA class=class 
org.h2.jdbc.JdbcConnection
get connection=conn4: url=jdbc:h2:.. user=SA class=class 
org.h2.jdbc.JdbcConnection
get connection=conn5: url=jdbc:h2:.. user=SA class=class 
org.h2.jdbc.JdbcConnection
  • DriverManagerDataSource를 사용하면 conn0~5 번호를 통해서 항상 새로운 커넥션이 생성되어 사용.
//HikariDataSource 사용
get connection=HikariProxyConnection@xxxxxxxx1 wrapping conn0: url=jdbc:h2:... 
user=SA
get connection=HikariProxyConnection@xxxxxxxx2 wrapping conn0: url=jdbc:h2:... 
user=SA
get connection=HikariProxyConnection@xxxxxxxx3 wrapping conn0: url=jdbc:h2:... 
user=SA
get connection=HikariProxyConnection@xxxxxxxx4 wrapping conn0: url=jdbc:h2:... 
user=SA
get connection=HikariProxyConnection@xxxxxxxx5 wrapping conn0: url=jdbc:h2:... 
user=SA
get connection=HikariProxyConnection@xxxxxxxx6 wrapping conn0: url=jdbc:h2:... 
user=SA
  • 커넥션 풀 사용시 conn0 커넥션이 재사용.
  • 테스트는 순서대로 실행되기 때문에 커넥션을 사용하고 다시 돌려주는 것을 반복.
  • 웹 애플리케이션에 동시에 여러 요청이 들어오면 여러 쓰레드에서 커넥션 풀의 커넥션을 다양하게 가져가는 상황을 확인할 수 있다.
  • DI
    • DirverManagerDataSource -> HikariDataSource로 변경해도 MemberRepositoryV1의 코드는 전혀 변경하지 않아도 된다.
    • MemberRepositoryV1는 DataSource 인터페이스에만 의존. 이것이 DataSource를 사용하는 장점.(DI + OCP)

스프링 DB 1편 - 데이터 접근 핵심 원리

profile
Jim
You never fail until you stop trying.
이전 포스트

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 정리(5)

다음 포스트

스프링 DB 1편 - 데이터 접근 핵심 원리 정리(2)

0개의 댓글