com.alogic.timer.core.Doer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alogic-doer Show documentation
后台执行器，定时器框架
There is a newer version: 1.6.17
package com.alogic.timer.core;

import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Element;

import com.anysoft.util.BaseException;
import com.anysoft.util.Configurable;
import com.anysoft.util.Properties;
import com.anysoft.util.Reportable;
import com.anysoft.util.XMLConfigurable;
import com.anysoft.util.XmlElementProperties;

/**
 * 任务执行者
 * 
 * @author duanyy
 * @since 1.6.3.37
 * 
 * @version 1.6.4.16 [duanyy 20151110] 

 * - 根据sonar建议优化代码 

 * 
 * @version 1.6.7.9 [20170201 duanyy] 

 * - 采用SLF4j日志框架输出日志 

 */
public interface Doer extends Configurable,XMLConfigurable,Runnable,Reportable{
	
	/**
	 * 状态
	 * 
	 * @author duanyy
	 *
	 */
	public enum State{
		/**
		 * 空闲
		 */
		IDLE,
		/**
		 * 工作中
		 */
		WORKING
	}
	
	/**
	 * 获取Doer状态
	 * @return 状态
	 */
	public State getState();
	
	/**
	 * 设置上下文持有者
	 * @param holder 持有者
	 */
	public void setContextHolder(ContextHolder holder);
	
	/**
	 * 获取上下文持有者
	 * @return holder
	 */
	public ContextHolder getContextHolder();
	
	/**
	 * 设置当前的任务
	 * @param task 任务
	 */
	public void setCurrentTask(Task task);
	
	/**
	 * 获取当前的任务
	 * @return 当前任务
	 */
	public Task getCurrentTask();
	
	/**
	 * 设置任务状态监听器
	 * @param listener 监听器
	 */
	public void setTaskStateListener(TaskStateListener listener);
	
	/**
	 * 执行
	 * @param task 待执行的任务
	 */
	public void execute(Task task);
	
	/**
	 * 完成任务
	 */
	public void complete();
	
	/**
	 * Abstract
	 * @author duanyy
	 *
	 */
	abstract public static class Abstract implements Doer {
		/**
		 * a logger of log4j
		 */
		protected static final Logger LOG = LoggerFactory.getLogger(Doer.class);
		/**
		 * 任务状态
		 */
		protected State state = State.IDLE;
		
		/**
		 * 上下文持有者
		 */
		private ContextHolder ctxHolder = null;
		
		/**
		 * 当前current
		 */
		private Task current = null;
		
		/**
		 * 状态监听器
		 */
		private TaskStateListener stateListener = null;
		
		@Override
		public void setContextHolder(ContextHolder holder) {
			ctxHolder = holder;
		}

		@Override
		public ContextHolder getContextHolder() {
			return ctxHolder;
		}

		@Override
		public void setCurrentTask(Task task) {
			current = task;
		}

		@Override
		public Task getCurrentTask() {
			return current;
		}

		@Override
		public void setTaskStateListener(TaskStateListener listener) {
			stateListener = listener;
		}
		

		public void reportState(Task.State state,int percent){
			if (stateListener != null){
				stateListener.reportState(current, state, percent);
			}
		}
		
		public void run(){
			Task task = getCurrentTask();
			try {
				if (task == null){
					LOG.error("Can not execute because the task is null.");
				}else{
					state = State.WORKING;
					execute(task);
				}
			}catch (Exception t){
				LOG.error("Exception when executing the task:" + task.id());
			}finally{
				complete();
			}
		}
		
		public void complete(){
			state = State.IDLE;
		}
		
		@Override
		public void report(Element xml) {
			if (xml != null){
				xml.setAttribute("module", getClass().getName());
				xml.setAttribute("state", state.name());
			}
		}

		@Override
		public void report(Map json) {
			if (json != null){
				json.put("module", getClass().getName());
				json.put("state", state.name());
			}
		}

		@Override
		public State getState() {
			return state;
		}

		@Override
		public void configure(Element _e, Properties _properties){
			Properties p = new XmlElementProperties(_e,_properties);
			configure(p);			
		}		
		
		@Override
		public void configure(Properties p) throws BaseException {
			// nothing to do
		}
	}

	/**
	 * Runnable包裹器
	 * 
	 * @author duanyy
	 *
	 */
	public static class Wrapper extends Abstract{
		private Runnable real = null;
		
		public Wrapper(Runnable runnable){
			real = runnable;
		}
		
		@Override
		public void configure(Properties p){
			// nothing to do
		}

		@Override
		public void execute(Task task) {
			if (real != null){
				real.run();
			}
		}
	}
	
	/**
	 * Quiet实现
	 * 
	 * 仅触发定时，具体逻辑有TaskComitter确定。
	 */
	public static class Quiet extends Abstract{
		@Override
		public void execute(Task task) {
			// nothing to do
		}
	}
}