feat : 이메일 인증 기능 구현

build.gradle

@@ -58,6 +58,9 @@ dependencies {
 
     // Swagger
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'
+
+    // Mail
+    implementation 'org.springframework.boot:spring-boot-starter-mail'
 }
 
 tasks.named('test') {

src/main/java/com/gdschongik/gdsc/domain/integration/EmailVerificationCode.java

@@ -0,0 +1,21 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.redis.core.RedisHash;
+import org.springframework.data.redis.core.TimeToLive;
+
+@Getter
+@AllArgsConstructor
+@RedisHash(value = "emailVerificationCode")
+public class EmailVerificationCode {
+
+    @Id
+    private String email;
+
+    private String verificationCode;
+
+    @TimeToLive
+    private long timeToLiveInSeconds;
+}

src/main/java/com/gdschongik/gdsc/domain/integration/EmailVerificationCodeRepository.java

@@ -0,0 +1,8 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import org.springframework.data.repository.CrudRepository;
+
+public interface EmailVerificationCodeRepository
+    extends CrudRepository<EmailVerificationCode, String> {
+
+}

src/main/java/com/gdschongik/gdsc/domain/integration/HongikUnivEmailValidator.java

@@ -0,0 +1,26 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import com.gdschongik.gdsc.global.exception.CustomException;
+import com.gdschongik.gdsc.global.exception.ErrorCode;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class HongikUnivEmailValidator {
+
+
+    private static final String HONGIK_UNIV_MAIL_DOMAIN = "@g.hongik.ac.kr";
+
+    private static final String EMAIL_REGEX = "^[^\\W&=_'-+,<>]+(\\.[^\\W&=_'-+,<>]+)*@g\\.hongik\\.ac\\.kr$";
+
+    public void validate(String email) {
+        if (!email.contains(HONGIK_UNIV_MAIL_DOMAIN)) {
+            throw new CustomException(ErrorCode.UNIV_EMAIL_DOMAIN_MISMATCH);
+        }
+
+        if (!email.matches(EMAIL_REGEX)) {
+            throw new CustomException(ErrorCode.UNIV_EMAIL_FORMAT_MISMATCH);
+        }
+    }
+}

src/main/java/com/gdschongik/gdsc/domain/integration/JavaMailSender.java

@@ -0,0 +1,49 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import jakarta.mail.Message.RecipientType;
+import jakarta.mail.MessagingException;
+import jakarta.mail.internet.InternetAddress;
+import jakarta.mail.internet.MimeMessage;
+import java.io.UnsupportedEncodingException;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class JavaMailSender implements MailSender {
+
+    private static final String SENDER_PERSONAL = "GDSC Hongik 운영팀";
+    private static final String SENDER_ADDRESS = "[email protected]";
+    private static final String MESSAGE_SUBJECT = "GDSC Hongik 이메일 인증 코드입니다.";
+
+    private final org.springframework.mail.javamail.JavaMailSender javaMailSender;
+
+    @Override
+    public void send(String recipient, String content) {
+        try {
+            MimeMessage message = writeMimeMessage(recipient, content);
+            javaMailSender.send(message);
+        } catch (MessagingException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    private MimeMessage writeMimeMessage(String recipient, String content)
+        throws MessagingException {
+        MimeMessage message = javaMailSender.createMimeMessage();
+
+        message.addRecipients(RecipientType.TO, recipient);
+        message.setSubject(MESSAGE_SUBJECT);
+        message.setText(content, "utf-8", "html");
+        message.setFrom(getInternetAddress());
+        return message;
+    }
+
+    private InternetAddress getInternetAddress() {
+        try {
+            return new InternetAddress(SENDER_ADDRESS, SENDER_PERSONAL);
+        } catch (UnsupportedEncodingException unsupportedEncodingException) {
+            return new InternetAddress();
+        }
+    }
+}

src/main/java/com/gdschongik/gdsc/domain/integration/JavaMailSenderConfig.java

@@ -0,0 +1,41 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import java.util.Properties;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.mail.javamail.JavaMailSenderImpl;
+
+@Configuration
+public class JavaMailSenderConfig {
+
+    @Value("${gmail.id}")
+    private String id;
+
+    @Value("${gmail.password}")
+    private String password;
+
+    @Bean
+    public JavaMailSender javaMailSender() {
+        JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
+        javaMailSender.setHost("smtp.gmail.com");
+        javaMailSender.setPort(456);
+        javaMailSender.setUsername(id);
+        javaMailSender.setPassword(password);
+        javaMailSender.setJavaMailProperties(getMailProperties());
+        javaMailSender.setDefaultEncoding("UTF-8");
+        return javaMailSender;
+    }
+
+    private Properties getMailProperties() {
+        Properties properties = new Properties();
+        properties.put("mail.smtp.socketFactory.port", 456);
+        properties.put("mail.smtp.auth", true);
+        properties.put("mail.smtp.starttls.enable", true);
+        properties.put("mail.smtp.starttls.required", true);
+        properties.put("mail.smtp.socketFactory.fallback", false);
+        properties.put("mail.smtp.socketFactory.class", "javax.net.ssl.SSLSocketFactory");
+        return properties;
+    }
+}

src/main/java/com/gdschongik/gdsc/domain/integration/MailSender.java

@@ -0,0 +1,6 @@
+package com.gdschongik.gdsc.domain.integration;
+
+public interface MailSender {
+
+    void send(String recipient, String content);
+}

src/main/java/com/gdschongik/gdsc/domain/integration/UnivEmailVerificationService.java

@@ -0,0 +1,60 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import com.gdschongik.gdsc.global.exception.CustomException;
+import com.gdschongik.gdsc.global.exception.ErrorCode;
+import java.time.Duration;
+import java.util.Objects;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class UnivEmailVerificationService {
+
+    private final HongikUnivEmailValidator hongikUnivEmailValidator;
+    private final VerificationCodeGenerator verificationCodeGenerator;
+    private final VerificationMailContentWriter verificationMailContentWriter;
+
+    private final MailSender mailSender;
+    private final EmailVerificationCodeRepository emailVerificationCodeRepository;
+
+    public static final Duration VERIFICATION_CODE_TIME_TO_LIVE = Duration.ofMinutes(10);
+
+    public void sendEmailVerificationMail(String email) {
+        hongikUnivEmailValidator.validate(email);
+
+        String verificationCode = verificationCodeGenerator.generate();
+        sendMail(email, verificationCode);
+
+        saveVerificationCode(email, verificationCode);
+    }
+
+    private void sendMail(String email, String verificationCode) {
+        String mailContent = verificationMailContentWriter
+            .writeContentWithVerificationCode(verificationCode, VERIFICATION_CODE_TIME_TO_LIVE);
+
+        mailSender.send(email, mailContent);
+    }
+
+    private void saveVerificationCode(String email, String verificationCode) {
+        EmailVerificationCode emailVerificationCode = new EmailVerificationCode(
+            email, verificationCode, VERIFICATION_CODE_TIME_TO_LIVE.toSeconds()
+        );
+
+        emailVerificationCodeRepository.save(emailVerificationCode);
+    }
+
+    public void validateCodeMatch(String email, String userInputCode) {
+        String verificationCode = getVerificationCodeByEmail(email);
+
+        if (!Objects.equals(verificationCode, userInputCode)) {
+            throw new CustomException(ErrorCode.UNIV_EMAIL_VERIFICATION_CODE_NOT_MATCH);
+        }
+    }
+
+    private String getVerificationCodeByEmail(String email) {
+        return emailVerificationCodeRepository.findById(email)
+            .orElseThrow(() -> new CustomException(ErrorCode.VERIFICATION_CODE_NOT_FOUND))
+            .getVerificationCode();
+    }
+}

src/main/java/com/gdschongik/gdsc/domain/integration/VerificationCodeGenerator.java

@@ -0,0 +1,16 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import org.apache.commons.lang3.RandomStringUtils;
+import org.springframework.stereotype.Component;
+
+@Component
+public class VerificationCodeGenerator {
+
+    private static final int VERIFICATION_CODE_LENGTH = 16;
+    private static final char RANGE_START_CHAR = '0';
+    private static final char RANGE_END_CHAR = 'z';
+
+    public String generate() {
+        return RandomStringUtils.random(VERIFICATION_CODE_LENGTH, RANGE_START_CHAR, RANGE_END_CHAR, true, true);
+    }
+}

src/main/java/com/gdschongik/gdsc/domain/integration/VerificationMailContentWriter.java

@@ -0,0 +1,19 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import java.time.Duration;
+import org.springframework.stereotype.Component;
+
+@Component
+public class VerificationMailContentWriter {
+
+    private static final String NOTIFICATION_MESSAGE = "<div style='margin:20px;'>"
+        + "<h1> 안녕하세요 GDSC Hongik 이메일 인증 메일입니다. </h1> <br>"
+        + "<h3> 아래의 인증 코드를 %d분 안에 입력해주세요. </h3> <br>"
+        + "<h3> 감사힙니다. </h3> <br>"
+        + "CODE : <strong>";
+
+    public String writeContentWithVerificationCode(String verificationCode, Duration codeAliveTime) {
+        return String.format(NOTIFICATION_MESSAGE, codeAliveTime.toMinutes())
+            + verificationCode;
+    }
+}

src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java

@@ -18,7 +18,16 @@ public enum ErrorCode {
 
     // Member
     MEMBER_NOT_FOUND(HttpStatus.NOT_FOUND, "존재하지 않는 회원입니다."),
-    MEMBER_DELETED(HttpStatus.CONFLICT, "탈퇴한 회원입니다.");
+    MEMBER_DELETED(HttpStatus.CONFLICT, "탈퇴한 회원입니다."),
+
+    // Univ Email Verification
+    UNIV_EMAIL_DUPLICATED(HttpStatus.CONFLICT, "이미 가입된 Univ Email 입니다."),
+    UNIV_EMAIL_FORMAT_MISMATCH(HttpStatus.BAD_REQUEST, "형식에 맞지 않는 Univ Email 입니다."),
+    UNIV_EMAIL_DOMAIN_MISMATCH(HttpStatus.BAD_REQUEST, "Univ Email의 도메인이 맞지 않습니다."),
+
+    VERIFICATION_CODE_NOT_FOUND(HttpStatus.NOT_FOUND, "Univ Email 인증 코드가 존재하지 않습니다."),
+    UNIV_EMAIL_VERIFICATION_CODE_NOT_MATCH(HttpStatus.BAD_REQUEST, "Email 인증 번호가 불일치합니다."),
+    ;
 
     private final HttpStatus status;
     private final String message;

src/main/resources/application.yml

@@ -13,3 +13,7 @@ spring:
 logging:
   level:
     com.gdschongik.gdsc.domain.*.api.*: debug
+
+gmail:
+  id: ${GMAIL_ID}
+  password: ${GMAIL_PASSWORD}

src/test/java/com/gdschongik/gdsc/domain/integration/HongikUnivEmailValidatorTest.java

@@ -0,0 +1,72 @@
+package com.gdschongik.gdsc.domain.integration;
+
+import static org.assertj.core.api.Assertions.assertThatCode;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import com.gdschongik.gdsc.global.exception.CustomException;
+import com.gdschongik.gdsc.global.exception.ErrorCode;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+public class HongikUnivEmailValidatorTest {
+
+    @Autowired
+    private HongikUnivEmailValidator hongikUnivEmailValidator;
+
+    @Test
+    @DisplayName("'g.hongik.ac.kr' 도메인을 가진 이메일을 검증할 수 있다.")
+    public void validateEmailDomainTest() {
+        String hongikDomainEmail = "[email protected]";
+
+        assertThatCode(
+            () -> hongikUnivEmailValidator.validate(hongikDomainEmail)
+        ).doesNotThrowAnyException();
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"[email protected]", "[email protected]", "[email protected]",
+        "[email protected]"})
+    @DisplayName("'g.hongik.ac.kr'가 아닌 도메인을 가진 이메일을 입력하면 예외를 발생시킨다.")
+    public void validateEmailDomainMismatchTest(String email) {
+        assertThatThrownBy(() -> hongikUnivEmailValidator.validate(email))
+            .isInstanceOf(CustomException.class)
+            .hasMessage(ErrorCode.UNIV_EMAIL_DOMAIN_MISMATCH.getMessage());
+    }
+
+    @Test
+    @DisplayName("Email의 '@' 앞 부분에는 연속되지 않은 점이 포함될 수 있다.")
+    public void validateEmailFormatWithDotsTest() {
+        String email = "[email protected]";
+
+        assertThatCode(
+            () -> hongikUnivEmailValidator.validate(email)
+        ).doesNotThrowAnyException();
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"te&[email protected]", "[email protected]", "[email protected]",
+        "te'[email protected]", "[email protected]", "[email protected]",
+        "te,[email protected]", "te<[email protected]", "te>[email protected]"})
+    @DisplayName("Email의 '@' 앞 부분에 '&', '=', '_', ''', '-', '+', ',', '<', '>'가 포함되는 경우 예외를 발생시킨다.")
+    public void validateEmailFormatMismatchTest(String email) {
+        assertThatThrownBy(() -> hongikUnivEmailValidator.validate(email))
+            .isInstanceOf(CustomException.class)
+            .hasMessage(ErrorCode.UNIV_EMAIL_FORMAT_MISMATCH.getMessage());
+    }
+
+    @Test
+    @DisplayName("Email의 '@' 앞 부분에 '.'이 2개 연속 오는 경우 예외를 발생시킨다.")
+    public void validateEmailFormatMismatchWithDotsTest() {
+        String email = "[email protected]";
+        assertThatThrownBy(() -> hongikUnivEmailValidator.validate(email))
+            .isInstanceOf(CustomException.class)
+            .hasMessage(ErrorCode.UNIV_EMAIL_FORMAT_MISMATCH.getMessage());
+    }
+}
+
+