SpringBoot自定義線程池,執(zhí)行定時(shí)任務(wù)方式

更新時(shí)間：2024年04月15日 09:34:34 作者：Hello！joy先生

這篇文章主要介紹了SpringBoot自定義線程池,執(zhí)行定時(shí)任務(wù)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

SpringBoot自定義線程池，執(zhí)行定時(shí)任務(wù)

在我們開(kāi)發(fā)過(guò)程中有很多場(chǎng)景需要定時(shí)執(zhí)行，接下來(lái)我們?cè)赟pringBoot中實(shí)現(xiàn)定時(shí)任務(wù)的功能。

一、幾個(gè)必要的注解

1、@EnableScheduling：在啟動(dòng)類上添加此注解，幫助我們開(kāi)啟定時(shí)任務(wù)。

2、@Scheduled：在實(shí)現(xiàn)接口上添加此注解，表示此接口需要定時(shí)調(diào)用執(zhí)行，這個(gè)注解的參數(shù)有不少，在文章最后展示，可以自己了解下。

3、@Component：在需要執(zhí)行定時(shí)任務(wù)的實(shí)現(xiàn)類上添加此注解。

4、@Configuration：自定義多線程使用

5、@EnableAsync：在自定義多線程配置類上添加

6、@Async：在執(zhí)行定時(shí)任務(wù)的方法上添加，表示使用自定義線程

二、單線程實(shí)現(xiàn)定時(shí)任務(wù)

單線程場(chǎng)景在實(shí)際開(kāi)發(fā)中并不多見(jiàn)，我們只用來(lái)測(cè)試

直接上代碼

1、啟動(dòng)類添加@EnableScheduling注解

@SpringBootApplication
@EnableScheduling
public class LogaopApplication {

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

}

2、在執(zhí)行定時(shí)任務(wù)的實(shí)現(xiàn)類添加@Component注解，在執(zhí)行定時(shí)任務(wù)的方法上添加@Scheduled注解

@Service
@Slf4j
@Component
public class ScheduTestServiceImpl implements ScheduTestService {

    @Autowired
    private ScheduJobDao scheduJobDao;

    @Scheduled(cron = "*/1 * * * * ?") // 一秒執(zhí)行一次
    @Override
    public void taskTest() throws InterruptedException {
        System.out.println("測(cè)試定時(shí)任務(wù)------");
    }

執(zhí)行結(jié)果

2023-09-16 11:17:17.978 INFO 4636 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'asyncServiceExecutor'
2023-09-16 11:17:18.183 INFO 4636 --- [ main] o.s.s.c.ThreadPoolTaskScheduler : Initializing ExecutorService 'taskScheduler'
2023-09-16 11:17:18.214 INFO 4636 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2023-09-16 11:17:18.230 INFO 4636 --- [ main] com.qty.logaop.LogaopApplication : Started LogaopApplication in 1.98 seconds (JVM running for 2.555)
測(cè)試定時(shí)任務(wù)------
測(cè)試定時(shí)任務(wù)------
測(cè)試定時(shí)任務(wù)------
測(cè)試定時(shí)任務(wù)------
測(cè)試定時(shí)任務(wù)------
測(cè)試定時(shí)任務(wù)------
測(cè)試定時(shí)任務(wù)------

以上就是單線程執(zhí)行定時(shí)任務(wù)，接下來(lái)測(cè)試多線程定時(shí)任務(wù)。

三、自定義多線程執(zhí)行定時(shí)任務(wù)

因?yàn)閟pringboot默認(rèn)是提供單線程供我們使用，一旦有多個(gè)定時(shí)任務(wù)，當(dāng)某個(gè)任務(wù)被阻塞，那么其他定時(shí)任務(wù)也不會(huì)被執(zhí)行，所以，一般我們會(huì)自定義線程池來(lái)解決這個(gè)問(wèn)題

多個(gè)定時(shí)任務(wù)場(chǎng)景，某個(gè)阻塞情況演示

@Service
@Slf4j
@Component
public class ScheduTestServiceImpl implements ScheduTestService {

