E-mail인증 처리

프로젝트에 적용할 이메일인증처리 관련 로직을 구현해 보려고합니다.

먼저 구현하려는 요구사항을 아래와 같습니다.

1. 이메일 인증 코드를 생성하고 해당 코드를 사용자 이메일로 전송.
2. 사용자는 이메일에 있는 코드를 입력하여 사용자의 이메일을 인증.
3. 코드는 일정 시간 후에 만료.

프로젝트 환경은 아래와 같습니다.

• IntelliJ Ultimate
• Java11
• Spring Boot 2.7.14
• Gradle
• MyBatsi
• MariaDB

먼저 E-mail 인증관련 의존성을 "build.gradle"에 추가합니다.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-mail'
}

 

그리고 application.yml에 mail관련 서비스를 처리할 계정정보를 입력해줍니다. 여기서 저는 Gmail을 사용했습니다.

  mail:
    host: smtp.gmail.com
    port: 587
    username: "사용할 구글 계정을 입력"
    password: "비밀번호 입력"
    properties:
      mail:
        smtp:
          auth: true
          starttls:
            enable: true

먼저 host: smtp.gmail.com은 이메일을 전송할 SMTP(Simple Mail Transfer Protocol)서버의 주소입니다. 여기서는 Gmail의 SMTP서버 주소이구요

"port: 587"은 SMTP서버에 연결할 때 사용할 포트 번호입니다. 587은 TLS를 사용하는 경우의 Gmail SMTP서버의 포트 번호 입니다.

SSL을 사용하면 포트번호를 "465"로 사용하시면 됩니다.

 

"properties"아래는 추가적인 메일 설정을 위한 프로퍼티인데

"mail.smtp.auth : true"는 SMTP인증을 사용할 것인지

"mail.smtp.starttls.enable: true"는 TLS보안을 사용할 것인지 설정하는 부분입니다.

 

이렇게 의존성과 기본적인 설정을 한 후 데이터베이스에 이를 담당할 테이블을 생성합니다.

CREATE TABLE email_verification (
    id INT PRIMARY KEY AUTO_INCREMENT,
    user_email VARCHAR(255) NOT NULL,
    verification_code VARCHAR(255) NOT NULL,
    is_verified BOOLEAN DEFAULT FALSE,
    expiry_date DATETIME
);

 

다음으로 Email인증 관련 EmailVerificationDto를 만들어보겠습니다.

import lombok.Getter;
import lombok.AllArgsConstructor;
import lombok.Builder;

import java.util.Date;

@Getter
@AllArgsConstructor
@Builder(toBuilder = true)
public class EmailVerification {

    private final String userEmail;
    private final String verificationCode;
    private final boolean isVerified;
    private final Date expiryDate;
}

기존에 사용할 때는 Date데이터 타입대신 String을 사용했었었는데 이번에는 Date타입을 사용해 보았습니다.

userEmail은 회원의 이메일

virificationCode는 인증 코드

isVerified는 인증여부

expriyDate는 만료날짜필드로 사용하기 위해 작성했습니다.

 

다음 단계는 Email서비스를 구현하는 클래스를 작성합니다.

실제 이메일을 보내는 로직과 인증 코드를 생성하는 로직이며, Email서비스 클래스는 아래와 같은 기능을 구현합니다.

1. 이메일을 보내는 메서드
2. 인증 코드를 생성하는 메서드
3. 인증 코드를 검증하는 메서드

Email을 보내고, 인증 코드를 생성/검증하는 역할을 담당합니다.

package com.project.user.service;

import lombok.RequiredArgsConstructor;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Service;

import java.util.Random;

@Service
@RequiredArgsConstructor
public class EmailServiceImpl implements EmailService{
    
    //JavaMailSener 의존성주입
    private final JavaMailSender mailSender;
    //인증코드 생성 랜덤 객체
    private Random random = new Random();
    //이메일 발송 메서드
    @Override
    public void sendEmail(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        mailSender.send(message);
    }

    //6자리 인증 코드 생성 메서드
    @Override
    public String generateVerificationCode() {
        return String.format("%06d", random.nextInt(1000000));
    }

    //인증 코드가 유효한지 검증
    @Override
    public boolean verifyCode(String inputCode, String sentCode) {
        return inputCode.equals(sentCode);
    }
}

여기서 "random.nextInt(n)"메서드는 n-1까지의 정수 중에서 랜덤하게 하나를 선택하여 반환합니다.

위 코드에서는 "String.format("%06d", random.nextInt(1000000));"을 살펴보면

"random.nextInt(1000000)은 0부터 999999까지의 랜덤한 정수를 생성

String.forma("%06d",...)는 이 정수를 6자리 숫자 문자열로 포맷해줍니다.

 

다음으로 Mapper Interface와 XML파일을 만들어보도록 하겠습니다.

제 프로젝트에서는 MyBatis를 사용하고 있기 때문에 SQL쿼리를 정의해야합니다.

작성할 XML파일에는 이메일 인증 코드를 저장, 검색, 삭제하는 기능을 구현해야합니다.

 

먼저 Mapper Interface

@Mapper
public interface EmailVerificationMapper {
    
    //이메일 인증 코드 저장
    void insertEmailCode(EmailVerificationDto emailVerificationDto);
    
    //이메일 주소로 인증 코드 검색
    EmailVerificationDto findEmailCodeByUserEmail(String userEmail);
    
    //인증 코드 삭제
    void deleteEmailCode(String userEmail);
}

insertEmailCode()메서드는 이메일, 인증 코드, 만료 날짜를 데이터베이스에 저장합니다. 이 정보는 나중에 사용자가 이메일을 통해 인증할 때 필요합니다.

findEmailCodeByUserEmail()메서드는 주어진 이메일 주소에 대한 인증 코드와 만료날짜를 데이터베이스에서 검색하며, 이 정보는 사용자가 인증 코드를 입력할 때 검증하는 데 사용됩니다.

deleteEmailCode()메서드는 인증이 완료된 후 해당 이메일의 인증 코드를 데이터베이스에서 삭제합니다. 불필요한 데이터가 계속 쌓이지 않게끔 방지하기 위한 메서드 입니다.

 

다음으로 Mapper.Xml 입니다.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.project.user.dao.EmailVerificationMapper">

    <!-- 이메일 인증 코드 저장 -->
    <insert id = "insertEmailCode">
        INSERT INTO email_verification (user_email, verification_code, expiry_date)
        VALUES (#{userEmail}, #{verificationCode}, #{expriyDate})
    </insert>
    
    <!-- 이메일 주소로 인증 코드 검색 -->
    <select id = "findEmailCodeByUserEmail" resultType="com.project.user.dto.EmailVerificationDto">
        SELECT 
            user_email AS userEmail, 
            verification_code AS verificationCode, 
            expiry_date AS expriyDate
        FROM email_verification
        WHERE user_email = #{userEmail}
    </select> 
    
    <!-- 인증 코드 삭제 -->
    <delete id = "deleteEmailCode">
        DELETE FROM email_verification WHERE user_email = #{userEmail}
    </delete>
</mapper>