끝) 자바 예외 + 스프링의 문제해결

체크 예외와 인터페이스

 

서비스 계층은 가급적 특정 구현 기술에 의존하지 않고, 순수하게 유지하는 것이 좋다.

 

이렇게 하려면 예외에 대한 의존도 함께 해결해야한다.

 

예를 들어서

서비스가 처리할 수 없는 SQLException 에 대한 의존을 제거하려면 어떻게 해야할까?

( SQLException 에 대한 의존한다는것은 throws SQLException을 의미)

 

서비스가 처리할 수 없으므로

리포지토리가 던지는 SQLException 체크 예외를 런타임 예외로 전환해서 서비스 계층에 던지자.

 

이렇게 하면 서비스 계층이 해당 예외를 무시할 수 있기 때문에,

 

특정 구현 기술에 의존하는 부분을 제거하고 서비스 계층을 순수하게 유지할 수 있다.

 

 

지금부터 코드로 이 방법을 적용해보자.

 

인터페이스 도입

먼저 MemberRepository 인터페이스도 도입해서 구현 기술을 쉽게 변경할 수 있게 해보자.

이렇게 인터페이스를 도입하면 MemberService 는 MemberRepository 인터페이스에만 의존하면 된다.

 

이제 구현 기술을 변경하고 싶으면 DI를 사용해서 MemberService 코드의 변경 없이 구현 기술을 변경할 수 있다.

 

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);
}

특정 기술에 종속되지 않는 순수한 인터페이스이다.

(메소드에 throws SQLException이런게 없다 )

 

이 인터페이스를 기반으로 특정 기술을 사용하는 구현체를 만들면 된다.

(ex ) JDBCMemberRepository, JPAMemberRepository)

 

 

체크 예외와 인터페이스

잠깐? 기존에는 왜 이런 인터페이스를 만들지 않았을까? 사실 다음과 같은 문제가 있기 때문에 만들지 않았다.

 

왜냐하면 SQLException 이 체크 예외이기 때문이다.

 

여기서 체크 예외가 또 발목을 잡는다.

 

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

(throws 선언이 되어있어야한다)

(인터페이스 메소드에 throws선언이 되어있지않으면 해당 메소드를 구현해서는 체크예외를 throws할수 없다.

인터페이스의 메소드를 오버라이드하는것이므로 내부코드말고 구성을 다르게할 수 없다.

그러므로 체크예외가 메소드마다 필요한 리포지토리클래스들은 인터페이스를 따로 만들어서 구현하지않은것이다 ) 

 

예를 들면 다음과 같은 코드가 된다.

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;
    }

이렇게되면 MemberRepository 인터페이스는 SQLException 때문에 특정기술(JDBC기술)에 종속적이게 된다.

 

 

인터페이스의 구현체가 체크 예외를 던지려면,

 

인터페이스 메서드에 먼저 체크 예외를 던지는 부분이 선언 되어 있어야 한다.

 

그래야 구현 클래스의 메서드도 체크 예외를 던질 수 있다

 

쉽게 이야기 해서 MemberRepositoryV3 가 throws SQLException 를 하려면

MemberRepositoryEx 인터페이스에도 throws SQLException 이 필요하다.

 

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

 

예를 들어서 인터페이스 메서드에 throws Exception 를 선언하면,

구현 클래스 메서드에 throws SQLException 는 가능하다. SQLException 은 Exception 의 하위 타입이기 때문이다.

 

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

 

구현 기술을 쉽게 변경하기 위해서 인터페이스를 도입하더라도 SQLException 과 같은 특정 구현 기술에

 

종속적인 체크 예외를 사용하게 되면 인터페이스에도 해당 예외를 포함해야 한다.

 

하지만 이것은 우리가 원하던 순수한 인터페이스가 아니다.

 

JDBC 기술에 종속적인 인터페이스일 뿐이다.  ( 인터페이스는 어떤 기술에도 종속적이면 안된다.)

 

인터페이스를 만드는 목적은 구현체를 쉽게 변경하기 위함인데,

 

이미 인터페이스가 특정 구현 기술에 오염이 되어 버렸다.

 

향후 JDBC가 아닌 다른 기술로 변경한다면 인터페이스 자체를 변경해야 한다.

(throws 부분에서 던지는 예외가 바뀌어야할것이다.)

 

이게 다 체크예외를 사용했을때 스노우볼이다.

 

 

런타임 예외와 인터페이스

런타임 예외( == 언체크 예외)는 이런 부분에서 자유롭다.

 

인터페이스에 런타임 예외를 따로 선언하지 않아도 된다.

 

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

 

 

런타임 예외 적용

 

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

/**
 * 예외 누수 문제 해결  ( 리포지토리에서 발생하는 체크예외가 서비스까지 영향을 주는것을 해결)
 * 체크 예외를 런타임 예외로 전환(변경)
 * MemberRepository 인터페이스 사용
 * throws SQLException 제거
 */
@Slf4j
public class MemberRepositoryV4_1 implements MemberRepository{
    private final DataSource dataSource; // DataSource 주입 받기

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