    @Autowired
    private ScheduJobDao scheduJobDao;

    @Scheduled(cron = "*/1 * * * * ?")
    @Override
    public void taskTest() throws InterruptedException {
        long timeStamp1 = System.currentTimeMillis();
        Thread.sleep(1000*10);
        System.out.println("測(cè)試定時(shí)任務(wù)1------");
        long timeStamp2 = System.currentTimeMillis();
        log.info("阻塞市時(shí)長(zhǎng)：{}",timeStamp2-timeStamp1);
    }
    @Scheduled(cron = "*/1 * * * * ?")
    @Override
    public void taskTest2() throws InterruptedException {
        System.out.println("測(cè)試定時(shí)任務(wù)2------");
    }

演示結(jié)果

2023-09-16 11:28:07.906 INFO 19692 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'asyncServiceExecutor'
2023-09-16 11:28:08.157 INFO 19692 --- [ main] o.s.s.c.ThreadPoolTaskScheduler : Initializing ExecutorService 'taskScheduler'
2023-09-16 11:28:08.189 INFO 19692 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2023-09-16 11:28:08.204 INFO 19692 --- [ main] com.qty.logaop.LogaopApplication : Started LogaopApplication in 1.903 seconds (JVM running for 2.457)
測(cè)試定時(shí)任務(wù)1------
2023-09-16 11:28:19.035 INFO 19692 --- [ scheduling-1] c.q.l.s.impl.ScheduTestServiceImpl : 阻塞市時(shí)長(zhǎng)：10015
測(cè)試定時(shí)任務(wù)2------
測(cè)試定時(shí)任務(wù)1------
2023-09-16 11:28:30.010 INFO 19692 --- [ scheduling-1] c.q.l.s.impl.ScheduTestServiceImpl : 阻塞市時(shí)長(zhǎng)：10001
測(cè)試定時(shí)任務(wù)2------

這樣就會(huì)造成很大的問(wèn)題，必須執(zhí)行完某個(gè)定時(shí)任務(wù)才會(huì)執(zhí)行下一個(gè)，所以我們需要自定義多線程解決這個(gè)問(wèn)題

1、線程池配置類

package com.qty.logaop.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;

@Configuration
@EnableAsync
public class ScheduThreadPool {
    @Value("${async.executor.thread.core_pool_size}")//從配置文件中獲取配置項(xiàng)
    private int corePoolSize;
    @Value("${async.executor.thread.max_pool_size}")
    private int maxPoolSize;
    @Value("${async.executor.thread.queue_capacity}")
    private int queueCapacity;
    @Value("${async.executor.thread.name.prefix}")
    private String namePrefix;

