elastic-job定时任务

本文主要是介绍elastic-job定时任务，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

静态任务案例

使用elastic-job很容易，我们接下来学习下elastic-job的使用，这里的案例我们先实现静态任务案例，静态任务案例也就是执行时间事先写好。

实现步骤：

1.引入依赖包
2.配置zookeeper节点以及任务名称命名空间
3.实现自定义任务，需要实现SimpleJob接口

1)在seckill-goods中引入依赖

<!-- ElasticJobAutoConfiguration自动配置类作用-->
<dependency><groupId>com.github.kuhn-he</groupId><artifactId>elastic-job-lite-spring-boot-starter</artifactId><version>2.1.5</version>
</dependency>

2)配置elastic-job

在bootstrap.yml中配置elastic-job，如下：

elaticjob:zookeeper:server-lists: zk-server:3181namespace: updatetask

讲解：
server-lists:zookeeper的地址
namespace：定时任务命名空间

这里我们只展示了部分常用的参数，还有很多参数，但不一定常用，大家可以参考下面地址学习：

3)任务创建

创建com.seckill.goods.task.statictask.ElasticjobTask，代码如下：

@ElasticSimpleJob(cron = "5/10 * * * * ?",jobName = "updateTask",shardingTotalCount = 1
)
@Component
public class ElasticjobTask implements SimpleJob {/**** 执行任务* @param shardingContext*/@Overridepublic void execute(ShardingContext shardingContext) {System.out.println("-----------执行！");}
}

讲解：

cron:定时表达式
jobName：这里和bootstrap.yml中的namespace保持一致
shardingTotalCount：分片数量

动态任务案例

参考地址：https://github.com/LuoLiangDSGA/spring-learning/tree/master/boot-elasticjob

动态任务案例主要是讲解程序在运行时，动态添加定时任务，这种场景应用非常广泛。使用elastic-job实现动态添加定时任务的实现有点复杂，我们接下来实际操作一次。

步骤：

1.配置初始化的zookeeper地址
2.配置的定时任务命名空间(不一定会使用)
3.注册初始化数据
4.监听器->任务执行前后监听（可有可无）
5.动态添加定时任务实现
6.自定义任务处理过程-实现SimpleJob

1)监听器创建

监听器采用AOP模式，类似前置通知和后置通知，doBeforeJobExecutedAtLastStarted和doAfterJobExecutedAtLastCompleted分别会在任务执行前和执行后调用，我们创建一个监听器实现任务调度前后拦截，com.seckill.goods.task.dynamic.ElasticJobListener:

public class ElasticJobListener extends AbstractDistributeOnceElasticJobListener {/***** 构造函数* @param startedTimeoutMilliseconds* @param completedTimeoutMilliseconds*/public ElasticJobListener(long startedTimeoutMilliseconds, long completedTimeoutMilliseconds) {super(startedTimeoutMilliseconds, completedTimeoutMilliseconds);}/**** 任务初始化前要做的事情，类似前置通知* @param shardingContexts*/@Overridepublic void doBeforeJobExecutedAtLastStarted(ShardingContexts shardingContexts) {System.out.println("========doBeforeJobExecutedAtLastStarted========"+ TimeUtil.date2FormatHHmmss(new Date()));}/**** 任务执行完成后要做的事情，类似后置通知* @param shardingContexts*/@Overridepublic void doAfterJobExecutedAtLastCompleted(ShardingContexts shardingContexts) {System.out.println("=======doAfterJobExecutedAtLastCompleted============="+ TimeUtil.date2FormatHHmmss(new Date()));}
}

2)注册中心配置

在bootstrap.yml中配置zk和namespace

#配置动态任务案例的zk和namespace

zk: zk-server:3181
namesp: autotask

创建配置类配置注册中心信息，com.seckill.goods.task.dynamic.ElasticJobConfig:

@Configuration
public class ElasticJobConfig {//配置文件中的zookeeper的ip和端口@Value(value = "${zk}")private String serverlists;//指定一个命名空间@Value("${namesp}")private String namespace;/**** 配置Zookeeper和namespace* @return*/@Beanpublic ZookeeperConfiguration zkConfig() {return new ZookeeperConfiguration(serverlists, namespace);}/**** 向zookeeper注册初始化信息* @param config* @return*/@Bean(initMethod = "init")public ZookeeperRegistryCenter regCenter(ZookeeperConfiguration config) {return new ZookeeperRegistryCenter(config);}/***** 创建ElasticJob的监听器实例* @return*/@Beanpublic ElasticJobListener elasticJobListener() {//初始化要给定超时多少秒重连return new ElasticJobListener(100L,100L);}
}

3)任务构建

我们创建一个动态配置任务的类，任何逻辑代码需要创建定时任务，可以直接调用该类的指定方法即可。创建类：com.seckill.goods.task.dynamic.ElasticJobHandler，代码如下：

@Component
public class ElasticJobHandler {@Resourceprivate ZookeeperRegistryCenter registryCenter;@Resourceprivate ElasticJobListener elasticJobListener;/*** @param jobName:任务的命名空间* @param jobClass:执行的定时任务对象* @param shardingTotalCount：分片个数* @param cron：定时周期表达式* @param id：自定义参数* @return*/private static LiteJobConfiguration.Builder simpleJobConfigBuilder(String jobName,Class<? extends SimpleJob> jobClass,int shardingTotalCount,String cron,String id) {//创建任务构建对象LiteJobConfiguration.Builder builder = LiteJobConfiguration.newBuilder(new SimpleJobConfiguration(JobCoreConfiguration.//任务命名空间名字、任务执行周期表达式、分片个数newBuilder(jobName, cron, shardingTotalCount).//自定义参数jobParameter(id).build(),jobClass.getCanonicalName()));//本地配置是否可覆盖注册中心配置builder.overwrite(true);return builder;}/*** 添加一个定时任务* @param cron:周期执行表达式* @param id:自定义参数* @param jobName:命名空间* @param instance:任务对象*/public void addPublishJob(String cron,String id,String jobName,SimpleJob instance) {LiteJobConfiguration jobConfig = simpleJobConfigBuilder(jobName,instance.getClass(),1,cron,id).overwrite(true).build();//DynamicTask为具体的任务执行逻辑类new SpringJobScheduler(instance, registryCenter, jobConfig, elasticJobListener).init();}/**** Date转cron表达式*/public static final String CRON_DATE_FORMAT = "ss mm HH dd MM ? yyyy";/*** 获得定时* @param date* @return*/public static String getCron(final Date date) {SimpleDateFormat simpleDateFormat = new SimpleDateFormat(CRON_DATE_FORMAT);return simpleDateFormat.format(date);}
}

4)执行逻辑

我们接着创建一个类，用于执行自己所需要操作的逻辑，com.seckill.goods.task.dynamic.DynamicTask，代码如下：

public class DynamicTask implements SimpleJob {@Overridepublic void execute(ShardingContext shardingContext) {//传递的参数String id = shardingContext.getJobParameter();try {//具体任务逻辑System.out.println("执行你的逻辑代码！param:"+id);} catch (Exception e) {e.printStackTrace();}}
}

5)调用测试

创建com.seckill.goods.controller.TaskController动态调用创建任务的方法，代码如下：

@RestController
@RequestMapping(value = "/task")
public class TaskController {@AutowiredElasticJobHandler elasticJobHandler;/**** 动态创建任务* @param times:延迟时间，为了测试到效果，所以在当前时间往后延迟* @param jobname:任务名字* @param param:自定义参数* @return*/@GetMappingpublic Result add(Long times,String jobname,String param){//在当前指定时间内延迟times毫秒执行任务Date date = new Date(System.currentTimeMillis()+times);//需要传递给定时任务的参数String cron = ElasticJobHandler.getCron(date);//执行任务elasticJobHandler.addPublishJob(cron,param,jobname,new DynamicTask());return new Result(true, StatusCode.OK,"添加任务成功！");}
}