    @Override // @Override 어노테이션을 붙여놓는게 좋다. 그래야 오버라이드가 안맞을때 컴파일러가 에러를 표시해주기 때문이다.
    public Member save(Member member)  {
        String sql = "insert into member(member_id, money) values (?,?)";

        Connection con = null;
        PreparedStatement pstmt = null;

        try {
            con = getConnection(); // DriverManager를 이용해서 해당 데이터베이스 드라이버에 있는 connection 구현체를 가져온다.
            pstmt = con.prepareStatement(sql); // 받아온 connection을 이용해서 sql를 전달하고, 해당 데이터베이스 드라이버의 PreparedStatement를 받아온다.
            pstmt.setString(1, member.getMemberId()); // sql의 ? ? 부분에 넣을 파라미터를 바인딩해주는 부분
            pstmt.setInt(2, member.getMoney()); // 파라미터 인덱스를 이용해서 하나씩 넣어준다.
            pstmt.executeUpdate(); // Statement 를 통해 준비된 SQL을 커넥션을 통해 실제 데이터베이스에 전달한다.
            return member;

        } catch (SQLException e) {
            throw new MyDbException(e);
        }finally {
            close(con, pstmt, null);
        }

    }
    
    
    // ..findById, update,delete ...도 save와 같은 변경점만 가지므로 생략

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

이 코드에서 핵심은 SQLException 이라는 체크 예외를 MyDbException 이라는 런타임 예외로 변환해서

던지는 부분이다.

 

잘 보면 기존 예외를 생성자를 통해서 포함하고 있는 것을 확인할 수 있다.

 

예외는 원인이 되는 예외를 내부에 포함할 수 있는데, 꼭 이렇게 작성해야 한다.

 

그래야 예외를 출력했을 때 원인이 되는 기존 예외도 함께 확인할 수 있다.

 

MyDbException이 내부에 SQLException 을 포함하고 있다고 이해하면 된다.

 

예외를 출력했을 때 스택 트레이스를 통해 둘다 확인할 수 있다.

 

public interface MemberRepository {

    Member save(Member member);

    Member findById(String memberId);

    void update(String memberId, int money);

    void delete(String memberId);
}

인터페이스인 MemberRepository는  throws가 없는 , 특정기술에 종속적이지않은 인터페이스이다.

 

public class MyDbException extends RuntimeException{ // SQLException(체크예외)를 해당 런타임예외로 전환한다.

    //부모클래스의 생성자들을 가져온다.

    public MyDbException() {
        super();
    }

    public MyDbException(String message) {
        super(message);
    }

    public MyDbException(String message, Throwable cause) { // 전환전의 예외를 담을 생성자가 필요하다.
        super(message, cause);
    }

    public MyDbException(Throwable cause) { // 전환전의 예외를 담을 생성자가 필요하다.
        super(cause);
    }
}

체크예외를 전환할 런타임예외를 만든다. (런타임예외를 상속받는)

전환전 예외인 체크예외를 파라미터로 받는 생성자를 부모클래스에서 오버라이드한다

(스택 트레이스를 위해)

그리고 전환된 예외를 생성할때 발생한 이유인 예외를 담아줘야한다.

그래야 전환된 예외를 로그로 찍을때, 해당 예외가 발생한 진짜 예외정보가 로그로 보이게된다.

 

 

주의!

예외를 변환할 때는 기존 예외를 꼭! 포함하자.

 

장애가 발생하고 로그에서 진짜 원인이 남지 않는 심각한 문제가 발생할 수 있다.

 

 

이번에는 서비스가 인터페이스를 사용하도록 하자

+ 멤버리포지토리 인터페이스 의존하도록 수정한다.

+ 예외 누수로 인한 특정기술 의존이 삭제된다.

 

MemberServiceV4

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

    private final MemberRepository memberRepository; // 구현체가아닌 인터페이스에 의존한다

    public MemberServiceV4(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }


    @Transactional
    public void accountTransfer(String fromId, String toId, int money)  {
        bizLogic(fromId, toId, money);
    }

    // 이제 memberRepository에서 체크예외가 올라오지않으므로 throws SQLException부분을 삭제해도된다.
    // 즉 서비스는 데이터접근계층의 기술을 의존하지않아도 된다. 이제 비즈니스로직에 집중한 순수한 서비스가 되었다.
    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); // from의 돈을 깎고
        validation(toMember); // 첫 번째 작업 진행후 예외 발생시 트랜잭션을 위한 예외 발생 메소드
        memberRepository.update(toId, toMember.getMoney() + money); // to의 돈을 증가시켜준다.
    }

    private static void validation(Member toMember) {
        if (toMember.getMemberId().equals("ex")) {
            throw new IllegalStateException("이체중 예외 발생");
        }
    }

}

드디어 순수한 서비스를 완성했다.

 

MemberServiceV4Test

기존의 테스트와 달라진점은 다음부분이다.

@Autowired
    private MemberRepository memberRepository;
    @Autowired
    private MemberServiceV4 memberService;

