Spring Boot支持Crontab任务改造的方法

在以往的 Tomcat 项目中,一直习惯用 Ant 打包,使用 build.xml 配置,通过 ant -buildfile 的方式在机器上执行定时任务。虽然 Spring 本身支持定时任务,但都是服务一直运行时支持。其实在项目中,大多数定时任务,还是借助 Linux Crontab 来支持,需要时运行即可,不需要一直占用机器资源。但 Spring Boot 项目或者普通的 jar 项目,就没这么方便了。

Spring Boot 提供了类似 CommandLineRunner 的方式,很好的执行常驻任务;也可以借助 ApplicationListener 和 ContextRefreshedEvent 等事件来做很多事情。借助该容器事件,一样可以做到类似 Ant 运行的方式来运行定时任务,当然需要做一些项目改动。

1. 监听目标对象

借助容器刷新事件来监听目标对象即可,可以认为,定时任务其实每次只是执行一种操作而已。

比如这是一个写好的例子,注意不要直接用 @Service 将其放入容器中,除非容器本身没有其它自动运行的事件。

package com.github.zhgxun.learn.common.task;

import com.github.zhgxun.learn.common.task.annotation.ScheduleTask;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * 不自动加入容器, 用于区分是否属于任务启动, 否则放入容器中, Spring 无法选择性执行
 * 需要根据特殊参数在启动时注入
 * 该监听器本身不能访问容器变量, 如果需要访问, 需要从上下文中获取对象实例后方可继续访问实例信息
 * 如果其它类中启动了多线程, 是无法接管异常抛出的, 需要子线程中正确处理退出操作
 * 该监听器最好不用直接做线程操作, 子类的实现不干预
 */
@Slf4j
public class TaskApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
  /**
   * 任务启动监听类标识, 启动时注入
   * 即是 java -Dspring.task.class=com.github.zhgxun.learn.task.TestTask -jar learn.jar
   */
  private static final String SPRING_TASK_CLASS = "spring.task.class";

  /**
   * 支持该注解的方法个数, 目前仅一个
   * 可以理解为控制台一次执行一个类, 依赖的任务应该通过其它方式控制依赖
   */
  private static final int SUPPORT_METHOD_COUNT = 1;

  /**
   * 保存当前容器运行上下文
   */
  private ApplicationContext context;

  /**
   * 监听容器刷新事件
   *
   * @param event 容器刷新事件
   */
  @Override
  @SuppressWarnings("unchecked")
  public void onApplicationEvent(ContextRefreshedEvent event) {
    context = event.getApplicationContext();
    // 不存在时可能为正常的容器启动运行, 无需关心
    String taskClass = System.getProperty(SPRING_TASK_CLASS);
    log.info("ScheduleTask spring task Class: {}", taskClass);
    if (taskClass != null) {
      try {
        // 获取类字节码文件
        Class clazz = findClass(taskClass);

        // 尝试从内容上下文中获取已加载的目标类对象实例, 这个类实例是已经加载到容器内的对象实例, 即可以获取类的信息
        Object object = context.getBean(clazz);

        Method method = findMethod(object);

        log.info("start to run task Class: {}, Method: {}", taskClass, method.getName());
        invoke(method, object);
      } catch (ClassNotFoundException | IllegalAccessException | InvocationTargetException e) {
        e.printStackTrace();
      } finally {
        // 需要确保容器正常出发停止事件, 否则容器会僵尸卡死
        shutdown();
      }
    }
  }

  /**
   * 根据class路径名称查找类文件
   *
   * @param clazz 类名称
   * @return 类对象
   * @throws ClassNotFoundException ClassNotFoundException
   */
  private Class findClass(String clazz) throws ClassNotFoundException {
    return Class.forName(clazz);
  }

  /**
   * 获取目标对象中符合条件的方法
   *
   * @param object 目标对象实例
   * @return 符合条件的方法
   */
  private Method findMethod(Object object) {
    Method[] methods = object.getClass().getDeclaredMethods();
    List<Method> schedules = Stream.of(methods)
        .filter(method -> method.isAnnotationPresent(ScheduleTask.class))
        .collect(Collectors.toList());
    if (schedules.size() != SUPPORT_METHOD_COUNT) {
      throw new IllegalStateException("only one method should be annotated with @ScheduleTask, but found "
          + schedules.size());
    }
    return schedules.get(0);
  }

  /**
   * 执行目标对象方法
   *
   * @param method 目标方法
   * @param object 目标对象实例
   * @throws IllegalAccessException  IllegalAccessException
   * @throws InvocationTargetException InvocationTargetException
   */
  private void invoke(Method method, Object object) throws IllegalAccessException, InvocationTargetException {
    method.invoke(object);
  }

  /**
   * 执行完毕退出运行容器, 并将返回值交给执行环节, 比如控制台等
   */
  private void shutdown() {
    log.info("shutdown ...");
    System.exit(SpringApplication.exit(context));
  }
}

