[Spring] JDBCTemplate

📕 JDBCTemplate 이란?

JdbcTemplate은 스프링 프레임워크에서 제공하는 JDBC(Java Database Connectivity) 기반의 데이터베이스 액세스를 단순화하고 편리하게 처리하기 위한 클래스이다. JDBC는 자바에서 데이터베이스와의 연결을 관리하고 SQL 쿼리를 실행하는 데 사용되는 표준 API이며, JdbcTemplate은 이러한 JDBC 기능을 더 편리하게 사용할 수 있도록 스프링에서 제공하는 도구 중 하나이다.

JdbcTemplate을 사용하면 일반적인 JDBC 코드에서 발생할 수 있는 반복적이고 지루한 작업들을 줄일 수 있으며, 예외 처리 및 리소스 관리 등을 자동으로 처리해준다.

• 참고 : https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html

🔍 JDBCTemplate의 이점

• 간결한 코드
  : JDBC 코드는 보통 많은 부분이 반복되고 번거로운데, JdbcTemplate을 사용하면 이러한 부분을 줄일 수 있습니다. 간결한 코드를 작성할 수 있도록 다양한 템플릿 메서드를 제공합니다.

• 예외 처리 자동화
  : JdbcTemplate은 JDBC 연산 중 발생하는 일반적인 예외들을 처리해주는데, 이를 통해 명시적인 예외 처리를 줄일 수 있습니다.

• 콜백 패턴 활용
  : JdbcTemplate은 JDBC 연산의 일부 또는 전체를 콜백 패턴을 통해 처리할 수 있도록 지원합니다. 이를 통해 사용자는 특정 작업을 수행하기 위해 필요한 로직을 제공할 수 있습니다(RowMapper와 PreparedStatementCallback).

• 편리한 ResultSet 처리
  : JdbcTemplate은 RowMapper 인터페이스를 통해 ResultSet의 데이터를 자바 객체로 매핑할 수 있도록 지원합니다. 이는 반복적인 ResultSet 처리를 편리하게 해줍니다.

• 트랜잭션 관리
  : JdbcTemplate은 스프링의 트랜잭션 매니저와 함께 사용될 수 있어서 데이터베이스 트랜잭션을 쉽게 관리할 수 있습니다.

📝 1. spring-jdbc

spring-jdbc는 Spring Framework에서 제공하는 JDBC(Java Database Connectivity) 지원을 담당하는 모듈 중 하나로서 데이터베이스와의 연결을 관리하고 JDBC 작업을 수행하는 데 도움을 주는 여러 유틸리티 클래스와 API를 포함하고 있다.

JDBC API를 개선하면서 커넥션 풀을 제공하는 확장된 API

• 의존성 추가 : "org.springframework:spring-jdbc:$spring_version"

Spring Framework에서 spring-jdbc 모듈을 사용할 때, 여러 가지 방식으로 커넥션 풀을 사용할 수 있다. 일반적으로 Spring은 외부 커넥션 풀을 사용하도록 구성할 수 있으며 Tomcat의 DataSource가 많이 사용되는데, 이는 Apache Tomcat이 내장하고 있는 커넥션 풀 구현체 중 하나이다.

1. 스프링 jdbc는 커넥션 풀을 지원하는 API이다
2. API는 구현체가 반드시 필요하며, 이때 많이 사용하는 구현체는 tomcat-jdbc의 DataSource이다.

📝 2. tomcat-jdbc / HikariCP(많이 사용함)

즉, spring-jdbc는 커넥션 풀을 지원하는 API이고, tomcat-jdbc의 DataSource는 커넥션 풀의 구현체 이다.

• DriverManger -> 커넥션 풀 없음 : 일반적인 접속
• 의존성 추가 : implementation 'org.apache.tomcat:tomcat-jdbc:10.1.16'
  
  

Tomcat의 DataSource는 커넥션을 풀에 반환하여 재사용하므로 개발자가 직접 커넥션을 닫을 필요가 없다.

Tomcat의 DataSource를 사용하면 커넥션 관리에 대한 부담이 감소하고, 커넥션 풀링을 통해 성능이 향상된다. 개발자는 커넥션을 얻은 후에 필요한 작업을 수행하고, 커넥션을 닫아주는 대신 반환만 하면 된다.

---

✨ 이 때, 커넥션 풀은 미리 만들어 놓은 객체를 받아 사용하는 것이기 때문에 연결된 객체가 유휴상태인지 체크하는 것이 중요하다. 오랜시간 연결이 되어있지 않으면 DB와의 연결이 끊기고 연결이 끊기게 되면 오류가 생기기 때문에 실제 DB와 연결된 상태인지 주기적으로 체크해야 한다.✨

tomcat-jdbc : 커넥션 풀을 지원하는 연결 객체 -> 자원을 소비함 -> 자원 해제해줘야함

---

💾 DBConfig 설정 파일

@Configuration
public class DBConfig {

