[스프링 DB 1편] #6. 스프링과 문제해결 - 예외처리, 반복 (1)

[Pracrobo]

체크 예외와 인터페이스

SQLException 에 대한 의존을 제거하려면 어떻게 해야할까?

서비스가 처리할 수 없는 리포지토리가 던지는 SQLException 체크 예외를 런타임 예외로 전환해서 서비스 계층에 던지자. 이렇게 하면 서비스 계층이 해당 예외를 무시할 수 있기 때문에 특정 구현 기술에 의존하는 부분을 제거하고 서비스 계층을 순수하게 유지할 수 있다.

먼저 인터페이스를 도입한다.

‘MemberRepository’

package hello.jdbc.repository;

import hello.jdbc.domain.Member;

public interface MemberRepository {
    Member save(Member member);

    Member findById(String memberId);

    void update(String memberId, int money);

    void delete(String memberId);

}

SQLException 는 체크 예외이기 때문에 사용하려면 인터페이스에도 해당 체크 예외가 선언되어 있어야 한다.

체크 예외 코드에 인터페이스 도입시 문제점 : 인터페이스

package hello.jdbc.repository;
import hello.jdbc.domain.Member;
import java.sql.SQLException;

public interface MemberRepositoryEx {
	Member save(Member member) throws SQLException;
	Member findById(String memberId) throws SQLException;
	void update(String memberId, int money) throws SQLException;
	void delete(String memberId) throws SQLException;
}

• 인터페이스의 메서드에 throws SQLExceptrion이 있는 것을 확인할 수 있다.

체크 예외 코드에 인터페이스 도입시 문제점 : 구현 클래스

@Slf4j
public class MemberRepositoryV3 implements MemberRepositoryEx{

	public Member save(Member member) throws SQLException {
		String sql = "insert into member(member_id, money) values(?, ?)"
	}
}

• 인터페이스의 구현체가 체크 예외를 던지려면, 인터페이스 메서드에 먼저 체크 예외를 던지는 부분이 선언되어 있어야 한다. 그래야 구현 클래스의 메서드도 체크 예외를 던질 수 있다.

• 쉽게 얘기해 ‘MemberRepositoryV3’가 ‘throws SQLException’을 하려면 ‘MemberRepositoryEx’ 인터페이스에도 ‘throws SQLException’이 필요하다.

• 참고로 구현 클래스에메 메서드 선언할 수 있는 예외는 부모타입에서 던진 예외와 같거나 하위 타입이어야 한다.

  • 예를 들어서 인터페이스 메서드에 ‘throws Exception’를 선언하면 구현 클래스 메서드에 ‘throws SQLException’는 가능하다. SQLException 은 Exception의 하위 타입이기 때문이다.

특정 기술에 종속되는 인터페이스

구현 기술을 쉽게 변경하기 위해서 인터페이스를 도입하더라도 SQLException과 같은 특정 구현 기술에 종속적인 체크 예외를 사용하게 되면 인터페이스에도 해당 예외를 포함해야 한다.

하지만 이것은 우리가 원하던 순수 인터페이스가 아니다. JDBC 기술에 종속적인 인터페이스일 뿐이다. 인터페이스를 만드는 목적은 구현체를 쉽게 변경하기 위함인데 이미 인터페이스가 특정 구현 기술에 오염이 되어버렸다. 향후 JDBC가 아닌 다른 기술로 변경한다면 인터페이스 자체를 변경해야 한다.

“런타임 예외와 인터페이스”

런타임 예외는 이런 부분에서 자유롭다. 인터페이스에 런타임 예외를 따로 선언하지 않아도 된다.

따라서 인터페이스가 특정 기술에 종속적일 필요가 없다.

런타임 예외 적용

실제 코드에 런타임 예외를 사용하도록 적용해보자.

• 인터페이스

package hello.jdbc.repository;
import hello.jdbc.domain.Member;
import java.sql.SQLException;

public interface MemberRepository {
	Member save(Member member);
	Member findById(String memberId);
	void update(String memberId, int money);
	void delete(String memberId);
}

public class MyDbException extends RuntimeException {
	public MyDbException () {
	}
	
	public MyDbException(Sting message) {
		super(message);
	}
	
	public MyDbExcpetion (String message, Throwable cause) {
		super(message, cause);
	}
	
	public MyDbException(Throwable cause) {
		super(cause);
	}	
}

/**
 * 예외 누수 문제 해결
 * 체크 예외를 런타임 예외로 변경
 * MemberRepository 인터페이스 사용
 * throws SQLException 제거
 */
