Feature: Gmail 인증번호 전송 틀 마련, refreshToken Swagger 추가 (#76)

* feature : gmail 전송 기본 설정 및 service 클래스 생성

* feature : 메일 전송 기능 추가

* docs : refreshToken 발급 parameter추가

* coderabbit반영

* ci.yml 반영

Author: minjee2758

.github/workflows/ci.yml

@@ -35,6 +35,8 @@ jobs:
       REDIRECT_URI: ${{ secrets.REDIRECT_URI }}
       SPRING_MONGODB_URI: ${{ secrets.SPRING_MONGODB_URI}}
       DISCORD_WEBHOOK_URL: ${{ secrets.DISCORD_WEBHOOK_URL }}
+      EZ_EMAIL : ${{ secrets.EZ_EMAIL }}
+      APP_PASSWORD : ${{ secrets.APP_PASSWORD }}
 
     steps:
       - name: Checkout Repository

build.gradle

@@ -107,6 +107,10 @@ dependencies {
     implementation 'org.mapstruct:mapstruct:1.6.3'
     annotationProcessor 'org.mapstruct:mapstruct-processor:1.6.3'
 
+    //email-smtp
+    implementation 'org.springframework.boot:spring-boot-starter-mail'
+
+
 }
 
 tasks.named('test') {

src/main/java/org/ezcode/codetest/domain/user/service/MailService.java

@@ -0,0 +1,49 @@
+package org.ezcode.codetest.domain.user.service;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.stereotype.Service;
+
+import jakarta.mail.MessagingException;
+import jakarta.mail.internet.MimeMessage;
+import lombok.RequiredArgsConstructor;
+
+@Service
+@RequiredArgsConstructor
+public class MailService {
+	private final JavaMailSender javaMailSender;
+	@Value("${spring.mail.username}")
+	private String senderEmail;
+	private static int number;
+
+	// 랜덤으로 숫자 생성
+	public static void createNumber() {
+		number = (int)(Math.random() * (90000)) + 100000; //(int) Math.random() * (최댓값-최소값+1) + 최소값
+	}
+	public MimeMessage CreateMail(String mail) {
+		createNumber();
+		MimeMessage message = javaMailSender.createMimeMessage();
+
+		try {
+			message.setFrom(senderEmail);
+			message.setRecipients(MimeMessage.RecipientType.TO, mail);
+			message.setSubject("이메일 인증");
+			String body = "";
+			body += "<h3>" + "요청하신 인증 번호입니다." + "</h3>";
+			body += "<h1>" + number + "</h1>";
+			body += "<h3>" + "감사합니다." + "</h3>";
+			message.setText(body,"UTF-8", "html");
+		} catch (MessagingException e) {
+			e.printStackTrace();
+		}
+
+		return message;
+	}
+
+	public int sendMail(String mail) {
+		MimeMessage message = CreateMail(mail);
+		javaMailSender.send(message);
+
+		return number;
+	}
+}

src/main/java/org/ezcode/codetest/domain/user/service/UserDomainService.java

@@ -76,10 +76,6 @@ public String encodePassword(String password) {
 		return passwordEncoder.encode(password);
 	}
 
-	// public User getOAuthUser(String email, String provider) {
-	// 	return userRepository.findByEmailAndProvider(email, provider);
-	// }
-
 	//유저의 AuthType을 리스트형태로 반환
 	public List<AuthType> getUserAuthTypes(User user) {
 		return userAuthTypeRepository.getUserAuthType(user);

src/main/java/org/ezcode/codetest/presentation/usermanagement/AuthController.java

@@ -21,6 +21,7 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.validation.Valid;
@@ -60,7 +61,10 @@ public ResponseEntity<LogoutResponse> logout(
 		return ResponseEntity.status(HttpStatus.OK).body(authService.logout(authUser.getId(), token));
 	}
 
-	@Operation(summary = "토큰 재발급", description = "리프레시 토큰을 이용하여 새로운 액세스 토큰을 발급합니다.")
+	@Operation(summary = "토큰 재발급", description = "리프레시 토큰을 이용하여 새로운 액세스 토큰을 발급합니다.",
+	parameters = {
+		@Parameter(name = "Authorization", description = "Bearer {refreshToken}", required = true)
+	})
 	@PostMapping("/auth/refresh")
 	public ResponseEntity<RefreshTokenResponse> refresh(HttpServletRequest request) {
 

src/main/java/org/ezcode/codetest/presentation/usermanagement/MailCheckController.java

@@ -0,0 +1,48 @@
+package org.ezcode.codetest.presentation.usermanagement;
+
+import java.util.HashMap;
+
+import org.ezcode.codetest.domain.user.model.entity.AuthUser;
+import org.ezcode.codetest.domain.user.service.MailService;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import lombok.RequiredArgsConstructor;
+
+@RestController
+@RequiredArgsConstructor
+public class MailCheckController {
+	private final MailService mailService;
+	private int number; // 이메일 인증 숫자를 저장하는 변수
+
+	// 인증 이메일 전송
+	@PostMapping("/mailSend")
+	public HashMap<String, Object> mailSend(
+		@AuthenticationPrincipal AuthUser authUser) {
+		HashMap<String, Object> map = new HashMap<>();
+
+		try {
+			number = mailService.sendMail(authUser.getEmail());
+
+			map.put("success", Boolean.TRUE);
+		} catch (Exception e) {
+			map.put("success", Boolean.FALSE);
+			map.put("error", e.getMessage());
+		}
+
+		return map;
+	}
+
+	// 인증번호 일치여부 확인
+	@GetMapping("/mailCheck")
+	public ResponseEntity<?> mailCheck(@RequestParam String userNumber) {
+
+		boolean isMatch = userNumber.equals(String.valueOf(number));
+
+		return ResponseEntity.ok(isMatch);
+	}
+}

src/main/resources/application.properties

@@ -101,6 +101,17 @@ logging.level.org.springframework.cache.interceptor.CacheInterceptor=TRACE
 # ========================
 discord.webhook.url=${DISCORD_WEBHOOK_URL}
 
+# ========================
+# email-smtp
+# ========================
+spring.mail.host=smtp.gmail.com
+spring.mail.port=587
+spring.mail.username=${EZ_EMAIL}
+spring.mail.password=${APP_PASSWORD}
+spring.mail.properties.mail.smtp.auth=true
+spring.mail.properties.mail.smtp.timeout=5000
+spring.mail.properties.mail.smtp.starttls.enable=true
+
 #logging.level.org.springframework.security=DEBUG
 #logging.level.org.springframework.security.oauth2=DEBUG
 #logging.level.org.springframework.security.oauth2.client=TRACE