其实该处仅需要启动执行即可,容器启动完毕事件也是可以的。

2. 标识目标方法

目标方法的标识,最方便的是使用注解标注。

package com.github.zhgxun.learn.common.task.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface ScheduleTask {
}

3. 编写任务

package com.github.zhgxun.learn.task;

import com.github.zhgxun.learn.common.task.annotation.ScheduleTask;
import com.github.zhgxun.learn.service.first.LaunchInfoService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.concurrent.TimeUnit;

@Service
@Slf4j
public class TestTask {

  @Autowired
  private LaunchInfoService launchInfoService;

  @ScheduleTask
  public void test() {
    log.info("Start task ...");
    log.info("LaunchInfoList: {}", launchInfoService.findAll());

    log.info("模拟启动线程操作");
    for (int i = 0; i < 5; i++) {
      new MyTask(i).start();
    }

    try {
      TimeUnit.SECONDS.sleep(3);
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }
}

class MyTask extends Thread {
  private int i;
  private int j;
  private String s;

  public MyTask(int i) {
    this.i = i;
  }

  @Override
  public void run() {
    super.run();
    System.out.println("第 " + i + " 个线程启动..." + Thread.currentThread().getName());
    if (i == 2) {
      throw new RuntimeException("模拟运行时异常");
    }
    if (i == 3) {
      // 除数不为0
      int a = i / j;
    }
    // 未对字符串对象赋值, 获取长度报空指针错误
    if (i == 4) {
      System.out.println(s.length());
    }
  }
}

4. 启动改造

启动时需要做一些调整,即跟普通的启动区分开。这也是为什么不要把监听目标对象直接放入容器中的原因,在这里显示添加到容器中,这样就不影响项目中类似 CommandLineRunner 的功能,毕竟这种功能是容器启动完毕就能运行的。如果要改造,会涉及到很多硬编码。

package com.github.zhgxun.learn;

import com.github.zhgxun.learn.common.task.TaskApplicationListener;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;

@SpringBootApplication
public class LearnApplication {

  public static void main(String[] args) {
    SpringApplicationBuilder builder = new SpringApplicationBuilder(LearnApplication.class);
    // 根据启动注入参数判断是否为任务动作即可, 否则不干预启动
    if (System.getProperty("spring.task.class") != null) {
      builder.listeners(new TaskApplicationListener()).run(args);
    } else {
      builder.run(args);
    }
  }
}

5. 启动注入

-Dspring.task.class 即是启动注入标识,当然这个标识不要跟默认的参数混淆,需要区分开,否则可能始终获取到系统参数,而无法获取用户参数。

java -Dspring.task.class=com.github.zhgxun.learn.task.TestTask -jar target/learn.jar

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • Spring Boot支持Crontab任务改造的方法

    在以往的 Tomcat 项目中,一直习惯用 Ant 打包,使用 build.xml 配置,通过 ant -buildfile 的方式在机器上执行定时任务.虽然 Spring 本身支持定时任务,但都是服务一直运行时支持.其实在项目中,大多数定时任务,还是借助 Linux Crontab 来支持,需要时运行即可,不需要一直占用机器资源.但 Spring Boot 项目或者普通的 jar 项目,就没这么方便了. Spring Boot 提供了类似 CommandLineRunner 的方式,很好的执行

  • Spring Boot集成MyBatis访问数据库的方法

    基于spring boot开发的微服务应用,与MyBatis如何集成? 集成方法 可行的方法有: 1.基于XML或者Java Config,构建必需的对象,配置MyBatis. 2.使用MyBatis官方提供的组件,实现MyBatis的集成. 方法一 建议参考如下文章,完成集成的验证. MyBatis学习 之 一.MyBatis简介与配置MyBatis+Spring+MySql 基于Spring + Spring MVC + Mybatis 高性能web构建 spring与mybatis三种整合

  • Spring Boot使用Druid和监控配置方法

