[구현] 스프링으로 이메일 인증 코드 발급, 인증하기

공부하면서 만들었기 때문에 틀린 부분이나 더 좋은 방법이 있을 수 있습니다!

 

구현 할 내용

1)

• 메일 인증 코드를 만든다.
• 해당 메일로 인증 코드를 보낸다.

2)

• 메일로 온 인증 코드를 입력한다.
• 메일과 인증 코드 일치 여부를 확인한다.

 

1. 아이디 만들기

나는 Gmail SMTP Server를 이용할 것이다.

개인 이메일을 사용하기는 좀 그렇기에 새로운 계정을 하나 더 만들것이다.

계정의 보안이 낮은 앱의 액세스를 허용해 주어야 한다고 한다.

 

2. Gmail SMTP Server 설정

build.gradle파일의 dependencies에 다음 문장을 추가해준다.

implementation 'org.springframework.boot:spring-boot-starter-mail'

 

application.properties파일에 다음 문장을 추가해준다.

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=(email)
spring.mail.password=(password)
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.auth=true

email, password는 본인 것 넣으면 된다.

 

3. 인증 코드 도메인 엔티티 만들기

verifycode는 코드값과 코드의 이메일로 이루어져 있다.

코드는 자동생성이며 이메일과 코드가 맞는지 여부를 확인하기 위함이다.

@Getter
@Entity
@Table
@AllArgsConstructor
@NoArgsConstructor
public class VerifyCode extends Timestamped{

    @Id
    @Column(name = "code")
    @GeneratedValue(generator = RandomGenerator.generatorName)
    @GenericGenerator(name = RandomGenerator.generatorName, strategy = "com.moment.CapturedMomentServer.util.RandomGenerator")
    String code;

    @Column(name = "email", unique = true)
    String email;

    public VerifyCode(VerifyCodeDto dto){
        this.email = dto.getEmail();
    }
}

randomgenerator는 다른 분이 인터넷에 올려주신 코드를 사용하였다.

http://daplus.net/java-%EC%9E%84%EC%9D%98%EC%9D%98-%EC%98%81%EC%88%AB%EC%9E%90-%EB%AC%B8%EC%9E%90%EC%97%B4%EC%9D%84-%EC%83%9D%EC%84%B1%ED%95%98%EB%8A%94-%EB%B0%A9%EB%B2%95%EC%9D%80-%EB%AC%B4%EC%97%87%EC%9E%85/

[java] 임의의 영숫자 문자열을 생성하는 방법은 무엇입니까? - 리뷰나라

인터넷에 많이 도는 코드 같긴 한데 이런 코드를 참고했고 12자의 랜덤 문자를 생성한다.

UUID는 너무 길어서 사용하게 되었다.

 

처음에는 이메일만을 입력하면 코드가 자동생성 발급되어야 하므로 DTO를 만들도록 하겠다.

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class VerifyCodeDto {
    @NotNull
    private String email;   // 회원 닉네임
}

 

4. 컨트롤러 만들기

인증 코드 메일 전송 컨트롤러부터 만들어보도록 하겠다.

    @PostMapping(value = "/user/certification")
    public ResponseEntity<HashMap> mailCheck(@RequestBody VerifyCodeDto codeDto){
        
        //코드 생성 & 저장
        VerifyCode verifyCode = verifyCodeService.saveCode(codeDto);
        
        //메일 전송
        boolean success = mailService.checkEmail(verifyCode);

        HashMap<String, Object> responseMap = new HashMap<>();
        if(success) {
            responseMap.put("status", 200);
            responseMap.put("message", "메일 발송 성공");
            responseMap.put("code" , verifyCode.getCode());
            return new ResponseEntity<HashMap> (responseMap, HttpStatus.OK);
        }
        else{
            responseMap.put("status", 500);
            responseMap.put("message", "메일 발송 실패");
            return new ResponseEntity<HashMap> (responseMap, HttpStatus.CONFLICT);
        }
    }

verifyCodeService에서 코드를 생성해 저장한다.

