Flowable源码注释（三十三）定时器事件处理器

最新推荐文章于 2025-07-07 17:34:27 发布

翻译最新推荐文章于 2025-07-07 17:34:27 发布 · 1k 阅读

5 ·

CC 4.0 BY-SA版权

原文链接：https://github.com/flowable/flowable-engine

文章标签：

#flowable #源码注释

Flowable源码注释专栏收录该内容

74 篇文章

订阅专栏

本文深入探讨Flowable引擎中TimerEventHandler的实现，它作为定时器事件处理器，负责处理流程中的定时任务。通过分析源码，了解其工作原理和流程控制。

Flowable源码地址：https://github.com/flowable/flowable-engine

Flowable-6.7.2 源码注释地址：https://github.com/solojin/flowable-6.7.2-annotated

包路径：org.flowable.engine.impl.jobexecutor

TimerEventHandler 定时器事件处理器

/**
 * 定时器事件处理器
 */
public class TimerEventHandler {

    // 限定固定名称，定时器活动ID的属性名称
    public static final String PROPERTYNAME_TIMER_ACTIVITY_ID = "activityId";
    // 限定固定名称，截止日期表达式的属性名称
    public static final String PROPERTYNAME_END_DATE_EXPRESSION = "timerEndDate";
    // 限定固定名称，日程表名称的属性名称
    public static final String PROPERTYNAME_CALENDAR_NAME_EXPRESSION = "calendarName";

    // 创建配置
    public static String createConfiguration(String id, String endDate, String calendarName) {
        // 实际是从命令上下文中获取到流程引擎配置
        ObjectNode cfgJson = createObjectNode();

        // 重设流程引擎配置中的，定时器活动ID、截止日期表达式、日程表名称
        cfgJson.put(PROPERTYNAME_TIMER_ACTIVITY_ID, id);
        if (endDate != null) {
            cfgJson.put(PROPERTYNAME_END_DATE_EXPRESSION, endDate);
        }
        if (calendarName != null) {
            cfgJson.put(PROPERTYNAME_CALENDAR_NAME_EXPRESSION, calendarName);
        }
        return cfgJson.toString();
    }

    // 给配置器设置活动ID
    public static String setActivityIdToConfiguration(String jobHandlerConfiguration, String activityId) {
        try {
            ObjectNode cfgJson = readJsonValueAsObjectNode(jobHandlerConfiguration);
            cfgJson.put(PROPERTYNAME_TIMER_ACTIVITY_ID, activityId);
            return cfgJson.toString();
        } catch (IOException ex) {
            return jobHandlerConfiguration;
        }
    }

    // 从配置器获取活动ID
    public static String getActivityIdFromConfiguration(String jobHandlerConfiguration) {
        try {
            JsonNode cfgJson = readJsonValue(jobHandlerConfiguration);
            JsonNode activityIdNode = cfgJson.get(PROPERTYNAME_TIMER_ACTIVITY_ID);
            if (activityIdNode != null) {
                return activityIdNode.asText();
            } else {
                return jobHandlerConfiguration;
            }
            
        } catch (IOException ex) {
            return jobHandlerConfiguration;
        }
    }

    // 从配置器获取日程表名称
    public static String getCalendarNameFromConfiguration(String jobHandlerConfiguration) {
        try {
            JsonNode cfgJson = readJsonValue(jobHandlerConfiguration);
            JsonNode calendarNameNode = cfgJson.get(PROPERTYNAME_CALENDAR_NAME_EXPRESSION);
            if (calendarNameNode != null) {
                return calendarNameNode.asText();
            } else {
                return "";
            }
            
        } catch (IOException ex) {
            // 未指定日程表名称
            return "";
        }
    }

    // 给配置器设置截止时间
    public static String setEndDateToConfiguration(String jobHandlerConfiguration, String endDate) {
        ObjectNode cfgJson = null;
        try {
            cfgJson = readJsonValueAsObjectNode(jobHandlerConfiguration);
        } catch (IOException ex) {
            // 创建json配置
            cfgJson = createObjectNode();
            cfgJson.put(PROPERTYNAME_TIMER_ACTIVITY_ID, jobHandlerConfiguration);
        }
        
        if (endDate != null) {
            cfgJson.put(PROPERTYNAME_END_DATE_EXPRESSION, endDate);
        }

        return cfgJson.toString();
    }

    // 从配置器获取截止日期
    public static String getEndDateFromConfiguration(String jobHandlerConfiguration) {
        try {
            JsonNode cfgJson = readJsonValue(jobHandlerConfiguration);
            JsonNode endDateNode = cfgJson.get(PROPERTYNAME_END_DATE_EXPRESSION);
            if (endDateNode != null) {
                return endDateNode.asText();
            } else {
                return null;
            }
            
        } catch (IOException ex) {
            return null;
        }
    }

    // 创建对象节点
    protected static ObjectNode createObjectNode() {
        // 从命令上下文工具类中获取流程引擎配置类
        return CommandContextUtil.getProcessEngineConfiguration().getObjectMapper().createObjectNode();
    }

    // 读取JSON值，转换为对象节点
    protected static ObjectNode readJsonValueAsObjectNode(String config) throws IOException {
        return (ObjectNode) readJsonValue(config);
    }

    // 读取JSON值
    protected static JsonNode readJsonValue(String config) throws IOException {
        // 避免空指针错误
        if (CommandContextUtil.getCommandContext() != null) {
            return CommandContextUtil.getProcessEngineConfiguration().getObjectMapper().readTree(config);
        } else {
            return new ObjectMapper().readTree(config);
        }
    }

}