Java实现定时任务

左手的ㄟ右手 2021-11-17 18:16 349阅读 0赞

## 一、普通Java项目实现定时任务 ##

### 1、Thread方式 ###

创建一个thread在while循环中重复运行，然后通过sleep方式控制每次循环的时间，实现简单的定时任务。

//设置时间间隔为1秒
    final long timeInterval = 1000;
    Runnable runnable = new Runnable() {
        public void run() {
            while(true) {  
                //具体的业务
                try{
                    Thread.sleep(timeInterval);
                } catch(Exception ex) {
                    ex.printStackTrace();
                }
            }
        }
    
    };
    
    //启动线程
    Thread thread = new Thread(runnable);
    thread.start();

### 2、Timer和TimerTask ###

在实现时，Timer用来调度任务，TimerTask则是在run()方法里实现具体业务，Timer实例可以调度多任务，它是线程安全的。相比于Thread方式，用Timer和TimerTask方式有如下好处：

*  当启动和取消任务时可以控制
 *  第一次执行任务时可以指定你想要的延迟时间

TimerTask task = new TimerTask() {
        @Override
        public void run() {
          //具体业务
        }
    };
        
    Timer timer = new Timer();
    long delay = 0;  //设置延迟时间
    long intevalPeriod = 1000;  //设置间隔时间
    
    timer.scheduleAtFixedRate(task, delay, intevalPeriod);

### 3、ScheduledExecutorService ###

最理想的实现定时任务的方法，相比于前两种方式有如下好处：

*  相比于Timer的单线程，它是通过线程池的方式来执行任务的
 *  可以很灵活的去设定第一次执行任务delay时间
 *  供了良好的约定，以便设定执行的时间间隔

Runnable runnable = new Runnable() {
        public void run() {
          //具体业务
        }
    };
    
    ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();
    service.scheduleAtFixedRate(runnable, 0, 1, TimeUnit.SECONDS);

### 4、实现javax.servlet.ServletContextListener接口 （方便） ###

通过实现接口里的两个方法和在web.xml中配置监听来实现定时任务。

@Service
    public class ScheduledTaskTest implements ServletContextListener {
    
        private ScheduledExecutorService service;
    
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent) {
    
            Runnable runnable = () -> {
                System.out.println("=======执行=======");
            };
            service = Executors.newSingleThreadScheduledExecutor();
            //此处指定10秒运行一次，可自行定义
            service.scheduleAtFixedRate(runnable, 0, 10, TimeUnit.SECONDS);
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent servletContextEvent) {
            System.out.println("========销毁========");
            service.shutdown();
        }
    
    }

web.xml中配置：

<listener>
        <listener-class>com.bk.ScheduledTaskTest</listener-class>
    </listener>

## 二、Spring项目实现定时任务（此方法支持mybatis的service注入） ##

### 1、如果是SpringBoot项目在启动类上添加注解，开启支持： ###

@SpringBootApplication
    @EnableScheduling
    public class MainApplication{
        public static void mian(String[] args){
            SpringApplication.run(MainApplication.class,args);
        }
    }

###      如果是普通spring项目则在spring-mvc.xml中添加配置： ###

<context:component-scan base-package="com.byzk" />
    
    
    <task:annotation-driven />

## 2、编写定时任务 ##

*  例每隔5秒执行一次

@Scheduled(fixedRate = 5000)  表示 每隔 5秒执行一次
    public void task1() {
        //具体业务
    }

### 3、@Scheduled注解参数详解 ###

***1、cron***

该参数接收一个cron表达式，cron表达式是一个字符串，字符串以5或6个空格隔开，分开共6或7个域，每一个域代表一个含义。

//表达式语法
    [秒] [分] [小时] [日] [月] [周] [年]

注：\[年\]不是必须的域，可以省略\[年\]，则一共6个域

<table style="width:500px;"> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>说明</th> 
   <th>必填</th> 
   <th>允许填写的值</th> 
   <th>允许的通配符</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>秒</td> 
   <td>是</td> 
   <td>0-59</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>分</td> 
   <td>是</td> 
   <td>0-59</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>时</td> 
   <td>是</td> 
   <td>0-23</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>日</td> 
   <td>是</td> 
   <td>1-31</td> 
   <td>, - * ? / L W</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>月</td> 
   <td>是</td> 
   <td>1-12 / JAN-DEC</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>周</td> 
   <td>是</td> 
   <td>1-7 or SUN-SAT</td> 
   <td>, - * ? / L #</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td>年</td> 
   <td>否</td> 
   <td>1970-2099</td> 
   <td>, - * /</td> 
  </tr> 
 </tbody> 
</table>

***通配符说明:***

*  \* 表示所有值。 例如:在分的字段上设置 \*,表示每一分钟都会触发。
 *  ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 \* ?
 *  \- 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
 *  , 表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
 *  / 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
 *  L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年\[leap\]), 在周字段上表示星期六，相当于”7”或”SAT”。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”
 *  W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“)。
 *  \# 序号(表示每月的第几个周几)，例如在周字段上设置”6\#3”表示在每月的第三个周六.注意如果指定”\#5”,正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了) ；小提示：’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发；周字段的设置，若使用英文字母是不区分大小写的，即MON与mon相同。

***示例：***

*  每隔5秒执行一次：\*/5 \* \* \* \* ?
 *  每隔1分钟执行一次：0 \*/1 \* \* \* ?
 *  每天23点执行一次：0 0 23 \* \* ?
 *  每天凌晨1点执行一次：0 0 1 \* \* ?
 *  每月1号凌晨1点执行一次：0 0 1 1 \* ?
 *  每月最后一天23点执行一次：0 0 23 L \* ?
 *  每周星期天凌晨1点实行一次：0 0 1 ? \* L
 *  在26分、29分、33分执行一次：0 26,29,33 \* \* \* ?
 *  每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 \* \* ?

***cron表达式支持占位符：***

*   配置文件：

time:
      cron: */5 * * * * *
      interval: 5

*  主程序：

@Scheduled(cron="${time.cron}")
        void task1() {
            //具体业务
        }
    
        @Scheduled(cron="*/${time.interval} * * * * *")
        void task2() {
            //具体业务
        }

***2、 zone***

时区，接收一个java.util.TimeZone。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

***3、fixedDelay***

上一次执行完毕时间点之后多长时间再执行。

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行

***4、fixedDelayString***

与 3. fixedDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

@Scheduled(fixedDelayString = "${time.fixedDelay}")

***5、fixedRate***

上一次开始执行时间点之后多长时间再执行。

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行

***6、fixedRateString***

与 5. fixedRate 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

***7、initialDelay***

第一次延迟多长时间后再执行。

//第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次
    @Scheduled(initialDelay=1000, fixedRate=5000)

***8、initialDelayString***

与 7. initiaDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

### \------扫码进群，怕你禁不住福利的诱惑------ ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE5MjEwMg_size_16_color_FFFFFF_t_70][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE5MjEwMg_size_16_color_FFFFFF_t_70]: /images/20211116/424f7aecd53c4a4aa6956acf91142710.png