다음 코드를 mailService에서 이메일로 전송한다.

 

5. VerifyCodeRepository

@Repository
public interface VerifyCodeRepository extends JpaRepository<VerifyCode, Long> {
    public VerifyCode findByEmail(String email);
    public VerifyCode findByCode(String code);
    public boolean existsByEmail(String email);
    public void deleteByEmail(String email);
}

6. VerifyCodeService

@Service
@Transactional
@AllArgsConstructor
public class VerifyCodeService {

    private final VerifyCodeRepository repository;

    ...

    public VerifyCode saveCode(VerifyCodeDto code){
        if(repository.existsByEmail(code.getEmail()))
            repository.deleteByEmail(code.getEmail());
        return repository.save(new VerifyCode(code));
    }
    ...
}

(이메일만 들어있는) VerifyCodeDto를 받아서

인증 코드가 발급되어있는 이메일인지 확인한다.

발급되어 있다면, 그 인증코드는 삭제한다.

그리고 여튼 받은 이메일로 new VerifyCode를 만들어서 새 인증 코드를 생성해준다.

 

7. MailService

@Service
@RequiredArgsConstructor
public class MailService {

    private final JavaMailSender javaMailSender;
    private final PasswordEncoder passwordEncoder;

    public boolean checkEmail(VerifyCode verifyCode){

        if(verifyCode.getCode() == null)
            return false;

        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        simpleMailMessage.setTo(verifyCode.getEmail());
        simpleMailMessage.setSubject("Captured-Moment 이메일 확인 코드");
        simpleMailMessage.setText("저희 서비스에 가입해 주셔서 감사합니다.\n"
        + "이메일 확인 코드는 " + verifyCode.getCode() + " 입니다.");

        javaMailSender.send(simpleMailMessage);
        return true;
    }
    ...
}

JavaMailSender를 사용한다.

To, Subject(제목), 보낼 Text를 설정한다.

내용은 저 코드와 같이 설정한다.

 

8. 테스트

두근...❤ 진짜 와있다

 

 

9. 컨트롤러

다음은 입력받은 코드가 이 이메일과 맞는 코드인지 확인하는 컨트롤러다.

    @GetMapping(value = "/user/check")
    public ResponseEntity<HashMap> mailCheck(@RequestBody VerifyCode verifyCode){

        boolean check = verifyCodeService.check(verifyCode);
        HashMap<String, Object> responseMap = new HashMap<>();

        if(check){
            verifyCodeService.deleteByEmail(verifyCode.getEmail());
            responseMap.put("status", 200);
            responseMap.put("message", "인증 성공");
            return new ResponseEntity<HashMap> (responseMap, HttpStatus.OK);
        }
        else{
            responseMap.put("status", 401);
            responseMap.put("message", "잘못된 인증 코드");
            return new ResponseEntity<HashMap> (responseMap, HttpStatus.CONFLICT);
        }
    }

맞는지 체크하고 맞다면 인증성공, 틀리다면 인증 코드가 틀렸다는 메세지가 나온다.

또한 인증이 성공한다면 해당 인증코드는 지워버린다. 더 이상 쓸모가 없기 때문이다.

 

10. VerifyCodeService

@Service
@Transactional
@AllArgsConstructor
public class VerifyCodeService {

    private final VerifyCodeRepository repository;

    public boolean check(VerifyCode code){
        VerifyCode findCode = repository.findByEmail(code.getEmail());
        if(findCode == null)
            return false;
        else if(code.getCode().equals(findCode.getCode()))
            return true;
        else
            return false;
    }
    
    public void deleteByEmail(String email){
        repository.deleteByEmail(email);
    }
}

입력된 이메일로 해당하는 코드/이메일 세트 (VerifyCode)를 찾아온다.

찾아오지 못했으면 false를 리턴한다.

입력된 코드와 찾은 코드가 같으면 true를 리턴한다.

둘다 아니면 false를 리턴한다.

 

11. 테스트

잘못된거 입력하면 인증 안되고, 한번 더 send해도 인증 안된다.(지워버려서) 끝!