@Slf4j   // 여기 implements 사용
public class MemberRepositoryV4_1 implements MemberRepository {

    private final DataSource dataSource;

    public MemberRepositoryV4_1(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    @Override // 컴파일러 안맞는 오류를 내준다
    public Member save(Member member) {  // 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) {
            throw new MyDbException(e); // 이부분 추가
        } finally {
            close(con, pstmt, null);
        }

    }
    
    
    @Override
    public Member findById(String memberId) {// 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) {
            throw new MyDbException(e); // 이부분 추가
        } finally {
            close(con, pstmt, rs);
        }

    }

    @Override
    public void update(String memberId, int money) {// 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) {
            throw new MyDbException(e); // 이부분 추가
        } finally {
            close(con, pstmt, null);
        }

    }

    @Override
    public void delete(String memberId) {// 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) {
            throw new MyDbException(e); // 이부분 추가
        } finally {
            close(con, pstmt, null);
        }

    }

    private void close(Connection con, Statement stmt, ResultSet rs) {
        JdbcUtils.closeResultSet(rs);
        JdbcUtils.closeStatement(stmt);
        //주의! 트랜잭션 동기화를 사용하려면 DataSourceUtils를 사용해야 한다.
        DataSourceUtils.releaseConnection(con, dataSource);
    }

    private Connection getConnection() throws SQLException {
        //주의! 트랜잭션 동기화를 사용하려면 DataSourceUtils를 사용해야 한다.
        Connection con = DataSourceUtils.getConnection(dataSource);
        log.info("get connection={}, class={}", con, con.getClass());
        return con;
    }

• throws SQLException을 지우고 런타임 예외인 MyDbException을 추가해준다
• 인터페이스도 깔끔하게 정리된다.

예외변환

catch(SQLException e) {
	throw new MyDbException(e);
}

• 잘 보면 기존 예외를 생성자를 통해서 포함하고 있음을 알 수 있다. 예외는 원인이 되는 예외를 내부에 포함할 수 있는데, 꼭 이렇게 작성해야 한다. 그래야 예외를 출력했을때 원인이 되는 기존 예외도 함께 확인할 수 있다.
• MyDbException이 내부에 SQLException을 포함하고 있다고 이해하면 된다.
• 예외를 출력했을때 스택 트레이스를 통해 둘다 확인할 수 있다.

다음과 같이 작성하면 안된다.

catch(SQLException e) {
	throw new MyDbException();
}