    /**
     * 自定義線程池配置類。
     * 不要命名為 taskScheduler，與spring框架的bean重名。
     * @return
     */
    @Bean(name = "asyncServiceExecutor")
    public Executor asyncServiceExecutor() {
        //阿里巴巴編程規(guī)范：線程池不允許使用 Executors 去創(chuàng)建，而是通過(guò) ThreadPoolExecutor 的方式，這樣的處理方式讓寫(xiě)的同學(xué)更加明確線程池的運(yùn)行規(guī)則，規(guī)避資源耗盡的風(fēng)險(xiǎn)。

        //SpringBoot項(xiàng)目，可使用Spring提供的對(duì) ThreadPoolExecutor 封裝的線程池 ThreadPoolTaskExecutor：
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//        ThreadPoolTaskExecutor executor = new MyThreadPoolTaskExecutor();//自定義ThreadPoolTaskExecutor，會(huì)打印線程池情況
        //配置核心線程數(shù)
        executor.setCorePoolSize(corePoolSize);
        //配置最大線程數(shù)
        executor.setMaxPoolSize(maxPoolSize);
        //配置隊(duì)列大小
        executor.setQueueCapacity(queueCapacity);
        //配置線程池中的線程的名稱前綴
        executor.setThreadNamePrefix(namePrefix);
        // rejection-policy：當(dāng)pool已經(jīng)達(dá)到max size的時(shí)候，如何處理新任務(wù)
        //     1、CallerRunsPolicy：不在新線程中執(zhí)行任務(wù)，而是由調(diào)用者所在的線程來(lái)執(zhí)行。
        //        "該策略既不會(huì)拋棄任務(wù)，也不會(huì)拋出異常，而是將任務(wù)回推到調(diào)用者。"顧名思義，在飽和的情況下，調(diào)用者會(huì)執(zhí)行該任務(wù)（而不是由多線程執(zhí)行）
        //     2、AbortPolicy：拒絕策略，直接拒絕拋出異常
        //     3、。。。
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        //執(zhí)行初始化
        executor.initialize();
        return executor;
    }

}

我們?cè)诜椒ㄉ咸砑覢Async注解后再看結(jié)果

    @Scheduled(cron = "*/10 * * * * ?")
    @Async("asyncServiceExecutor")
    @Override
    public void taskTest() throws InterruptedException {
        long timeStamp1 = System.currentTimeMillis();
        Thread.sleep(1000*100);
        System.out.println("測(cè)試定時(shí)任務(wù)1------");
        long timeStamp2 = System.currentTimeMillis();
        log.info("阻塞市時(shí)長(zhǎng)：{}",timeStamp2-timeStamp1);
    }
    @Scheduled(cron = "*/10 * * * * ?")
    @Async("asyncServiceExecutor")
    @Override
    public void taskTest2() throws InterruptedException {
        System.out.println("測(cè)試定時(shí)任務(wù)2------");
    }

演示結(jié)果

2023-09-16 11:43:25.065 INFO 11604 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2023-09-16 11:43:25.065 INFO 11604 --- [ main] com.qty.logaop.LogaopApplication : Started LogaopApplication in 1.909 seconds (JVM running for 2.561)
測(cè)試定時(shí)任務(wù)2------
測(cè)試定時(shí)任務(wù)2------
測(cè)試定時(shí)任務(wù)2------

即使定時(shí)任務(wù)1被阻塞，定時(shí)任務(wù)2會(huì)獲取到其他線程，繼續(xù)執(zhí)行的，這樣就可以解決多個(gè)定時(shí)任務(wù)的問(wèn)題了。

@Scheduled參數(shù)：

0 0 10,14,16 * * ? 每天上午10點(diǎn)，下午2點(diǎn)，4點(diǎn)每天上午10點(diǎn)，下午2點(diǎn)，4點(diǎn)
0 0/30 9-17 * * ? 朝九晚五工作時(shí)間內(nèi)每半小時(shí)
0 0 12 ? * WED 表示每個(gè)星期三中午12點(diǎn)
0 0 12 * * ? 每天中午12點(diǎn)觸發(fā)
0 15 10 ? * * 每天上午10:15觸發(fā)
0 15 10 * * ? 每天上午10:15觸發(fā)
0 15 10 * * ? * 每天上午10:15觸發(fā)
0 15 10 * * ? 2019 2019年的每天上午10:15觸發(fā)
0 * 14 * * ? 在每天下午2點(diǎn)到下午2:59期間的每1分鐘觸發(fā)
0 0/5 14 * * ? 在每天下午2點(diǎn)到下午2:55期間的每5分鐘觸發(fā)
0 0/5 14,18 * * ? 在每天下午2點(diǎn)到2:55期間和下午6點(diǎn)到6:55期間的每5分鐘觸發(fā)
0 0-5 14 * * ? 在每天下午2點(diǎn)到下午2:05期間的每1分鐘觸發(fā)
0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44觸發(fā)
0 15 10 ? * MON-FRI 周一至周五的上午10:15觸發(fā)
0 15 10 15 * ? 每月15日上午10:15觸發(fā)
0 15 10 L * ? 每月最后一日的上午10:15觸發(fā)
0 15 10 ? * 6L 每月的最后一個(gè)星期五上午10:15觸發(fā)
0 15 10 ? * 6L 2018-2019 2018年至2019年的每月的最后一個(gè)星期五上午10:15觸發(fā)
0 15 10 ? * 6#3 每月的第三個(gè)星期五上午10:15觸發(fā)