refactor: 이메일 전송 그룹 코드를 문자열에서 Enum 으로 변경 (#345)

* feat: 이메일 전송 그룹 코드를 문자열에서 Enum 으로 변경
* feat: 이메일 전송 메서드의 매개변수 명을 toEmail로 통일

Author: fivedragon5

src/main/java/org/ject/support/domain/apply/service/RemindApplyService.java

@@ -7,6 +7,7 @@
 import org.ject.support.domain.member.repository.MemberRepository;
 import org.ject.support.domain.recruit.domain.Recruit;
 import org.ject.support.domain.recruit.repository.RecruitRepository;
+import org.ject.support.external.email.domain.EmailTemplate;
 import org.ject.support.external.email.service.SesEmailSendService;
 import org.springframework.stereotype.Service;
 
@@ -41,7 +42,7 @@ public void remindApply(Long recruitId) {
 
         // 필터링한 지원자들에게 리마인드
         emailSendService.sendBulkTemplatedEmail(
-                EMAIL_SEND_GROUP,
+                EmailTemplate.REMIND_APPLY,
                 targetEmails,
                 Map.of("deadline", DateTimeUtil.formatWithDayOfWeek(recruit.getEndDate())));
     }

src/main/java/org/ject/support/external/email/controller/EmailAuthApiSpec.java

@@ -1,7 +1,12 @@
 package org.ject.support.external.email.controller;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import org.ject.support.external.email.domain.EmailTemplate;
 import org.springframework.web.bind.annotation.RequestParam;
 
 @Tag(name = "Email", description = "이메일 API")
@@ -10,5 +15,15 @@ public interface EmailAuthApiSpec {
     @Operation(
             summary = "인증 번호 발송",
             description = "지정된 이메일로 인증 번호를 발송합니다.")
-    void sendAuthEmail(@RequestParam String sendGroupCode, @RequestParam String email);
+    @Parameters({
+            @Parameter(
+                    name = "sendGroupCode", description = "이메일 템플릿",
+                    schema = @Schema(allowableValues = {"AUTH_CODE", "PIN_RESET"}),
+                    examples = {
+                            @ExampleObject(name = "AUTH_CODE", summary = "이메일 인증 코드 안내", value = "AUTH_CODE"),
+                            @ExampleObject(name = "PIN_RESET", summary = "PIN 재설정 인증 코드 안내", value = "PIN_RESET")
+                    },
+                    required = true)
+    })
+    void sendAuthEmail(@RequestParam EmailTemplate sendGroupCode, @RequestParam String email);
 }

src/main/java/org/ject/support/external/email/controller/EmailAuthController.java

@@ -1,6 +1,7 @@
 package org.ject.support.external.email.controller;
 
 import lombok.RequiredArgsConstructor;
+import org.ject.support.external.email.domain.EmailTemplate;
 import org.ject.support.external.email.service.EmailAuthService;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -18,7 +19,7 @@ public class EmailAuthController implements EmailAuthApiSpec {
     @Override
     @PostMapping("/send/auth")
     @PreAuthorize("permitAll()")
-    public void sendAuthEmail(@RequestParam String sendGroupCode, @RequestParam String email) {
+    public void sendAuthEmail(@RequestParam EmailTemplate sendGroupCode, @RequestParam String email) {
         emailAuthService.sendAuthCode(sendGroupCode, email);
     }
 }

src/main/java/org/ject/support/external/email/domain/EmailTemplate.java

@@ -1,44 +1,16 @@
 package org.ject.support.external.email.domain;
 
-import jakarta.annotation.PostConstruct;
-import java.io.IOException;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Set;
-import java.util.stream.Collectors;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
-import org.ject.support.common.exception.GlobalErrorCode;
-import org.ject.support.common.exception.GlobalException;
-import org.springframework.core.io.Resource;
-import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
-import org.springframework.core.io.support.ResourcePatternResolver;
 
 @Getter
 @AllArgsConstructor
 public enum EmailTemplate {
-    ACCEPTANCE("email-template", "ject notification"),
-    REJECTION("email-template", "ject notification"),
-    AUTH_CODE("auth-code-email-template", "젝트 이메일 인증 코드 안내"),
-    PIN_RESET("pin-reset-email-template", "젝트 PIN 재설정 인증 코드 안내"),
-    REMIND_APPLY("remind-apply-email-template", "젝트 지원서 접수 마감일 안내");
+    AUTH_CODE("email-auth-template", "젝트 이메일 인증 코드 안내", "email_auth"),
+    PIN_RESET("pin-reset-template", "젝트 PIN 재설정 인증 코드 안내", "pin_reset"),
+    REMIND_APPLY("remind-apply-template", "젝트 지원서 접수 마감일 안내", "remind_apply");
 
     private final String templateName; // template file name
     private final String subject; // email subject
-
-    @PostConstruct
-    private void validateFileName() throws IOException {
-        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
-        List<String> templateFileNames = Arrays.stream(values()).map(EmailTemplate::getTemplateName).toList();
-
-        Set<String> actualFileNames = Arrays.stream(resolver.getResources("classpath:/templates/*.html"))
-                .map(Resource::getFilename)
-                .collect(Collectors.toSet());
-
-        for (String templateFileName : templateFileNames) {
-            if (!actualFileNames.contains(templateFileName + ".html")) {
-                throw new GlobalException(GlobalErrorCode.TEMPLATE_NOT_FOUND);
-            }
-        }
-    }
+    private final String tag; // email tag value
 }

src/main/java/org/ject/support/external/email/dto/SendManualBulkTemplatedEmailRequest.java

@@ -1,10 +1,12 @@
 package org.ject.support.external.email.dto;
 
+import org.ject.support.external.email.domain.EmailTemplate;
+
 import java.util.List;
 import java.util.Map;
 
 public record SendManualBulkTemplatedEmailRequest(
-        String sendGroupCode,
+        EmailTemplate sendGroupCode,
         List<String> toList,
         Map<String, String> content) {
 }

src/main/java/org/ject/support/external/email/dto/SendManualTemplatedEmailRequest.java

@@ -1,9 +1,11 @@
 package org.ject.support.external.email.dto;
 
+import org.ject.support.external.email.domain.EmailTemplate;
+
 import java.util.Map;
 
 public record SendManualTemplatedEmailRequest(
-        String sendGroupCode,
+        EmailTemplate sendGroupCode,
         String to,
         Map<String, String> content) {
 }

src/main/java/org/ject/support/external/email/service/EmailAuthService.java

@@ -3,6 +3,7 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.ject.support.common.util.CodeGeneratorUtil;
+import org.ject.support.external.email.domain.EmailTemplate;
 import org.springframework.data.redis.core.RedisTemplate;
 import org.springframework.stereotype.Service;
 
@@ -20,18 +21,18 @@ public class EmailAuthService {
     private final SesEmailSendService emailSendService;
     private final RedisTemplate<String, String> redisTemplate;
 
-    public void sendAuthCode(String sendGroupCode, String toAddress) {
+    public void sendAuthCode(EmailTemplate sendGroupCode, String toEmail) {
         String authCode = CodeGeneratorUtil.generateDigitCode(AUTH_CODE_LENGTH);
-        sendAuthCodeEmail(sendGroupCode, toAddress, authCode);
-        storeAuthCode(toAddress, authCode);
+        sendAuthCodeEmail(sendGroupCode, toEmail, authCode);
+        storeAuthCode(toEmail, authCode);
     }
 
-    private void sendAuthCodeEmail(String sendGroupCode, String toAddress, String authCode) {
-        emailSendService.sendTemplatedEmail(sendGroupCode, toAddress, Map.of("auth-code", authCode));
-        log.info("인증 번호 전송 - email: {}, code: {}", toAddress, authCode);
+    private void sendAuthCodeEmail(EmailTemplate sendGroupCode, String toEmail, String authCode) {
+        emailSendService.sendTemplatedEmail(sendGroupCode, toEmail, Map.of("auth-code", authCode));
+        log.info("인증 번호 전송 - toEmail: {}, code: {}", toEmail, authCode);
     }
 
-    private void storeAuthCode(String toAddress, String authCode) {
-        redisTemplate.opsForValue().set(toAddress, authCode, Duration.ofSeconds(EXPIRE_TIME));
+    private void storeAuthCode(String toEmail, String authCode) {
+        redisTemplate.opsForValue().set(toEmail, authCode, Duration.ofSeconds(EXPIRE_TIME));
     }
 }

src/main/java/org/ject/support/external/email/service/EmailSendService.java

@@ -1,5 +1,7 @@
 package org.ject.support.external.email.service;
 
+import org.ject.support.external.email.domain.EmailTemplate;
+
 import java.util.List;
 import java.util.Map;
 
@@ -8,10 +10,10 @@ public interface EmailSendService {
     /**
      * 단건 templated email 전송 (template)
      */
-    void sendTemplatedEmail(String sendGroupCode, String to, Map<String, String> params);
+    void sendTemplatedEmail(EmailTemplate sendGroupCode, String to, Map<String, String> params);
 
     /**
      * 대량 templated email 발송
      */
-    void sendBulkTemplatedEmail(String sendGroupCode, List<String> toList, Map<String, String> params);
+    void sendBulkTemplatedEmail(EmailTemplate sendGroupCode, List<String> toList, Map<String, String> params);
 }

src/main/java/org/ject/support/external/email/service/SesEmailSendService.java

@@ -4,6 +4,7 @@
 import lombok.RequiredArgsConstructor;
 import org.ject.support.common.util.Map2JsonSerializer;
 import org.ject.support.external.email.domain.EmailSendGroup;
+import org.ject.support.external.email.domain.EmailTemplate;
 import org.ject.support.external.email.exception.EmailErrorCode;
 import org.ject.support.external.email.exception.EmailException;
 import org.ject.support.external.email.repository.EmailSendGroupRepository;
@@ -40,21 +41,18 @@ public class SesEmailSendService implements EmailSendService {
     private String from;
 
     @Override
-    public void sendTemplatedEmail(String sendGroupCode, String to, Map<String, String> params) {
-        // 전송 그룹 정보 조회
-        EmailSendGroup sendGroup = getSendGroup(sendGroupCode);
-
+    public void sendTemplatedEmail(EmailTemplate sendGroupCode, String toEmail, Map<String, String> params) {
         // 이메일 콘텐츠 구성
         EmailContent emailContent = EmailContent.builder()
-                .template(getTemplate(sendGroup.getTemplateName(), params))
+                .template(getTemplate(sendGroupCode.getTemplateName(), params))
                 .build();
 
         // 이메일 그룹 식별용 태그 설정
-        MessageTag messageTag = getMessageTag(sendGroup.getCode());
+        MessageTag messageTag = getMessageTag(sendGroupCode.getTag());
 
         // 단건 이메일 요청 생성
         SendEmailRequest emailRequest = SendEmailRequest.builder()
-                .destination(getDestination(to))
+                .destination(getDestination(toEmail))
                 .content(emailContent)
                 .fromEmailAddress(from)
                 .emailTags(messageTag)
@@ -65,17 +63,14 @@ public void sendTemplatedEmail(String sendGroupCode, String to, Map<String, Stri
     }
 
     @Override
-    public void sendBulkTemplatedEmail(String sendGroupCode, List<String> toList, Map<String, String> params) {
-        // 전송 그룹 정보 조회
-        EmailSendGroup sendGroup = getSendGroup(sendGroupCode);
-
+    public void sendBulkTemplatedEmail(EmailTemplate sendGroupCode, List<String> toList, Map<String, String> params) {
         // 이메일 콘텐츠 구성
         BulkEmailContent content = BulkEmailContent.builder()
-                .template(getTemplate(sendGroup.getTemplateName(), params))
+                .template(getTemplate(sendGroupCode.getTemplateName(), params))
                 .build();
 
         // 이메일 그룹 식별용 태그 설정
-        MessageTag messageTag = getMessageTag(sendGroup.getCode());
+        MessageTag messageTag = getMessageTag(sendGroupCode.getTag());
 
         // 수신자 리스트를 초당 전송량만큼 분할하여 전송
         Lists.partition(toList, rateLimiter.getRateLimitPerSecond())