uncode-schedule

基于zookeeper的分布式任务调度组件，非常小巧，使用简单，只需要引入jar包，不需要单独部署服务端。确保所有任务在集群中不重复，不遗漏的执行。支持动态添加和删除任务。

功能概述

1. 基于zookeeper+spring task/quartz/uncode task的分布任务调度系统。
2. 确保每个任务在集群中不同节点上不重复的执行。
3. 单个任务节点故障时自动转移到其他任务节点继续执行。
4. 任务节点启动时必须保证zookeeper可用，任务节点运行期zookeeper集群不可用时任务节点保持可用前状态运行，zookeeper集群恢复正常运期。
5. 支持动态添加、修改和删除任务，支持任务暂停和重新启动。
6. 添加ip黑名单，过滤不需要执行任务的节点。
7. 后台管理和任务执行监控。
8. 支持spring-boot,支持单个任务运行多个实例（使用扩展后缀）。

说明：

• 单节点故障时需要业务保障数据完整性或幂等性

模块架构

Uncode-Schedule

编写Spring bean

 @Component	
 public class SimpleTask {
	private static int i = 0;
	
	public void print() {
		System.out.println("===========start!=========");
		System.out.println("I:"+i);i++;
		System.out.println("=========== end !=========");
	}
}

基于Spring Boot的配置

1 application.properties

uncode.schedule.zkConnect=127.0.0.1:2181
uncode.schedule.rootPath=/uncode/schedule
uncode.schedule.zkSessionTimeout=60000
uncode.schedule.zkUsername=ScheduleAdmin
uncode.schedule.zkPassword=password
uncode.schedule.ipBlackList[0]=127.0.0.2 #可选
uncode.schedule.ipBlackList[1]=127.0.0.3 #可选
uncode.schedule.quartzBean[0]=simpleTask #可选
uncode.schedule.quartzMethod[0]=print1 #可选
uncode.schedule.quartzCronExpression[0]=0/3 * * * * ? #可选
uncode.schedule.quartzBean[1]=simpleTask2 #可选
uncode.schedule.quartzMethod[1]=print12 #可选
uncode.schedule.quartzCronExpression[1]=0/5 * * * * ? #可选

2 启动类

@SpringBootApplication
@ComponentScan({"cn.uncode.schedule"})
@EnableScheduling
@ServletComponentScan
public class UncodeScheduleApplication {
	public static void main(String[] agrs){
		SpringApplication.run(UncodeScheduleApplication.class,agrs);
	}
}

xml配置

<!-- 分布式任务管理器 -->
<bean id="zkScheduleManager" class="cn.uncode.schedule.ZKScheduleManager"
	init-method="init">
	<property name="zkConfig">
		 <map>
			 <entry key="zkConnectString" value="127.0.0.1:2181" />
			 <entry key="rootPath" value="/uncode/schedule" />
			 <entry key="zkSessionTimeout" value="60000" />
			 <entry key="userName" value="ScheduleAdmin" />
			 <entry key="password" value="password" />
			 <entry key="isCheckParentPath" value="true" />
			 <entry key="ipBlacklist" value="127.0.0.2,127.0.0.3" />
		 </map>
	</property>
</bean>
 <!-- Spring定时器注解开关-->
 <task:scheduled-tasks scheduler="zkScheduleManager" />

使用API或后台添加任务

1 动态添加任务

ConsoleManager.addScheduleTask(TaskDefine taskDefine);

2 动态删除任务

ConsoleManager.delScheduleTask(TaskDefine taskDefine);

3 动态更新任务

ConsoleManager.updateScheduleTask(TaskDefine taskDefine);

4 查询任务列表

ConsoleManager.queryScheduleTask();

基于Spring Task的XML配置

XML方式

1 Spring bean

public class SimpleTask {
	private static int i = 0;
	
	public void print() {
		System.out.println("===========start!=========");
		System.out.println("I:"+i);i++;
		System.out.println("=========== end !=========");
	}
}

2 xml配置

<!-- 分布式任务管理器 -->
<bean id="zkScheduleManager" class="cn.uncode.schedule.ZKScheduleManager"
	init-method="init">
	<property name="zkConfig">
		 <map>
			 <entry key="zkConnectString" value="127.0.0.1:2181" />
			 <entry key="rootPath" value="/uncode/schedule" />
			 <entry key="zkSessionTimeout" value="60000" />
			 <entry key="userName" value="ScheduleAdmin" />
			 <entry key="password" value="password" />
			 <entry key="isCheckParentPath" value="true" />
			 <entry key="ipBlacklist" value="127.0.0.2,127.0.0.3" />
		 </map>
	</property>