//    @Autowired
//    private DataSource dataSource; 이렇게 필드주입으로 주입받아도 되지만

    @TestConfiguration
    static class TestConfig { //스프링은 @Configuration이 붙어있는 클래스도 스프링빈을 등록한다는것을 이용해서
        private DataSource dataSource;

        public TestConfig(DataSource dataSource) { //생성자를 통해 dataSource를 주입받는다. ( 나는 필드주입이 더 깔끔해보인다.)
            this.dataSource = dataSource;
        }
        @Bean
        MemberRepository memberRepository() {
            return new MemberRepositoryV4_1(dataSource);
        }

        @Bean
        MemberServiceV4 memberServiceV4() {
            return new MemberServiceV4(memberRepository());
        }


    }

MemberRepository 인터페이스가 있기에  

주입받는부분, 수동빈부분에서 인터페이스를 적용해준다.

 

결과 : 잘동작함

 

정리

체크 예외를 런타임 예외로 변환하면서 인터페이스와 서비스 계층의 순수성을 유지할 수 있게 되었다.

 

덕분에 향후 JDBC에서 다른 구현 기술로 변경하더라도 서비스 계층의 코드를 변경하지 않고 유지할 수 있다.

 

 

남은 문제

리포지토리에서 넘어오는 특정한 예외의 경우 복구를 시도할 수도 있다.

(예를 들면 이미 존재하는 닉네임이라서 SQLException이 발생해서 서비스로 올라왔는데

비즈니스 로직상 이미 존재하는 닉네임이라면 닉네임 + 1을 붙여서 생성하게끔 하고 싶을수도있다) 

 

그런데 지금 방식은 항상 MyDbException 이라는 예외만 넘어오기 때문에 예외를 구분할 수 없는 단점이 있다.

 

만약 특정 상황에는 예외를 잡아서 복구하고 싶으면 예외를 어떻게 구분해서 처리할 수 있을까?

 

(체크예외가 만들어놓은 MyDbException으로 전환되어 전달되기때문에 

어떤 체크예외가 변환된것인지 구분할수없다.)

 

 

---

스프링과 문제 해결 

 

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

 

데이터베이스 오류에 따라서 특정 예외는 복구하고 싶을 수 있다.

 

예를 들어서

 

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

 

ID를 hello 라고 가입 시도 했는데,

이미 같은 아이디가 있으면 hello12345 와 같이 뒤에 임의의 숫자를 붙여서 가입하는 것이다.

 

데이터를 DB에 저장할 때 같은 ID가 이미 데이터베이스에 저장되어 있다면,

데이터베이스는 오류 코드를 반환하고, 이 오류 코드를 받은 JDBC 드라이버는 SQLException 을 던진다.

그리고 SQLException 에는 데이터베이스가 제공하는 errorCode 라는 것이 들어있다.

 

(이미 들어있는 ID에 대해 또 저장하려고하면 Unique 제약조건(unique constraint)때문에 데이터베이스는 오류코드를 반환한다. 그 오류코드를 받은 JDBC 드라이버는 해당 에러코드에 맞는 예외를 던진다.)

(그리고 그 예외안에는 데이터베이스가 제공한 에러코드가 들어있다.)

데이터베이스 오류 코드 그림

 

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

exception.getErrorCode() ==> 23505

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

 

H2 데이터베이스 에러코드 예시 ( 에러코드는 데이터베이스마다 다를 수 있다.)

23505 : 키 중복 오류

42000 : SQL 문법 오류

 

참고로 같은 오류여도 각각의 데이터베이스마다 정의된 오류 코드가 다르다.

따라서 오류 코드를 사용할 때는 데이터베이스 메 뉴얼을 확인해야 한다.

 

예) 키 중복 오류 코드 

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 (언체크 예외)

(키 중복 오류에 대한 새로운 예외(런타임예외)를 만들어서 서비스로 던져준다. 서비스는 그 예외를 보고, 키중복 오류가 발생했음을 알고, 예외를 복구 시도할 수 있다. + 새로운 예외는 개발자가 직접만든 예외이고 스프링을 의존하므로 JDBC같은 다른 기술을 의존하는것이 아니다.)

 

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

 

MyDuplicateKeyException

public class MyDuplicateKeyException extends MyDbException{
    // RuntimeException을 상속받아도 되지만, MyDbException를 상속하므로 DB에서 발생한 예외라는 카테고리성이 느껴진다.
    // MyDbException는 RuntimeException을 상속하므로 MyDbException을 상속하면 자동으로 RuntimeException을 상속하게 된다.

    public MyDuplicateKeyException() {
        super();
    }

    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에서 다른 기술로 바꾸어도 이 예외는 그대로 유지할 수 있다.)

 

 

실제 예제 코드를 만들어서 확인해보자.

 

ExTranslatorV1Test