• MyDbException은 내부에 원인이 되는 다른 예외를 포함하지 않는다.
• 이렇게 원인이 되는 예외를 내부에 포함하지 않으면 예외를 스택트레이스를 통해 출력했을때 기존에 원인이 되는 부분을 확인할 수 없다.
  • `만약 SQLExcetpion에서 문법 오류가 발생했다면 그 부분을 확인할 방법이 없게 된다.

주의~~~

예외를 변환할때는 기존 예외를 꼭 포함하자. 장애가 발생하고 로그에서 진짜 원인이 남지 않는 심각한 문제가 발생할 수 있다.

package hello.jdbc.repository;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepository; 
import lombok.extern.slf4j.Slf4j;
import org.springframework.jdbc.support.JdbcUtils;
// import도 순수한 자바코드만 남아있게 된다.

/**
 * 예외 누수 문제 해결
 * SQLException 제거
 * 
 * MemberRepository 인터페이스 의존
 */
@Slf4j
@RequiredArgsConstructor
public class MemberRepositoryV4 {

    private final MemberRepository memberRepository;
    
    @Transactional
    public void accountTransfer(String fromId, String toId, int money) {
	    bizLogic(fromId, toId, money);
	  }
	  
	  private void bizLogic(String fromId, String toId, int money) {
		  Member fromMember = memberRepository.findById(fromId);
		  Member toMember = memberRepository.findById(toId);
		  
		  memberRepository.update(fromId, fromMember.getMoney() - money) {
			  Member fromMember = memberRepository.findById(fromId);
			  Member toMember = memberRepository.findById(toId);
			  
			  memberRepository.update(fromId, fromMember.getMoney() - money);
			  validation(toMember);
			  memberRepository.update(toId, toMember.getMoney() + money);
		}
		
		private void validatioin(Member toMember) {
			if(toMember.getMemberId().equals("ex")) {
				throw new IllegalStateException("이체중 예외발생");
			}
		}
	}

• MemberRepository 인터페이스에 의존하도록 코드를 변경했다.
• MemberServiceV3_3 와 비교해서 보면 드디어 메서드에서 throws SQLException 부분이 제거된 것을 확인할 수 있다.
• 드디어 순수 서비스 완성

package hello.jdbc.service;

import hello.jdbc.domain.Member;
import hello.jdbc.repository.MemberRepositoryV3;
import lombok.extern.slf4j.Slf4j;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.aop.support.AopUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.jdbc.datasource.DrvierManagerDataSource;
import org.springframework.jdbc.datasource.PlatformTransactionManager;

import javax.sql.DataSource;
import java.sql.SQLException;

import static hello.jdbc.connection.ConnetionConst.*;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

/**
* 예외 누수 문제 해결
* SQLEException 제거
* MemberRepository 인터페이스 의존
*/

@Slf4j
@SpringBootTest 
class MemberServiceV4Test {
	public static final String MEMBER_A = "memberA";
	public static final String MEMBER_B = "memberB";
	public static final String MEMBER_EX = "ex";
	
  @Autowired 
  MemberRepositoryV3 memberRepository;
  @Autowired
  MemberServiceV3_3 memberService;
  
  @AfterEach
  void after() throws SQLException {
        memberRepository.delete(MEMBER_A);
        memberRepository.delete(MEMBER_B);
        memberRepository.delete(MEMBER_EX);
    }
 @TestConfiguration
  static class TestConfig {
    private final DataSource dataSource;
    public TestConfig(DataSource dataSource) {
	    this.dataSource = dataSource;
	  }
	  
	  @Bean
	  MemberRepository memberRepository() {
		 return new MemberRepositoryV4_1(dataSource); // 단순 예외 반환
		 }
		 
		 @Bean
		 MemberServiceV4 memberServiceV4() {
			 return new MemberServiceV4(memberRepository());
			}
	}
		 
		 @Test
		 void AopCheck() {
      log.info("memberService class={}", memberService.getClass());
      log.info("memberRepository class={}", memberRepository.getClass());
			Assertions.assertThat(AopUtils.isAopProxy(memberService)).isTrue();
			Assertions.assertThat(AopUtils.isAopProxy(memberRepository)).isFalse();
  }
    
  @Test
  @DisplayName("정상 이체")
 void accountTransfer() throws SQLException {
		 //given
		 Member memberA = new Member(MEMBER_A, 10000);
		 Member memberB = new Member(MEMBER_B, 10000);
		 memberRepository.save(memberA);
	   memberRepository.save(memberB);
	   
		 //when
	   memberService.accountTransfer(memberA.getMemberId(),memberB.getMemberId(), 2000);
		 
		 //then
		 Member findMemberA = memberRepository.findById(memberA.getMemberId());
		 Member findMemberB = memberRepository.findById(memberB.getMemberId());
		 assertThat(findMemberA.getMoney()).isEqualTo(8000);
		 assertThat(findMemberB.getMoney()).isEqualTo(12000);
  }
  
  @Test
  @DisplayName("이체중 예외 발생")
 void accountTransferEx() throws SQLException {
		 //given
		 Member memberA = new Member(MEMBER_A, 10000);
		 Member memberEx = new Member(MEMBER_EX, 10000);
     memberRepository.save(memberA);
     memberRepository.save(memberEx);
     
		 //when
		 assertThatThrownBy(() -> 
			memberService.accountTransfer(memberA.getMemberId(), memberEx.getMemberId(), 
				2000)).isInstanceOf(IllegalStateException.class);
				
		 //then
		  Member findMemberA = memberRepository.findById(memberA.getMemberId());
		  Member findMemberEx = memberRepository.findById(memberEx.getMemberId());
		  
		 //memberA의 돈이 롤백 되어야함
			 assertThat(findMemberA.getMoney()).isEqualTo(10000);
			 assertThat(findMemberEx.getMoney()).isEqualTo(10000);
    }
 }

• MemberRepository 인터페이스를 사용하도록 했다.
• 테스트가 모두 정상 동작하는 것을 확인할 수 있다.

정리

• 체크 예외를 런타임 예외로 변환하면서 인터페이스와 서비스 계층의 순수성을 유지할 수 있게 되었다.
• 덕분에 향후 JDBC에서 다른 구현 기술로 변경하더라도 서비스 계층의 코드를 변경하지 않고 유지할 수 있다.

남은 문제

리포지토리에서 넘어오는 특정한 예외의 경우 복구를 시도할 수도 있다. 그런데 지금 방식은 항상 MyDbException 이라는 예외만 넘어오기 때문에 예외를 구분할 수 없는 단점이 있다. 만약 특정 상황에서는 예외를 잡아서 복구하고 싶으면 예외를 어떻게 구분해서 처리할 수 있을까?

데이터 접근 예외 직접 만들기

• 특정 예외는 복구처리하고 싶을 수 있다.

• 예) 회원가입시 DB에 이미 같은 ID가 있으면 ID 뒤에 숫자를 붙여 새로운 ID를 만들어야한다고 가정

• 데이터를 DB에 저장할때 같은 ID가 이미 데이터 베이스에 저장되어 있다면 데이터 베이스는 오류코드를 반환하고 이 오류코드를 받은 JDBC 드라이버는 SQLException을 던진다. 그리고 SQLException에는 데이터 베이스가 제공하는 errorCode라는것이 들어있다.

H2 데이터베이스의 키 중복 오류 코드

e.getErrorCode() == 23505

• SQLException 내부에 들어있는 errorCode를 활용하면 데이터 베이스에 어떤 문제가 발생했는지 확인할 수 있다.

H2 데이터 베이스 ex

• 23505 : 키 중복 오류
• 42000 : SQL문법 오류

참고로 같은 오류여도 각각의 데이터 베이스 마다 정의된 오류코드가 다르다. 따라서 오류코드를 사용할때는 데이터 베이스 메뉴얼을 확인해야 한다.

ex) 키 중복 오류 코드

• H2 DB : 23505
• MySQL : 1062

H2 데이터베이스 오류 코드 참고

• https://www.h2database.com/javadoc/org/h2/api/ErrorCode.html

서비스 계층에서는 예외 복구를 위해 키 중복 오류를 확인할 수 있어야 한다. 그래야 새로운 ID를 만들어서 다시 저장을 시도할 수 있기 대문이다. 이러한 과정이 바로 예외를 확인해서 복구하는 과정이다. 리포지토리는 SQLException을 서비스 계층에 던지고 서비스 계층은 이 예외의 오류코드를 확인해서 키 중복 오류(23505)인 경우 새로운 ID를 만들어서 다시 저장하면 된다.

그런데 SQLException에 들어있는 오류코드를 활용하기 위해 SQLException을 서비스 계층으로 던지게 되면 서비스 계층이 SQLException이라는 JDBC 기술에 의존하게 되면서 지금까지 우리가 고민했던 서비스 계층의 순수성이 무너진다.

이 문제를 해결하려면 앞서 배운 것처럼 리포지토리에서 예외를 변환해서 던지면 된다.

SQLException ⇒ MyDuplicateKeyException

먼저 필요한 예외를 만들어보자.

MyDuplicateKeyException

package hello.jdbc.repository.ex;

public class MyDuplicateKeyException extends MyDbException {
	public MyDuplicateKeyException() {
	}
	public MyDuplicateKeyException(String message) {
		super(message);
	}
	public MyDuplicateKeyException(String message, Throwable cause) {
		super(message, cause);
	}
	public MyDuplicateKeyException(Throwable cause) {
		super(cause);
	}
}

• 기존에 사용했던 MyDbException을 상속받아서 의미있는 계층을 형성한다. 이렇게 하면 데이터 베이스 관련 예외라는 계층을 만들 수 있다.
• 그리고 이름도 MyDuplicateKeyException이라는 이름을 지었다. 이 예외는 데이터 중복의 경우에만 던져야 한다.
• 이 예외는 우리가 직접 만든 것이기 때문에 JDBC나 JPA 같은 특정 기술에 종속적이지 않다. 따라서 이 예외를 사용하더라도 서비스 계층의 순수성을 유지할 수 있다(향후 JDBC 에서 다른 기술로 바꾸어도 이 예외는 그대로 유지할 수 있다)

package hello.jdbc.exception.translator;

import hello.jdbc.connection.ConnectionConst;
import hello.jdbc.domain.Member;
import hello.jdbc.repository.ex.MyDbException;
import hello.jdbc.repository.ex.MyDuplicateKeyException;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.jdbc.support.JdbcUtils;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.Random;

import static hello.jdbc.connection.ConnectionConst.*;

@Slf4j
public class ExTranslatorV1Test {

    Repository repository;
    Service service;

    @BeforeEach
    void init() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource(URL, USERNAME, PASSWORD);
        repository = new Repository(dataSource);
        service = new Service(repository);
    }

    @Test
    void duplicateKeySave() {
        service.create("myId");
        service.create("myId");//같은 ID 저장 시도
    }

    @Slf4j
    @RequiredArgsConstructor
    static class Service {
        private final Repository repository;

        public void create(String memberId) {
            try {
                repository.save(new Member(memberId, 0));
                log.info("saveId={}", memberId);
            } catch (MyDuplicateKeyException e) {
                log.info("키 중복, 복구 시도");
                String retryId = generateNewId(memberId);
                log.info("retryId={}", retryId);
                repository.save(new Member(retryId, 0));
            } catch (MyDbException e) {
                log.info("데이터 접근 계층 예외", e);
                throw e;
            }
        }

        private String generateNewId(String memberId) {
            return memberId + new Random().nextInt(10000);
        }

    }

    @RequiredArgsConstructor
    static class Repository {
        private final DataSource dataSource;

        public Member save(Member member) {
            String sql = "insert into member(member_id, money) values(?,?)";
            Connection con = null;
            PreparedStatement pstmt = null;

            try {
                con = dataSource.getConnection();
                pstmt = con.prepareStatement(sql);
                pstmt.setString(1, member.getMemberId());
                pstmt.setInt(2, member.getMoney());
                pstmt.executeUpdate();
                return member;
            } catch (SQLException e) {
                //h2 db
                if (e.getErrorCode() == 23505) {
                    throw new MyDuplicateKeyException(e);
                }
                throw new MyDbException(e);
            } finally {
                JdbcUtils.closeStatement(pstmt);
                JdbcUtils.closeConnection(con);
            }
        }
    }
}

} catch (SQLException e) {
 //h2 db
 if (e.getErrorCode() == 23505) {
	 throw new MyDuplicateKeyException(e);
 }
	 throw new MyDbException(e);
}

• e.getErrorCode() == 23505 : 오류코드가 키 중복 오류(23505)인 경우
• MyDuplicateKeyException 을 새로 만들어서 서비스 계층에 던진다.
• 나머지 경우 기존에 만들었던 MyDbException을 던진다.

try {
    repository.save(new Member(memberId, 0));
    log.info("saveId={}", memberId);
 } catch (MyDuplicateKeyException e) {
    log.info("키 중복, 복구 시도");
 String retryId = generateNewId(memberId);
    log.info("retryId={}", retryId);
    repository.save(new Member(retryId, 0));
 } catch (MyDbException e) {
    log.info("데이터 접근 계층 예외", e);
 throw e;
 }

• 처음에는 저장을 시도한다. 만약 리포지토리에서 MyDuplicateKeyException 예외가 올라오면 이 예외를 잡는다.
• 예외를 잡아서 generatedNewId(memberId) 로 새로운 ID생성을 시도한다. 그리고 다시 저장한다. 여기가 예외를 복구하는 부분이다.
• 만약 복구할 수 없는 예외(MyDbException)면 로그만 남기고 다시 예외를 던진다.
  • 참고로 이 경우 여기서 예외 로그를 남기지 않아도 된다. 어차피 복구할 수 없는 예외는 예외를 공통으로 처리하는 부분까지 전달되기 때문이다. 따라서 이렇게 복구할 수 없는 예외는 공통으로 처리하는 곳에서 예외 로그를 남기는 것이 좋다. 여기서는 다양하게 예외를 잡아서 처리할 수 있는 점을 보여주기 위해 이곳에 코드를 만들어두었다.

정리

• SQL ErrorCode로 데이터베이스에 어떤 오류가 있는지 확인할 수 있었다.
• 예외 변환을 통해 SQLException을 특정 기술에 의존하지 않는 직접 만든 예외인 MyDuplicateKeyException 로 변환 할 수 있었다.
• 리포지토리 계층이 예외를 변환해준 덕분에 서비스 계층은 특정 기술에 의존하지 않는 MyDuplicateKeyException 을 사용해서 문제를 복구하고, 서비스 계층의 순수성도 유지할 수 있었다.

남은문제

• SQL ErrorCode는 각각의 데이터베이스 마다 다르다. 결과적으로 데이터베이스가 변경될 때 마다 ErrorCode도 모두 변경해야 한다
  • 예) 키 중복 오류 코드
    • H2 : 23505
    • MySQL : 1062
• 데이터베이스가 전달하는 오류는 키 중복 뿐만 아니라 락이 걸린 경우, SQL 문법에 오류 있는 경우 등등 수십 수백가지 오류 코드가 있다. 이 모든 상황에 맞는 예외를 지금처럼 다 만들어야 할까? 추가로 앞서 이야기한 것 처럼 데이터베이스마다 이 오류 코드는 모두 다르다.

[YuDeokRin]

수고하셨습니다 !

[seyxxn]

수고하셨습니다 !!