Spring Boot Scheduler

김형준 Kim Hyeong Jun·2023년 2월 16일

0. 스케쥴러란?

특정 메소드에 @Scheduled 애노테이션을 선언하면 설정한 값에 따라 주기적(일정한 시간 간격, 혹은 특정 시간)으로 해다 메소드를 실행시킬 수 있다.

본인이 진행한 프로젝트에서는

당일을 기준으로 잡고

이전 날짜로 마감된 설문이 존재하면

마감된 설문의 작성자에게 알림 메일을 발송한다.

라는 계획을 가지고 메소드를 작성하였고, 일정 주기마다 해당 메소드가 실행될 수 있도록 스케쥴러에 대해서 알아보고 사용하였다.

1. 스케쥴러 사용

1️⃣ Application 클레스에 @EnableScheduling 애노테이션을 추가하면 스케쥴러 기능을 사용할 수 있다.

package com.formmaker.fff;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@EnableScheduling
@SpringBootApplication
public class FffApplication {

	public static void main(String[] args) {
		SpringApplication.run(FffApplication.class, args);
	}

}

2️⃣ 실제 스케쥴링 작업을 할 클래스를 만든다.
해당 클래스는 @Component 즉, 스프링 빈에 등록된 클래스여야 한다.

package com.formmaker.fff.mail.controller;

import com.formmaker.fff.mail.service.MailService;
import lombok.RequiredArgsConstructor;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.mail.MessagingException;
import java.io.UnsupportedEncodingException;

@RestController
@RequestMapping("/api/user")
@RequiredArgsConstructor
public class MailController {
    private final MailService mailService;

    @Scheduled(cron = "0 30 8 * * *")
    public void surveyFinishNotice() throws MessagingException, UnsupportedEncodingException {
        String msg = mailService.sendFinishMessage();
        log.info(msg);
    }
}