@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 저장 시도

    }



    @RequiredArgsConstructor
    static class Service {

        private final Repository repository;

        void create(String memberId) {
            // 이미 존재하는 회원아이디로 저장하려고하면 MyDuplicateKeyException가 발생할것이다.
            try {
                repository.save(new Member(memberId, 0));
                log.info("saveId = {}", memberId);

            } catch (MyDuplicateKeyException e) { //catch로 잡아서 해당 예외에 대한 처리를 함으로 예외 복구를 할 수 있다.
                log.info("키 중복, 복구 시도");
                String retryId = generateNewId(memberId);
                log.info("retryId = {}", retryId);
                repository.save(new Member(retryId, 0)); // 그다음 새로 만든 멤버아이디를 넣어서 재시도
                // 결국 멤버아이디 중복으로 예외가 발생되었지만 예외를 처리했다 (예외복구)
            } catch (MyDbException e) { //만약 예외복구(처리)가 불가능한 예외라면 그냥 밖으로 던져지게끔 둔다.
                //물론 이 catch가없어도 알아서 던져지겠지만 , 여러개 예외를 catch할수있음을 알리기위해 적었다.
                log.info("데이터 접근 계층 예외", 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) {
                //SQLException인 경우 내부 에러코드를 확인해서 어떤 오류인지 확인하고, 키 중복인 경우 만들어놓은 언체크예외로 전환해서 밖으로 던진다.
                // 그럼 서비스에서 해당 예외가 나왔을시 예외를 밖으로 던지지않고, 해당 에외에 대한 처리를 진행할 수 있게된다.
                if (e.getErrorCode() == 23505) {
                    throw new MyDuplicateKeyException(e); // 예외 전환시 항상 원인이 되는 예외를 담아줘야한다.
                }
                //나머지 경우는 그냥 던진다.
                throw new MyDbException(e);

            } finally {
                JdbcUtils.closeStatement(pstmt); // JdbcUtils를 이용해서 닫으면 예외처리를 따로 안해줘도된다.
                JdbcUtils.closeConnection(
                    con);  // con.close()이런식으로 객체를 직접 닫으면 SQLException을 잡던지 밖으로 던지는 처리를해야하므로 코드가 지저분해짐.
            }

        }

    }

}

결과를 보면, 멤버아이디 의 중복이 발생하고 아이디 중복예외라면 새로 아이디를 만들어서 재시도함으로서 예외복구 성공

같은 ID를 저장했지만, 중간에 예외를 잡아서 복구한 것을 확인할 수 있다.

 

 

리포지토리에서 예외 발생시

에러코드를 확인해서 아이디중복에 대한 에러코드라면 아이디중복예외(언체크예외)로 전환해서 밖으로 던진다.

catch (SQLException e) {
    //SQLException인 경우 내부 에러코드를 확인해서 어떤 오류인지 확인하고, 키 중복인 경우 만들어놓은 언체크예외로 전환해서 밖으로 던진다.
    // 그럼 서비스에서 해당 예외가 나왔을시 예외를 밖으로 던지지않고, 해당 에외에 대한 처리를 진행할 수 있게된다.
    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) { //catch로 잡아서 해당 예외에 대한 처리를 함으로 예외 복구를 할 수 있다.
    log.info("키 중복, 복구 시도");
    String retryId = generateNewId(memberId);
    log.info("retryId = {}", retryId);
    repository.save(new Member(retryId, 0)); // 그다음 새로 만든 멤버아이디를 넣어서 재시도
    // 결국 멤버아이디 중복으로 예외가 발생되었지만 예외를 처리했다 (예외복구)
} catch (MyDbException e) { //만약 예외복구(처리)가 불가능한 예외라면 그냥 밖으로 던져지게끔 둔다.
    //물론 이 catch가없어도 알아서 던져지겠지만 , 여러개 예외를 catch할수있음을 알리기위해 적었다.
    log.info("데이터 접근 계층 예외", e);
}

처음에 저장을 시도한다.

 

만약 리포지토리에서 MyDuplicateKeyException 예외가 올라오면 이 예외를 잡는다.

 

예외를 잡아서 generateNewId(memberId) 로 새로운 ID 생성을 시도한다.

그리고 다시 저장한다. 여기가 예외를 복구하는 부분이다.

 

 

만약 복구할 수 없는 예외( MyDbException )면 로그만 남기고 다시 예외를 던진다.

(참고로 이 경우 여기서 예외 로그를 남기지 않아도 된다.)

 

어차피 복구할 수 없는 예외는 예외를 공통으로 처리하는 부분까지 전달되기 때문이다.

(controllerAdvice같은곳에서 공통처리할때 로그를 남기는 부분이 대부분있으므로 )

 

따라서 이렇게 복구 할 수 없는 예외는 공통으로 예외를 처리하는 곳에서 예외 로그를 남기는 것이 좋다.

 

여기서는 다양하게 예외를 잡아서 처리할 수 있는 점을 보여주기 위해 이곳에 코드를 만들어두었다.

 

 

정리

SQL ErrorCode로 데이터베이스에 어떤 오류가 있는지 확인할 수 있었다.

 

예외 변환을 통해 SQLException을 특정 기술에 의존하지 않는

직접 만든 예외인 MyDuplicateKeyException 로 변환 할 수 있었다.

 

리포지토리 계층이 예외를 변환해준 덕분에

서비스 계층은 특정 기술에 의존하지 않는 MyDuplicateKeyException 을 사용해서 문제를 복구하고,

서비스 계층의 순수성도 유지할 수 있었다.

 

 

남은 문제

SQL ErrorCode는 각각의 데이터베이스 마다 다르다.

 

결과적으로 데이터베이스가 변경될 때 마다 ErrorCode도 모두 변경해야 한다.

 

예)

키 중복 오류 코드

