[트러블슈팅] JavaMailSender 빈 등록 오류 (로컬 환경)

TROUBLESHOOTING

JavaMailSender 빈 등록 오류 해결 과정

목차

• 1. 발생 배경
• 2. 문제
• 3. 원인
• 4. 해결
• 5. 참고
• 6. 배운 점

1. 발생 배경

이메일 인증 기능을 구현한 뒤 애플리케이션을 실행하는 과정에서 JavaMailSender 관련 빈 등록 오류가 발생했다.

이메일 인증 기능에서는 인증 코드를 사용자 이메일로 발송해야 하므로 Spring의 JavaMailSender를 사용하고 있었다. 하지만 로컬 환경에서 메일 관련 설정이 누락되어 애플리케이션 컨텍스트가 정상적으로 로드되지 않았다.

이번 문제는 코드 로직 자체의 문제라기보다, 로컬 환경 설정 파일에 메일 관련 설정이 빠져 있어 Spring Boot가 필요한 빈을 생성하지 못한 것이 원인이었다.

2. 문제

애플리케이션 실행 시 AuthService 생성자에서 JavaMailSender 빈을 찾지 못해 컨텍스트 로드에 실패했다.

Parameter 5 of constructor in booktine.Booktine.domain.auth.service.AuthService required a bean of type 'org.springframework.mail.javamail.JavaMailSender' that could not be found.

즉, AuthService는 생성자 주입을 통해 JavaMailSender를 필요로 하지만, Spring 컨테이너에는 해당 타입의 빈이 등록되어 있지 않은 상태였다.

3. 원인

원인은 로컬 환경의 application-local.properties에 메일 관련 설정이 누락되어 있었기 때문이다.

Spring Boot는 spring.mail.host, spring.mail.port 같은 메일 설정이 존재해야 JavaMailSender를 자동으로 빈으로 등록한다. 하지만 로컬 설정 파일에 해당 값들이 없었기 때문에 자동 설정이 동작하지 않았다.

이메일 인증 구현 초기 코드다. AuthService에서 JavaMailSender를 주입받고 있지만, 로컬 환경에는 메일 설정이 없어 빈 등록 오류가 발생했다.

4. 해결

1. application-local.properties에 더미 메일 설정 추가

먼저 로컬 환경에서도 JavaMailSender 빈이 생성될 수 있도록 application-local.properties에 더미 메일 설정을 추가했다.

로컬 환경에서 JavaMailSender 빈을 등록하기 위해 추가한 더미 SMTP 설정이다. 실제 메일 발송 목적이 아니라 빈 생성을 위한 설정이다.

더미 설정은 실제 발송을 위한 값이 아니라, Spring Boot가 JavaMailSender를 자동 설정할 수 있도록 최소한의 메일 설정을 제공하기 위한 값이다.

 

2. 로컬 환경에서는 실제 메일 발송 스킵 처리

더미 메일 설정을 추가하면 JavaMailSender 빈 등록 문제는 해결된다. 하지만 실제 메일 발송을 시도하면 잘못된 계정 정보로 인해 인증 실패가 발생할 수 있다.

그래서 운영 환경에서만 실제 메일을 발송하고, 로컬 환경에서는 메일 발송을 스킵한 뒤 인증 코드를 로그로 확인하도록 처리했다.

활성 프로파일을 기준으로 로컬 환경에서는 이메일 발송을 스킵하고, 운영 환경에서만 실제 메일을 발송하도록 분기한 코드다.

로컬에서는 메일 발송을 스킵하고 인증 코드를 로그로 확인하도록 처리했다. 이를 통해 로컬 개발 중에는 Gmail SMTP 인증 정보 없이도 이메일 인증 흐름을 테스트할 수 있다.

5. 참고

• 운영 환경에서는 application-prod.properties에 실제 Gmail SMTP 설정이 필요하다.
• Gmail을 사용할 경우 일반 비밀번호가 아니라 앱 비밀번호를 발급받아 사용해야 한다.
• Gmail 앱 비밀번호는 2단계 인증을 활성화한 뒤 구글 계정의 보안 설정에서 발급할 수 있다.

6. 배운 점

Spring Boot는 메일 설정이 존재해야 JavaMailSender 빈을 자동 등록한다. 따라서 로컬 환경에서도 실제 메일을 보내지 않더라도 더미 메일 설정은 필요하다.

또한 환경별 분기를 작성할 때 local, dev 등 특정 개발 환경을 하나씩 제외하는 방식보다 운영 프로파일인 prod에서만 실제 발송이 일어나도록 제한하는 방식이 더 안전하다.

정리하면, 로컬에서는 더미 메일 설정으로 빈 등록 문제를 해결하고, 실제 메일 발송은 운영 환경에서만 수행하도록 분리하는 것이 안전하다.