[정보] jpa repository 쿼리문 작성 시 주의점

아래 코드는 회원 가입 시 이메일 주소의 중복을 확인하기 위한 JPA Repository 함수입니다. @Query 어노테이션을 사용하여 문자열 email을 매개변수로 받습니다. 이 때 주의해야 할 점은 v.email = :email 부분입니다. String email을 매핑하기 위해서는 콜론(:)을 email에 바로 붙여서 작성해야 합니다. 이를 지키지 않으면 null Exception이 발생할 수 있습니다.

다음은 이메일 인증을 통한 회원의 존재 및 상태를 확인하고 가입에 인증을 처리하는 로직으로 예를 든다.

@Repository
public interface SignUpRepository extends JpaRepository<MemberEntity, Long> {

    /**
     * 주어진 이메일 주소가 데이터베이스에 존재하는지 확인합니다.
     *
     * @param email 이메일 주소
     * @return 이메일 주소가 존재하면 true, 그렇지 않으면 false
     */
    Boolean existsByEmail(String email);

    /**
     * 주어진 이메일 주소에 해당하는 회원 가입 정보의 인증 상태를 변경합니다.
     *
     * @param email 이메일 주소
     * @return 업데이트된 행(row)의 수
     */
    @Modifying
    @Transactional
    @Query("UPDATE MemberEntity v SET v.verified = true WHERE v.email = :email")
    int updateVerified(@Param("email") String email);
}

 

@Repository의 결과값은 @Service에서 결과 값 int(영향을 받은 행 수)는 다음과 같이 쓰인다.

/**
 * 이메일 인증을 통해 회원가입을 처리합니다.
 * 
 * @param value 인증 값
 * @return 회원 가입한 이메일 주소 또는 false
 */
public String checkVerification(String value) {
    // 값 존재 여부 확인
    Optional<VerificationEntity> vEntity = verificationRepository
            .findByVerificationValueAndExpiredAndVerified(value, false, false);
    
    if (vEntity.isPresent()) {
        // 인증 완료 처리
        verificationRepository.updateVerified(value);
        
        // 회원 가입 정보 업데이트
        if (1 == signUpRepository.updateVerified(vEntity.get().getEmail())) {
            // 회원 가입한 이메일 주소 반환
            return vEntity.get().getEmail();
        }
    }
    
    // 회원 가입 정보가 없거나 이미 인증된 경우 false 반환
    return "false";
}

 

@Service의 결과 값은 @Controller에서 다음과 같이 쓰인다.

/**
 * 이메일 인증 요청에 대한 응답 처리를 합니다.
 * 
 * @param value 인증 값
 * @param model 뷰에 전달할 데이터를 담는 모델
 * @return 뷰 이름
 */
@GetMapping("/verification")
public String verificationAction(String value, Model model) {
    // 이메일 인증 처리
    String result = verificationService.checkVerification(value);

    // 인증 결과에 따라 뷰에 전달할 데이터 설정
    if (!result.equals("false")) {
        // 인증 성공 메시지 설정
        model.addAttribute("message", "인증이 완료 되었습니다.");
        model.addAttribute("type", "info");
        
        // 회원 정보 설정
        model.addAttribute("member", MemberDTO.builder().email(result).build());
    } else {
        // 인증 실패 메시지 설정
        model.addAttribute("message", "인증코드가 올바르지 않습니다.");
        model.addAttribute("type", "warning");
    }
    
    // 회원 가입 페이지로 이동
    return "member/sign-in";
}

 

@View(Mustache)에서는 다음과 같이 message가 사용된다. 주로 Alert창에 대한 정보를 회신하기 위하여 쓴다.

{{#message}}
    <div class="alert alert-{{#type}}{{type}}{{/type}}" role="alert">
        {{message}}
    </div>
{{/message}}

 

@웹부라우저에서는 다음과 같이 확인된다.