H2: 23505

MySQL: 1062

 

데이터베이스가 전달하는 오류는 키 중복 뿐만 아니라

락이 걸린 경우, SQL 문법에 오류 있는 경우 등등 수십,수백가지 오류 코드가 있다.

 

이 모든 상황에 맞는 예외를 지금처럼 다 만들어야 할까?

추가로 앞서 이야기한 것 처럼 데이터베이스마다 이 오류 코드는 모두 다르다.

 

 

---

스프링 예외 추상화 이해

스프링은 앞서 설명한 문제들을 해결하기 위해 데이터 접근과 관련된 예외를 추상화해서 제공한다.

 

스프링 데이터 접근 예외 계층

위에서 MyDbException, MyDbException을 상속받은 DupliacateException과 같이 직접 예외를 만들어서 

데이터접근계층에 관련된 예외들을 만들었었다.

 

하지만 스프링은 그런 예외들을 이미 만들어 놨다.

스프링은 데이터 접근 계층에 대한 수십 가지 예외를 정리해서 일관된 예외 계층을 제공한다.

 

각각의 예외는 특정 기술에 종속적이지 않게 설계되어 있다.

 

따라서 서비스 계층에서도 스프링이 제공하는 예외를 사용하면 된다.

 

예를 들어서 JDBC 기술을 사용하든, JPA 기술을 사용하든 스프링이 제공하는 예외를 사용하면 된다.

 

JDBC나 JPA를 사용할 때 발생하는 예외를 스프링이 제공하는 예외로 변환해주는 역할도 스프링이 제공한다.

 

(참고로 그림을 단순화 하기 위해 일부 계층을 생략했다.)

 

 

예외의 최고 상위는 org.springframework.dao.DataAccessException 이다.

 

그림에서 보는 것 처럼 런타임 예외를 상속 받았기 때문에

스프링이 제공하는 데이터 접근 계층의 모든 예외는 런타임 예외이다.

 

DataAccessException 은 크게 2가지로 구분하는데 NonTransient 예외와 Transient 예외이다.

 

Transient 는 일시적이라는 뜻이다.

 

Transient 하위 예외는 동일한 SQL을 다시 시도했을 때 성공할 가능성이 있다.

 

예를 들어서

쿼리 타임아웃, 락과 관련된 오류들이다.

이런 오류들은 데이터베이스 상태가 좋아지거나, 락이 풀렸을 때 다시 시도하면 성공할 수 도 있다.

 

(즉 다시 시도하면 해당 예외를 복구할만하다는 뜻이다.)

 

NonTransient 는 일시적이지 않다는 뜻이다.

 

같은 SQL을 그대로 반복해서 실행하면 실패한다. SQL 문법 오류, 데이터베이스 제약조건 위배 등이 있다.

 

 

 참고: 스프링 메뉴얼에 모든 예외가 정리되어 있지는 않기 때문에 코드를 직접 열어서 확인해보는 것이 필요하다.

 

 

스프링이 제공하는 예외 변환기

 

스프링은 데이터베이스에서 발생하는 오류 코드를 스프링이 정의한 예외로 자동으로 변환해주는 변환기를 제공한다.

 

코드를 통해 스프링이 제공하는 예외 변환기를 알아보자.

 

먼저 에러 코드를 확인하는 부분을 간단히 복습해보자.

@Test
void sqlExceptionErrorCode() {
    String sql = "select bad Grammer"; //일부러 잘못된 sql를 작성해서 던져본다.
    try {
        // 트랜잭션을 할건아니니까. DataSourceUtils.getConnection(dataSource)말고 간단하게 커넥션을 가져온다.
        Connection con = dataSource.getConnection();
        PreparedStatement pstmt = con.prepareStatement(sql);
        pstmt.executeQuery();
    } catch (SQLException e) {
        assertThat(e.getErrorCode()).isEqualTo(42122);
        int errorCode = e.getErrorCode();
        log.info("errorCode = {} ", errorCode);
        log.info("error", e);
    }

}

 

이전에 살펴봤던 SQL ErrorCode를 직접 확인하는 방법이다. (exception.getErrorcode()를 이용해서)

 

이렇게 직접 예외를 확인하고 하나하나 스프링이 만들어준 예외로 변환하는 것은 현실성이 없다.

 

이렇게 하려면 해당 오류 코드를 확인하고 스프링의 예외 체계에 맞추어 예외를 직접 변환해야 할 것이다

 

그리고 데이터베이스마다 오류 코드가 다르다는 점도 해결해야 한다.

 

그래서 스프링은 예외 변환기를 제공한다.

 

exceptionTranslator 추가

@Test
void exceptionTranslator() {
    String sql = "select bad grammer";

    try {
        Connection con = dataSource.getConnection();
        PreparedStatement pstmt = con.prepareStatement(sql);
        pstmt.executeQuery();

    } catch (SQLException e) {
        assertThat(e.getErrorCode()).isEqualTo(42122);

        SQLErrorCodeSQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
        //Excpetion Translator는 DataSource를 전달해서 생성한다.

        DataAccessException resultEx = exTranslator.translate("select", sql,
            e);//설명을넣고,어떤SQL문인지 넣어주고 예외를 넣어주면 스프링이 제공하는 예외로 변환해준다. (DataAccessException의 자식중 하나를 반환)

        log.info("resultEx", resultEx);
        assertThat(resultEx.getClass()).isEqualTo(BadSqlGrammarException.class); //문법오류면 BadSqlGrammarException이여야한다.

    }
}