    @Bean(destroyMethod = "close")
    public DataSource dataSource(){
        DataSource dataSource = new DataSource();
        dataSource.setDriverClassName("oracle.jdbc.OracleDriver");
        dataSource.setUrl("jdbc:oracle:thin:@localhost:1521:xe");
        dataSource.setUsername("spring6");
        dataSource.setPassword("aA123456");

        dataSource.setInitialSize(2); // 커넥션 풀을 초기화 할 때 생성할 갯수 많으면 시간이 오래 걸림
        dataSource.setTestWhileIdle(true); // db와의 연결이 끊어졌는 지 확인
        dataSource.setTimeBetweenEvictionRunsMillis(3000); // 유효상태를 유지할 최초 시간
        dataSource.setMinEvictableIdleTimeMillis(30*1000); // 유효 커넥션을 검사할 주기 시간
        return dataSource;
    }

    @Bean
    public JdbcTemplate jdbcTemplate(){
        return new JdbcTemplate(dataSource());
    }
}

📝 3. JdbcTemplate을 이용한 쿼리실행

자원해제가 필요하지 않고 컴파일예외가 아닌 런타임예외로 발생하기 때문에 SQLException등 try catch로 잡지 않아도 예외가 발생하지 않는다. 때때로 try catch가 필요하기도 함

자동 매핑이 됨 특정 데이터 객체로 반환해주는 로직이 있다.

각 연동 기술에 따라 발생하는 예외를 스프링이 제공하는 예외로 변환함으로써 다음과 같이 구현 기술에 상관없이 동일한 코드로 예외를 처리할 수 있게 된다.

• SQLException, HibernateException, PersistenceException -> DataAccessException(RuntimeException)

🔍 JDBC API

---

• 조회(SELECT)
  ResultSet executeQuery(..)
• 변경(INSERT, UPDATE, DELETE)
  int executeUpdate(..) : 반영된 레코드 개수 반환

💾 query API : 목록 데이터 조회

<T> List<T> query(String sql, RowMapper<T> rowMapper)
/* Execute a query given static SQL, mapping each row to a result object via a RowMapper. */
<T> List<T> query(String sql, RowMapper<T> rowMapper, Object... args)
/* Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a result object via a RowMapper. */

• RowMapper<T> : 변환, 검색 db에서 가져온 데이터를 가지고 원하는 데이터 객체로 변환해줌
• ... : 가변적

new RowMapper<Member>() {
	@Override
    public Member mapRow(ResultSet rs, int rowNum) throws SQLException {
    	return null;
    }
});

RowMapper는 JDBC 결과셋에서 각 행(row)의 데이터를 어떻게 추출할지 정의한 인터페이스로서 구현을 통해 ResultSet에서 읽은 데이터를 자바 객체의 setter메서드를 통해 매핑할 수 있다.
ResultSet은 커서의 위치를 의미하기 때문에 next로 다음 값을 불러와야 하는데 JDBCTemplate의 query메서드는 mapRow라는 인터페이스를 통해 쉽게 불러올 수 있다.

🔴 update - selectTest

	@Test
    @DisplayName("조회테스트")
    void selectTest(){
        String sql = "select * from member";
        List<Member> memberList = jdbcTemplate.query(sql, this::mapper);
        memberList.stream().forEach(System.out::println);
    }
    
    private Member mapper(ResultSet rs, int i) throws SQLException{
        return Member.builder()
                .userId(rs.getString("USER_ID"))
                .userPw(rs.getString("USER_PW"))
                .userName(rs.getString("USER_NAME"))
                .userNo(rs.getLong("USER_NO"))
                .email(rs.getString("EMAIL"))
                .build();
    }

💾 update API : 추가, 수정, 삭제

int update(String sql)
/* Issue a single SQL update operation (such as an insert, update or delete statement). */
int update(String sql, Object... args)
/* Issue a single SQL update operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments. */

🔴 update - insertTest

@ExtendWith(SpringExtension.class)
// 테스트환경에서의 스프링 컨테이너로 사용할 클래스
@ContextConfiguration(classes = AppConfig.class)
class DBConfigTest {

    @Autowired
    private DataSource dataSource;

    @Autowired
    private JdbcTemplate jdbcTemplate;
    
    @Test
    void insertTest(){
        // DataAccessException -> RuntimeException = 예외처리 x
        String sql = "insert into member (user_no, user_id, user_name, user_pw, email)" +
                "values (seq_member.nextval, ?, ?, ?, ?)";
        int update = jdbcTemplate.update(sql, "user01", "hong01", "123456", "e@e");
        System.out.println(update); // 1
    }
 }

🔍 SQL Log 확인하기

• API : slf4j-api
• 구현체 : logback-classic

• 정보의 양에 따라 로그 레벨이 있음 / 아래로 갈수록 양이 많아짐
  - FATAL
  - ERROR
  - WARN : 기능에 문제는 없지만, 향후 문제 가능성이 있음
  (정보성 로그)
  - INFO
  - DEBUG
  - TRACE

