[Spring 심화] 코드 리팩토링 과제 회고

코드 리팩토링 과제를 수행하면서 학습한 내용을 정리해보았습니다.

 

🔎 학습한 내용

1. Early return

조건에 맞지않는 경우, 빠르게 return하거나 예외를 발생시켜 불필요한 로직이 실행되지 않도록 하는 것이다.

성능 향상, 코드의 가독성을 높이는 장점이 있다.

ex) 회원가입 시 비밀번호를 encode 후 email이 유효한지 찾는다면, email이 유효하지 않을 경우 비밀번호를 encode한 행위는 무의미한 동작이 되어버린다. 때문에, email이 유효한지 확인하고, 비밀번호를 encode 할 수 있도록 코드를 설계해야한다.

 

2. 불필요한 if-else문 피하기

중첩된 if-else문을 줄여서 코드를 깔끔하게 정리한다.

이를 Arrowhead 를 Guard Clause 스타일로 개선한다 라고 표현한다. (출처: 익명의 튜터님)

왜 화살촉인가 했더니..

사진출처:  https://nus-cs2103-ay1920s1.github.io/website/se-book-adapted/chapters-printable/codeQuality-printable.html

그렇습니다. 명확한 사진!

코드로 보자면 아래와 같다.

// Before🤨
if (!HttpStatus.OK.equals(response.getStatusCode())) {
    throw new ServerException(...);
} else {
    if (weatherArray == null || weatherArray.length == 0) {
        throw new ServerException(...);
    }
}


// After🤗
if (!HttpStatus.OK.equals(response.getStatusCode())) {
    throw new ServerException(...);
}
if (weatherArray == null || weatherArray.length == 0) {
    throw new ServerException(...);
}

굳이 다른 조건문을 비교할 건데 if-else문을 쓸 필요가 없었다. 

아무생각 없었는데 역시 아무생각 없으면 안된다.

지금은 짧은 코드지만 코드가 길어지면 가독성에 확연하게 차이가 날 것 같다.

 

3. DTO Validation으로 책임 이전하기

기존에는 Service 계층에서 if문으로 유효성을 검사했지만, DTO에서 어노테이션 기반 Validation으로 검증한다.

서비스에는 검증된 값만 들어오므로 로직이 간결해진다.

사용 라이브러리는 org.springframework.boot:spring-boot-starter-validation

동일한 이름이 있으니 라이브러리까지 의식해서 공부해야한다... 

 

4. N+1 문제

✔️ N+1 문제란?

N개의 데이터를 조회할 때, 연관된 데이터를 지연 로딩(LAZY)으로 가져오며 추가로 N개의 쿼리가 발생하는 현상이다.

예시를 들자면,

1. 게시글 10개 조회 → 쿼리 1번 실행 (SELECT * FROM posts)

2. 각 게시글의 작성자(User)를 조회 → 게시글 수만큼 쿼리 실행됨 (N번)
   SELECT * FROM users WHERE id = ?
   ...이게 10번 실행됨 😨

즉 총 1+N 번의 쿼리가 실행되는 것이다...

처음에는 전체를 불러오는 1개의 쿼리가 추가된 것이라 생각했는데, 연관 데이터를 가져오기 위한 N번이 추가로 불러오게 되는것이었다. 1이 추가인 줄 알고 큰 문제가 아니라고 생각했는데 N이 추가라니.. 아주 큰 문제였다.

 

🌀 단점

쿼리가 너무 많이 실행되어서 성능이 떨어지고, 서버 부하가 커진다.

특히 게시글 수가 많아지면 N이 엄청 커지게 된다 → 그만큼 느려진다.

 

🚀 해결법

✔️ fetch join

@Query("SELECT p FROM Post p JOIN FETCH p.user")
List<Post> findAllWithUser();

게시글(p)과 작성자(p.user)를 한 번의 쿼리로 묶어서 가져온다.

 

✔️ @EntityGraph

@EntityGraph(attributePaths = {"user"})
List<Post> findAll();

쿼리 메서드에 연관 엔티티를 함께 가져오라고 명시하는 방법이다.

fetch join과 유사한 효과지만 좀 더 명확하다.

 

💀 발생 원인

연관관계가 지연로딩으로 이루어져 있기 때문이다. 게시글 먼저 불러오고, 작성자는 나중에 필요할때 더 불러올게요~ 라고 설정해서 N개의 쿼리가 추가로 실행되는 것이였다.

 

솔직하게 말하자면.. 아직 지연로딩이 뭔지 모르겠고 그래서 fetch join, @EntityGraph 어떻게 쓰는지 모르겠다. 이건 별도의 게시글로 정리를 하면서 공부를 해야한다 ㅠ.ㅠ 

 

확실히 알게된 한줄 요약은 N+1 문제의 해결법은 연관된 데이터를 한번에 가져와서 쿼리수를 줄여주는 것이다.

 

5. 테스트코드

하나도 모르겠다. 과제에서 보여준 실패 이유는 다음과 같다.

• 메서드 파라미터 순서를 잘못 넣음
• Service 계층에서는 A라는 예외 처리를 했는데, 테스트에서는 B를 기대했다.
• todo.getUser()가 null인 상태에서 getId()를 호출하여, NPE가 발생했다.

 

예외종류도 더 공부해야한다. 이번 과제에서 공부한 예외는 아래 2개..

• InvalidRequestException: 개발자가 직접 잘못된 요청이라고 판단해서 의도적으로 던지는 예외
• NullPointerException: null인 객체에 접근했을 때 자바가 자동으로 터뜨리는 예외, 사전에 null 체크 필요

 

유닛 테스트와 통합 테스트

• 유닛 테스트: 메서드 하나만 독립적으로 테스트
• 통합 테스트: 여러 컴포넌트가 연결된 상태(ex: 컨트롤러 전체)

 

테스트 작성 구조는 given-when-then 패턴을 따르다. (준비-실행-검증)

 

@ExtendWith, @InjectMocks  이런 처음보는 어노테이션들.. 세션 복습과 실습이 필요하다😭

 

✏️ 느낀점

리팩토링 이란걸 처음 경험해보았다.

클린코드, N+1 문제, 테스트 코드에 대한 공부가 필요하다.