스프링이 제공하는 예외로 잘 변환된것을 확인할 수 있다.

SQLErrorCodeSQLExceptionTranslator exTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);

DataAccessException resultEx = exTranslator.translate("select", sql,e);

translate() 메서드의

첫번째 파라미터는 읽을 수 있는 설명이고, 두번째는 실행한 sql, 마지막은 발생된 SQLException 을 전달하면 된다.

 

이렇게 하면 적절한 스프링 데이터 접근 계층의 예외로 변환해서 반환해준다.

 

예제에서는 SQL 문법이 잘못되었으므로 BadSqlGrammarException 을 반환하는 것을 확인할 수 있다

 

눈에 보이는 반환 타입은 최상위 타입인 DataAccessException 이지만

 

실제로는 BadSqlGrammarException 예외가 반환된다.

 

마지막에 assertThat() 부분을 확인하자.

 

참고로 BadSqlGrammarException 은 최상위 타입인 DataAccessException 를 상속 받아서 만들어진다

 

각각의 DB마다 SQL ErrorCode는 다르다.

 

그런데 스프링은 어떻게 각각의 DB가 제공하는 SQL ErrorCode까지 고려해서 예외를 변환할 수 있을까?

 

비밀은 바로 다음 파일에 있다

 

sql-error-codes.xml

내부를 보면 각 데이터베이스마다 어떤 에러코드일때 어떤 예외로 변환할지 다 정해져있다.

 

org.springframework.jdbc.support.sql-error-codes.xml

 

스프링 SQL 예외 변환기는 SQL ErrorCode를 이 파일에 대입해서

어떤 스프링 데이터 접근 예외로 전환해야 할지 찾아낸다.

 

예를 들어서

H2 데이터베이스에서 42000 이 발생하면

badSqlGrammarCodes 이기 때문에 BadSqlGrammarException 을 반환한다.

 

해당 파일을 확인해보면 10개 이상의 우리가 사용하는 대부분의 관계형 데이터베이스를 지원하는 것을 확인할 수 있다.

 

그래서 위의 exceptionTranslator를 추가한 테스트를 실행했을때 로그로 

sql-error-codes.xml에 있는 bean들을 등록하는 로그와 

에러코드를 이용해서 어떤 예외로 바꿀지 진행되는 로그를 확인할 수 있다.

 

 

정리

스프링은 데이터 접근 계층에 대한 일관된 예외 추상화를 제공한다.

 

스프링은 예외 변환기를 통해서 SQLException 의 ErrorCode 에 맞는 적절한 스프링 데이터 접근 예외로 변환해준다.

 

만약 서비스, 컨트롤러 계층에서 예외 처리가 필요하면

특정 기술에 종속적인 SQLException 같은 예외를 직접 사용하는 것이 아니라,

스프링이 제공하는 데이터 접근 예외를 사용하면 된다.

 

스프링 예외 추상화 덕분에 특정 기술에 종속적이지 않게 되었다.

 

이제 JDBC에서 JPA같은 기술로 변경되어도 예외로 인한 변경을 최소화 할 수 있다.

 

향후 JDBC에서 JPA로 구현 기술을 변경하더라도,

스프링은 JPA 예외를 적절한 스프링 데이터 접근 예외로 변환해준다.

 

물론 스프링이 제공하는 예외를 사용하기 때문에 스프링에 대한 기술 종속성은 발생한다

스프링에 대한 기술 종속성까지 완전히 제거하려면 예외를 모두 직접 정의하고 예외 변환도 직접 하면 되지만,

실용적인 방법은 아니다.

 

---

스프링 예외 추상화 적용

이제 우리가 만든 애플리케이션에 스프링이 제공하는 데이터 접근 예외 추상화와 SQL 예외 변환기를 적용해보자.

/**
 * SQLExceptionTranslator 추가
 */
@Slf4j
public class MemberRepositoryV4_2 implements MemberRepository{
    private final DataSource dataSource; // DataSource 주입 받기
    private final SQLExceptionTranslator exceptionTranslator;

    public MemberRepositoryV4_2(DataSource dataSource) {
        this.dataSource = dataSource;
        this.exceptionTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
    }