    Spring Boot默认的数据源是:org.apache.tomcat.jdbc.pool.DataSource Druid是Java语言中最好的数据库连接池,并且能够提供强大的监控和扩展功能. 下面来说明如何在 Spring Boot 中配置使用Druid (1)添加Maven依赖 (或jar包)\ <dependency> <groupId>com.alibaba</groupId> <artifactId>druid</artifactId&g

  • 移动开发Spring Boot外置tomcat教程及解决方法

    springboot微服务内置了tomcat,在工程目录下执行:mvn clean package,可以将项目打成jar,通过java -jar jar包名.jar启动项目. 有哪些场景需要将springboot打成war包去部署呢? 1.一个tomcat管理多个项目 2.springboot整合jsp等 解决方法: 1.<packaging>jar</packaging>中的jar改成war 2.引入依赖: <dependency> <groupid>or

  • Spring Boot中使用MongoDB数据库的方法

    MongoDB数据库简介 简介 MongoDB是一个高性能,开源,无模式的,基于分布式文件存储的文档型数据库,由C++语言编写,其名称来源取自"humongous",是一种开源的文档数据库──NoSql数据库的一种.NoSql,全称是 Not Only Sql,指的是非关系型的数据库. 特点 MongoDB数据库的特点是高性能.易部署.易使用,存储数据非常方便.主要功能特性有: * 面向集合存储,易存储对象类型的数据. * 模式自由. * 支持动态查询. * 支持完全索引,包含内部对象

  • Spring Boot 中使用cache缓存的方法

    一.什么是缓存 Cache Cache 一词最早来自于CPU设计 当CPU要读取一个数据时,首先从CPU缓存中查找,找到就立即读取并送给CPU处理:没有找到,就从速率相对较慢的内存中读取并送给CPU处理,同时把这个数据所在的数据块调入缓存中,可以使得以后对整块数据的读取都从缓存中进行,不必再调用内存.正是这样的读取机制使CPU读取缓存的命中率非常高(大多数CPU可达90%左右),也就是说CPU下一次要读取的数据90%都在CPU缓存中,只有大约10%需要从内存读取.这大大节省了CPU直接读取内存的

  • Spring Boot 2.0多数据源配置方法实例详解

    两个数据库实例,一个负责读,一个负责写. datasource-reader: type: com.alibaba.druid.pool.DruidDataSource url: jdbc:mysql://192.168.43.61:3306/test?useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false username: icbc password: icbc driver-class-na

  • 在Spring Boot中实现HTTP缓存的方法

    缓存是HTTP协议的一个强大功能,但由于某些原因,它主要用于静态资源,如图像,CSS样式表或JavaScript文件,但是,HTTP缓存不仅限于这些,还可以将其用于动态计算的资源. 通过少量工作,您可以加快应用程序并改善整体用户体验.在本文中,您将学习 如何使用内置的HTTP响应缓存机制来实现缓存SpringBoot控制器的结果 . 1.如何以及何时使用HTTP响应缓存? 您可以在应用程序的多个层上进行缓存.数据库具有其缓存存储,Web客户端也在其需要重用的信息.HTTP协议负责网络通信.缓存机

  • Spring Boot+maven打war包的方法

    存在一个坑: 官网文档 指出以下前3步做法,但是这样只可以打出可运行的jar包,要打出war包还要在文档后面的链接跳到另一个页面,才能找到第四步的做法,也就是最终能够打出war包,可能有些朋友有些粗心没找到第四步的链接,而以为只做了前三步就可以打出war包了,结果一直出错,还以为自己的业务代码有问题,然后一直瞎折腾,浪费很多时间(比如我),因此我把整个过程写于此. 1.指定war打包方式 <packaging>jar</packaging> 2.pom.xml添加spring-bo

  • Spring Boot实现模块化的几种方法

    一般情况下,一个SpringBoot应用 = 一个微服务 = 一个模块 = 一个有边界的上下文,如果有多个模块,我们就开发多个微服务,多个SpringBoot应用,然后使用Springcloud实现它们之间动态访问和监控. 但是有时我们也会希望将多个模块放入一个SpringBoot应用中,这样模块之间调用可以在一个JVM内进行,适合小型系统的部署,随着规模扩大,我们还可将这些模块变成一个个微服务,以SpringBoot应用分布式运行. SpringBoot为模块化提供了非常直接简单的组合方式,可

随机推荐