</bean>
<!-- Spring bean配置 -->
<bean id="taskObj" class="cn.uncode.schedule.SimpleTask"/>
<!-- Spring task配置 -->
<task:scheduled-tasks scheduler="zkScheduleManager">
	<task:scheduled ref="taskObj" method="print" fixed-rate="5000"/>
</task:scheduled-tasks>

Annotation方式

1 Spring bean

@Component
public class SimpleTask {
	private static int i = 0;
	
	@Scheduled(fixedDelay = 1000) 
	public void print() {
		System.out.println("===========start!=========");
		System.out.println("I:"+i);i++;
		System.out.println("=========== end !=========");
	}
	
}

2 xml配置

<!-- 配置注解扫描 -->
 <context:annotation-config />
<!-- 自动扫描的包名 -->
 <context:component-scan base-package="cn.uncode.schedule" />
<!-- 分布式任务管理器 -->
<bean id="zkScheduleManager" class="cn.uncode.schedule.ZKScheduleManager"
	init-method="init">
	<property name="zkConfig">
		 <map>
			 <entry key="zkConnectString" value="127.0.0.1:2181" />
			 <entry key="rootPath" value="/uncode/schedule" />
			 <entry key="zkSessionTimeout" value="60000" />
			 <entry key="userName" value="ScheduleAdmin" />
			 <entry key="password" value="password" />
			 <entry key="isCheckParentPath" value="true" />
			 <entry key="ipBlacklist" value="127.0.0.2,127.0.0.3" />
		 </map>
	</property>
</bean>
<!-- Spring定时器注解开关-->
<task:annotation-driven scheduler="zkScheduleManager" />

基于Quartz的XML配置

注意：spring的MethodInvokingJobDetailFactoryBean改成cn.uncode.schedule.quartz.MethodInvokingJobDetailFactoryBean
<bean id="zkScheduleManager" class="cn.uncode.schedule.ZKScheduleManager"
		init-method="init">
	<property name="zkConfig">
		 <map>
			 <entry key="zkConnectString" value="183.131.76.147:2181" />
			 <entry key="rootPath" value="/uncode/schedule" />
			 <entry key="zkSessionTimeout" value="60000" />
			 <entry key="userName" value="ScheduleAdmin" />
			 <entry key="password" value="password" />
			 <entry key="autoRegisterTask" value="true" />
			 <entry key="ipBlacklist" value="127.0.0.2,127.0.0.3" />
		 </map>
	</property>
</bean>	
<bean id="taskObj" class="cn.uncode.schedule.SimpleTask"/>
<!-- 定义调用对象和调用对象的方法 -->
<bean id="jobtask" class="cn.uncode.schedule.quartz.MethodInvokingJobDetailFactoryBean">
	<!-- 调用的类 -->
	<property name="targetObject" ref="taskObj" />
	<!-- 调用类中的方法 -->
	<property name="targetMethod" value="print" />
</bean>
<!-- 定义触发时间 -->
<bean id="doTime" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
	<property name="jobDetail">
		<ref bean="jobtask"/>
	</property>
	<!-- cron表达式 -->
	<property name="cronExpression">
		<value>0/3 * * * * ?</value>
	</property>
</bean>
<!-- 总管理类 如果将lazy-init='false'那么容器启动就会执行调度程序 -->
<bean id="startQuertz" lazy-init="false" autowire="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
	<property name="triggers">
		<list>
			<ref bean="doTime"/>
		</list>
	</property>
</bean>

uncode-schedule示例

1 以main方法运行，类路径：cn.uncode.schedule.UncodeScheduleApplication

2 在文件目录下执行：mvn spring-boot:run

uncode-schedule管理后台

访问URL：项目名称/uncode/schedule，如果servlet3.x以下，请手动配置web.xml文件

<servlet>
 <servlet-name>UncodeSchedule</servlet-name>
 <servlet-class>cn.uncode.schedule.web.ManagerServlet</servlet-class>
</servlet>
<servlet-mapping>
 <servlet-name>UncodeSchedule</servlet-name>
 <url-pattern>/uncode/schedule</url-pattern>
</servlet-mapping>