    @Override // @Override 어노테이션을 붙여놓는게 좋다. 그래야 오버라이드가 안맞을때 컴파일러가 에러를 표시해주기 때문이다.
    public Member save(Member member)  {
        String sql = "insert into member(member_id, money) values (?,?)";

        Connection con = null;
        PreparedStatement pstmt = null;

        try {
            con = getConnection(); // DriverManager를 이용해서 해당 데이터베이스 드라이버에 있는 connection 구현체를 가져온다.
            pstmt = con.prepareStatement(sql); // 받아온 connection을 이용해서 sql를 전달하고, 해당 데이터베이스 드라이버의 PreparedStatement를 받아온다.
            pstmt.setString(1, member.getMemberId()); // sql의 ? ? 부분에 넣을 파라미터를 바인딩해주는 부분
            pstmt.setInt(2, member.getMoney()); // 파라미터 인덱스를 이용해서 하나씩 넣어준다.
            pstmt.executeUpdate(); // Statement 를 통해 준비된 SQL을 커넥션을 통해 실제 데이터베이스에 전달한다.
            return member;

        } catch (SQLException e) {
            throw exceptionTranslator.translate("save", sql, e); //스프링의 예외 변환기를 통해 스프링의 예외로 알아서 변환시켜 던져진다.
            //파라미터로 넘어오는 예외의 에러코드를 보고, 스프링에 저장된 xml의 내용을 이용해서 스프링이 만들어놓은 에외로 변환해서 반환한다.
        }finally {
            close(con, pstmt, null);
        }

    }
    // findById,delete...등 생략

기존 코드에서 스프링 예외 변환기를 사용하도록 변경되었다.

catch (SQLException e) {
    throw exceptionTranslator.translate("save", sql, e); //스프링의 예외 변환기를 통해 스프링의 예외로 알아서 변환시켜 던져진다.
    //파라미터로 넘어오는 예외의 에러코드를 보고, 스프링에 저장된 xml의 내용을 이용해서 스프링이 만들어놓은 에외로 변환해서 반환한다.
}

MemberServiceV4Test 

기존에있는 테스트코드에서 단 한가지만 수정하면된다.

예외의 에러코드를 확인해서 직접만든 에외를 던지는 리포지토리에서

스프링이 제공하는 예외변환기를 이용하여 스프링의 예외를 던지는 리포지토리로 수정하면된다. 

 

(MemberRepository 인터페이스가 제공되므로 스프링 빈에 등록할 빈만 MemberRepositoryV4_1 에서 MemberRepositoryV4_2 로 교체하면 리포지토리를 변경해서 테스트를 확인할 수 있다.)

        @Bean
        MemberRepository memberRepository() {
//            return new MemberRepositoryV4_1(dataSource); 직접만든 예외를 변환하던 리포지토리
            return new MemberRepositoryV4_2(dataSource); // 스프링 예외변환기를 이용하여 스프링이 만들어놓은 예외를 반환하는 리포지토리
        }

save메소드의 sql를 일부로 틀리게해봤다.

리포지토리에서 예외가 발생시 스프링 예외변환기가 스프링예외(BadSqlGrammarException)으로 변환해서 던져준것을 확인 할 수 있다 ( 여기서는 리포지토리에서 던져진 언체크예외를 잡는 곳이 없다. )

 

정리

드디어 예외에 대한 부분을 깔끔하게 정리했다.

 

스프링이 예외를 추상화해준 덕분에, 서비스 계층은 특정 리포지토리의 구현 기술과 예외에 종속적이지 않게 되었다

 

따라서 서비스 계층은 특정 구현 기술이 변경되어도 그대로 유지할 수 있게 되었다.

 

다시 DI를 제대로 활용할 수 있게 된 것이다.

 

추가로 서비스 계층에서 예외를 잡아서 복구해야 하는 경우,

 

예외가 스프링이 제공하는 데이터 접근 예외로 변경되어서 서비스 계층에 넘어오기 때문에

 

필요한 경우 예외를 잡아서 복구하면 된다.

(스프링 기술에 대한 의존은 하겠지만,  다른 특정기술에 대한 의존은 아니므로 괜찮다.)

(스프링이 만들어놓은 데이터접근 관련 예외는 DataAccessException을 상속받으므로 해당 클래스의 자식클래스들을 살펴보면서 잡고싶은 예외를 찾아 catch()하면된다.)

 

 

---

JDBC 반복 문제 해결 - JdbcTemplate

 

지금까지 서비스 계층의 순수함을 유지하기 위해 수 많은 노력을 했고,

 

덕분에 서비스 계층의 순수함을 유지하게 되었다.

 

이번에는 리포지토리에서 JDBC를 사용하기 때문에 발생하는 반복 문제를 해결해보자.

 

 

JDBC 반복 문제

리포지토리의 메소드를 보면 상당히 많은 부분이 반복된다.

• 커넥션 조회, 커넥션 동기화
• PreparedStatement 생성 및 파라미터 바인딩
• 쿼리 실행
• 결과 바인딩
• 예외 발생시 스프링 예외 변환기 실행
• 리소스 종료

 

리포지토리의 각각의 메서드를 살펴보면 상당히 많은 부분이 반복된다.

try {
    con = getConnection();
    pstmt = con.prepareStatement(sql);
    pstmt.setInt(       1,money);
    pstmt.setString(2,memberId);
    int resultSize = pstmt.executeUpdate(); // executeUpdate는 반환값으로 영향받은 DB row 수를 반환한다.
    log.info("resultSize = {}", resultSize);

} catch (SQLException e) {
    throw exceptionTranslator.translate("update", sql, e);
}finally {
    close(con, pstmt, null);
}

(커넥션 받고, statment만들고 파라미터 넣고,쿼리실행하고,쿼리 결과가 있다면 받고, 예외발생하면 스프링 예외변환기 실행해야하고, 리소스들 반환해야하고)

 

이런 반복을 효과적으로 처리하는 방법이 바로 템플릿 콜백 패턴이다.

 

스프링은 JDBC의 반복 문제를 해결하기 위해 JdbcTemplate 이라는 템플릿을 제공한다.

 

JdbcTemplate 에 대한 자세한 사용법은 뒤에서 설명하겠다.

 

지금은 전체 구조와, 이 기능을 사용해서 반복 코드를 제거할 수 있다는 것에 초점을 맞추자.

 

 

MemberRepositoryV5

/**
 * JdbcTemplate사용
 */
@Slf4j
public class MemberRepositoryV5 implements MemberRepository{