xml properties로 로그레벨을 설정할 수 있음 -> 패키지는 resource : 정적 자원

💾 logback.xml

<?xml version="1.0" encoding="UTF-8" ?>

<configuration>
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d %5p %c{2} - %m%n</pattern>
        </encoder>
    </appender>
    <root level="INFO">
        <appender-ref ref="stdout" />
    </root>

    <logger name="org.springframework.jdbc" level="TRACE" />
</configuration>

• ConsoleAppender : 콘솔화면에 로그 출력 / html등 파일로 출력하는 경우도 있음
• %d %5p %c{2} - %m%n : %d(날짜, 시간) / %5p(5자 내에서 로그 레벨 출력) / %c{2}(패키지를 한글자로 요약 + 클래스명) / %m(출력 메세지)
• INFO : 기본 레벨을 인포로 설정하여 인포 이상 모든 레벨 출력
• <logger name="org.springframework.jdbc" level="TRACE" /> : 특정 패키지는 디버그레벨

📝 4. PreparedStatementCreator를 이용한 쿼리 실행

🔴 PreparedStatementCreator - KeyHolder(자동생성 키값) 사용

@ExtendWith(SpringExtension.class)
// 테스트환경에서의 스프링 컨테이너로 사용할 클래스
@ContextConfiguration(classes = AppConfig.class)
class DBConfigTest {

    @Autowired
    private DataSource dataSource;

    @Autowired
    private JdbcTemplate jdbcTemplate;
    
    @Test
    @DisplayName("insert후 시퀀스 번호 추출하기")
    void insertTest2() {
            KeyHolder keyHolder = new GeneratedKeyHolder();
            int affectedRows = jdbcTemplate.update(con -> {
                        String sql = "INSERT INTO MEMBER (USER_NO, USER_ID, USER_PW, USER_NAME, EMAIL) \n" +
                                "VALUES (SEQ_MEMBER.nextval, ?, ?, ?, ?)";
                        PreparedStatement preparedStatement = con.prepareStatement(sql, new String[]{"USER_NO"});
                        preparedStatement.setString(1, "USER201");
                        preparedStatement.setString(2, "123456");
                        preparedStatement.setString(3, "사용자201");
                        preparedStatement.setString(4, "USER199@test.org");
                        return preparedStatement;
                    }
                    , keyHolder);
//        keyHolder.getKey();  반환 타입이 NUMBER임
            Long key = keyHolder.getKey().longValue();
            System.out.println(key);
      }
    
 }

📝 5. queryForObject() : 단일 데이터 조회, 통계형 데이터

🔴 queryForObject() : 예외에 민감 (DataAccessException 예외)

@ExtendWith(SpringExtension.class)
// 테스트환경에서의 스프링 컨테이너로 사용할 클래스
@ContextConfiguration(classes = AppConfig.class)
class DBConfigTest {

    @Autowired
    private DataSource dataSource;

    @Autowired
    private JdbcTemplate jdbcTemplate;
    
	@Test
    @DisplayName("1건 조회")
    void selectTest2(){
        String user_id = "USER201";
        String sql = "select * from member where user_id = ?";
        try {
            Member member = jdbcTemplate.queryForObject(sql, this::mapper, user_id); // 예외에 민감하다.
            System.out.println(member);
        }catch (DataAccessException e){
            System.out.println("조회된 데이터 없음");
        }
    }
    
    @Test
    @DisplayName("멤버수 조회")
    void selectTest3(){
        String sql="select count(*) from member";
        Long l = jdbcTemplate.queryForObject(sql, long.class);
        System.out.println(l);
    }
 }

📝 6. @Transactional

SQL의 실행 단위로 commit(DB영구반영)전 까지가 하나의 트랜잭션이다.
트랜잭션을 수동으로 관리해줘야 할 때(연속된 커리는 수동으로 관리해야함) 사용

• 기본값 : autocommit(true) : 1개 SQL 실행시 자동 COMMIT- 기본값 : autocommit(true) : 1개 SQL 실행시 자동 COMMIT

💾 DBConfig.class에 빈 추가

    /**
     * PlatformTransactionManager : 인터페이스
     * DataSourceTransactionManager : 구현체
     */
    @Bean
    public PlatformTransactionManager transactionManager(){
        DataSourceTransactionManager tm = new DataSourceTransactionManager(dataSource());
        return tm;
    }

트랜잭션 관련된 부분을 빈으로 추가한다. (스프링부트에선 자동)

💾 @Transactional 애너테이션(트랜잭션 AOP)

conn.setAutocommit(false); // 공통 기능 

// 핵심 기능
SQL1 
SQL2
SQL3
...

conn.commit(); // 공통 기능

PlatformTransactionManager가 위의 로직을 프록시로 구현해주기 때문에 @Transactional 애너테이션이 붙은 클래스나 메서드는 위 로직이 적용된다.