    private final JdbcTemplate jdbcTemplate;

    public MemberRepositoryV5(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource); // JdbcTemplate 만들때 데이터소스를 넣어준다.
    }


    @Override // @Override 어노테이션을 붙여놓는게 좋다. 그래야 오버라이드가 안맞을때 컴파일러가 에러를 표시해주기 때문이다.
    public Member save(Member member)  {
        String sql = "insert into member(member_id, money) values (?,?)";
        jdbcTemplate.update(sql, member.getMemberId(), member.getMoney()); // 반환값은 업데이트된 로우 숫자
        //JdbcTemplate 생성하고 메소드를 이용하면 커넥션을 받고,statement 받고 파라미터 설정, 결과값 받아서 매핑 ,스프링 예외변환기 실행, 리소스들 반환까지 다해준다.
        // ++ 동기화된 커넥션을 받아오는것도 알아서 해준다.
        return member;

    }

    @Override // @Override 어노테이션을 붙여놓는게 좋다. 그래야 오버라이드가 안맞을때 컴파일러가 에러를 표시해주기 때문이다.
    public Member findById(String memberId)  {
        String sql = "select * from member where member_id = ?";
        return jdbcTemplate.queryForObject(sql,memberRowMapper(),memberId); // 하나 조회하는것은 queryForObject를 사용하면된다.
        // 파라미터로는 sql, 쿼리의 결과를 어떻게 만들지 매핑정보를 넣어준다.
        // 매퍼로 인해 쿼리의 결과가 매핑되서 반환된다.

    }

    //쿼리의 결과 (resultSet)을 어떤 방법으로 매핑할것인지를 정의한 Mapper
    private RowMapper<Member> memberRowMapper() {
        //rs는 기존에 결과를 받았던 resultSet이고, rowNum은 행의 수를 의미한다 즉 데이터의 갯수
        return (rs, rowNum) -> {
            Member member = new Member();
            member.setMemberId(rs.getString("member_id"));
            member.setMoney(rs.getInt("money"));
            return member;
        };
    }

    @Override // @Override 어노테이션을 붙여놓는게 좋다. 그래야 오버라이드가 안맞을때 컴파일러가 에러를 표시해주기 때문이다.
    public void update(String memberId, int money){
        String sql = "update member set money=? where member_id=?";
        jdbcTemplate.update(sql, money, memberId);

    }
    @Override // @Override 어노테이션을 붙여놓는게 좋다. 그래야 오버라이드가 안맞을때 컴파일러가 에러를 표시해주기 때문이다.
    public void delete(String memberId){
        String sql = "delete from member where member_id = ?";
        jdbcTemplate.update(sql, memberId);
    }

    //커넥션을 닫고, 동기화된 커넥션을 받아오는 부분이 다 필요없게 된다.
}

JdbcTemplate를 이용하여 리포지토리에서 반복됬던 코드를 해결하였다.

 

(테스트 잘동작함)

 

JdbcTemplate 은 JDBC로 개발할 때 발생하는 반복을 대부분 해결해준다.

 

그 뿐만 아니라 지금까지 학습했던,

트랜잭션을 위한 커넥션 동기화는 물론이고, 예외 발생시 스프링 예외 변환기도 자동으로 실행해준다.

 

 참고

템플릿 콜백 패턴에 대해서 지금은 자세히 이해하지 못해도 괜찮다.

스프링이 JdbcTemplate 이라는 편리한 기능을 제공하는 구나 정도로 이해해도 된다.

템플릿 콜백 패턴에 대한 자세한 내용은 스프링 핵심 원리 - 고급편 강의를 참고하자.

 

 

정리

 

완성된 코드를 확인해보자.

 

서비스 계층의 순수성

 

트랜잭션 추상화 + 트랜잭션 AOP 덕분에 서비스 계층의 순수성을 최대한 유지하면서

서비스 계층에서 트랜잭션을 사용할 수 있다.

 

스프링이 제공하는 예외 추상화와 예외 변환기 덕분에,

데이터 접근 기술이 변경되어도 서비스 계층의 순수성을 유지하면서 예외도 사용할 수 있다.

 

서비스 계층이 리포지토리 인터페이스에 의존한 덕분에

향후 리포지토리가 다른 구현 기술로 변경되어도 서비스 계층을 순수하게 유지할 수 있다.

 

 

리포지토리 반복 코드 제거

리포지토리에서 JDBC를 사용하는 반복 코드가 JdbcTemplate 으로 대부분 제거되었다.