feat(scheduler): add support for scheduler

common/util/pom.xml

@@ -43,5 +43,9 @@
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-collections4</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.quartz-scheduler</groupId>
+      <artifactId>quartz</artifactId>
+    </dependency>
   </dependencies>
 </project>

common/util/src/main/java/com/antgroup/openspg/common/util/DateTimeUtils.java

@@ -31,4 +31,17 @@ public static String bizDateByNow() {
     SimpleDateFormat simpleDateFormat = new SimpleDateFormat(YYYY_MM_DD1);
     return simpleDateFormat.format(new Date());
   }
+
+  /** Date to String by yyyy-MM-dd HH:mm:ss */
+  public static String getDate2LongStr(Date date) {
+    return getDate2Str(YYYY_MM_DD_HH_MM_SS1, date);
+  }
+
+  /** Date to String by format */
+  public static String getDate2Str(String format, Date date) {
+    if (date == null) {
+      return "";
+    }
+    return new SimpleDateFormat(format).format(date);
+  }
 }

common/util/src/main/java/com/antgroup/openspg/common/util/SchedulerUtils.java

@@ -0,0 +1,160 @@
+/*
+ * Copyright 2023 Ant Group CO., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied.
+ */
+package com.antgroup.openspg.common.util;
+
+import java.beans.BeanInfo;
+import java.beans.Introspector;
+import java.beans.PropertyDescriptor;
+import java.net.Inet4Address;
+import java.net.InetAddress;
+import java.net.NetworkInterface;
+import java.net.SocketException;
+import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.Calendar;
+import java.util.Collections;
+import java.util.Date;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.stream.Collectors;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.time.DateUtils;
+import org.quartz.CronExpression;
+
+/** some common tools */
+@Slf4j
+public class SchedulerUtils {
+
+  public static final String IPS = String.join(",", getLocalIps());
+  public static final String EQ = "eq";
+  public static final String IN = "in";
+  public static final String LT = "lt";
+
+  /** merge two bean by discovering differences */
+  public static <M> M merge(M dest, M orig) {
+    if (dest == null || orig == null) {
+      return (dest == null) ? orig : dest;
+    }
+    try {
+      BeanInfo beanInfo = Introspector.getBeanInfo(dest.getClass());
+      for (PropertyDescriptor descriptor : beanInfo.getPropertyDescriptors()) {
+        if (descriptor.getWriteMethod() == null) {
+          continue;
+        }
+        Object originalValue = descriptor.getReadMethod().invoke(orig);
+        if (originalValue == null) {
+          continue;
+        }
+        descriptor.getWriteMethod().invoke(dest, originalValue);
+      }
+    } catch (Exception e) {
+      log.error("merge bean exception", e);
+    }
+    return dest;
+  }
+
+  /** Limit remark. sub String To Length */
+  public static String setRemarkLimit(String oldRemark, StringBuffer appendRemark) {
+    Integer start = 0;
+    Integer length = 100000;
+    StringBuffer str = appendRemark.append(oldRemark);
+    String fill = "...";
+    if (length >= str.length()) {
+      return str.toString();
+    }
+    return str.substring(start, length - fill.length()) + fill;
+  }
+
+  /** get CronExpression */
+  public static CronExpression getCronExpression(String cron) {
+    try {
+      return new CronExpression(cron);
+    } catch (ParseException e) {
+      throw new RuntimeException("Cron ParseException:" + cron, e);
+    }
+  }
+
+  /** get Cron Execution Dates By Today */
+  public static List<Date> getCronExecutionDatesByToday(String cron) {
+    CronExpression expression = getCronExpression(cron);
+    List<Date> dates = new ArrayList<>();
+    Date startDate = DateUtils.truncate(new Date(), Calendar.DAY_OF_MONTH);
+    Date endDate = DateUtils.addDays(startDate, 1);
+
+    if (expression.isSatisfiedBy(startDate)) {
+      dates.add(startDate);
+    }
+    Date nextDate = expression.getNextValidTimeAfter(startDate);
+    while (nextDate != null && nextDate.before(endDate)) {
+      dates.add(nextDate);
+      nextDate = expression.getNextValidTimeAfter(nextDate);
+    }
+
+    return dates;
+  }
+
+  /** get Previous ValidTime */
+  public static Date getPreviousValidTime(String cron, Date date) {
+    CronExpression expression = getCronExpression(cron);
+    Date endDate = expression.getNextValidTimeAfter(expression.getNextValidTimeAfter(date));
+    Long time = 2 * date.getTime() - endDate.getTime();
+
+    Date nextDate = expression.getNextValidTimeAfter(new Date(time));
+    Date preDate = nextDate;
+    while (nextDate != null && nextDate.before(date)) {
+      preDate = nextDate;
+      nextDate = expression.getNextValidTimeAfter(nextDate);
+    }
+    return preDate;
+  }
+
+  /** get Unique Id */
+  public static String getUniqueId(Long jobId, Date schedulerDate) {
+    return jobId + DateTimeUtils.getDate2Str(DateTimeUtils.YYYY_MM_DD_HH_MM_SS2, schedulerDate);
+  }
+
+  /** content compare key */
+  public static boolean compare(Object content, Object key, String type) {
+    if (key == null) {
+      return true;
+    }
+    if (content == null) {
+      return false;
+    }
+    switch (type) {
+      case EQ:
+        return content.equals(key);
+      case IN:
+        return ((String) content).contains((String) key);
+      case LT:
+        return ((Date) key).before((Date) content);
+      default:
+        return false;
+    }
+  }
+
+  /** get local ips */
+  public static List<String> getLocalIps() {
+    try {
+      Enumeration<NetworkInterface> networkInterfaces = NetworkInterface.getNetworkInterfaces();
+      return Collections.list(networkInterfaces).stream()
+          .flatMap(network -> Collections.list(network.getInetAddresses()).stream())
+          .filter(address -> address instanceof Inet4Address && !address.isLoopbackAddress())
+          .map(InetAddress::getHostAddress)
+          .collect(Collectors.toList());
+    } catch (SocketException e) {
+      log.error("getLocalIps failed.", e);
+    }
+    return new ArrayList<>();
+  }
+}

pom.xml

@@ -303,6 +303,11 @@
         <artifactId>QLExpress</artifactId>
         <version>3.3.2</version>
       </dependency>
+      <dependency>
+        <groupId>org.quartz-scheduler</groupId>
+        <artifactId>quartz</artifactId>
+        <version>2.3.2</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

server/arks/sofaboot/src/main/resources/config/application-default.properties

@@ -47,3 +47,11 @@ cloudext.repository.impl.jdbc.port=3306
 cloudext.repository.impl.jdbc.username=root
 cloudext.repository.impl.jdbc.password=openspg
 cloudext.repository.impl.jdbc.driver=com.mysql.jdbc.Driver
+
+# Scheduler
+scheduler.handler.type=local
+scheduler.execute.instances.period=5
+scheduler.execute.instances.unit=MINUTES
+scheduler.generate.instances.period=1
+scheduler.generate.instances.unit=HOURS
+scheduler.execute.max.day=10

server/common/model/pom.xml

@@ -35,5 +35,9 @@
       <groupId>com.google.guava</groupId>
       <artifactId>guava</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+    </dependency>
   </dependencies>
 </project>

server/common/model/src/main/java/com/antgroup/openspg/server/common/model/exception/SchedulerException.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2023 Ant Group CO., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied.
+ */
+package com.antgroup.openspg.server.common.model.exception;
+
+/** Scheduler exception */
+public class SchedulerException extends OpenSPGException {
+
+  public SchedulerException(String message, Object... args) {
+    super(null, true, true, message, args);
+  }
+}

server/common/model/src/main/java/com/antgroup/openspg/server/common/model/scheduler/SchedulerEnum.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2023 Ant Group CO., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied.
+ */
+package com.antgroup.openspg.server.common.model.scheduler;
+
+/** all scheduler dependent enum */
+public interface SchedulerEnum {
+
+  /** Instance Status enum */
+  enum InstanceStatus {
+    WAITING,
+    RUNNING,
+    SKIP,
+    FINISH,
+    TERMINATE,
+    SET_FINISH;
+
+    /** status is Finished */
+    public static boolean isFinished(InstanceStatus status) {
+      return InstanceStatus.FINISH.equals(status)
+          || InstanceStatus.TERMINATE.equals(status)
+          || InstanceStatus.SET_FINISH.equals(status)
+          || InstanceStatus.SKIP.equals(status);
+    }
+  }
+
+  /** Life Cycle Enum */
+  enum LifeCycle {
+    PERIOD,
+    ONCE,
+    REAL_TIME
+  }
+
+  /** Dependence Enum */
+  enum Dependence {
+    DEPENDENT,
+    INDEPENDENT
+  }
+
+  /** Status Enum */
+  enum Status {
+    ENABLE,
+    DISABLE
+  }
+
+  /** Task Status Enum */
+  enum TaskStatus {
+    WAIT,
+    RUNNING,
+    FINISH,
+    ERROR,
+    SKIP,
+    TERMINATE,
+    SET_FINISH;
+
+    /** status is Finished by TaskStatus */
+    public static boolean isFinished(TaskStatus status) {
+      return TaskStatus.FINISH.equals(status)
+          || TaskStatus.SKIP.equals(status)
+          || TaskStatus.TERMINATE.equals(status)
+          || TaskStatus.SET_FINISH.equals(status);
+    }
+
+    /** status is Running by TaskStatus */
+    public static boolean isRunning(TaskStatus status) {
+      return TaskStatus.RUNNING.equals(status) || TaskStatus.ERROR.equals(status);
+    }
+  }
+
+  /** Translate Enum */
+  enum TranslateType {
+    LOCAL_EXAMPLE("localExampleTranslate");
+
+    private String type;
+
+    TranslateType(String type) {
+      this.type = type;
+    }
+
+    public String getType() {
+      return type;
+    }
+  }
+}

server/common/service/src/main/java/com/antgroup/openspg/server/common/service/spring/SpringContextHolder.java

@@ -41,6 +41,14 @@ public static <T> T getBean(Class<T> clazz) {
     return null;
   }
 
+  /** get spring bean by name */
+  public static <T> T getBean(String name, Class<T> clazz) {
+    if (applicationContext != null) {
+      return applicationContext.getBean(name, clazz);
+    }
+    return null;
+  }
+
   public static <T> List<T> getBeans(Class<T> clazz) {
     if (applicationContext != null) {
       return new ArrayList<>(applicationContext.getBeansOfType(clazz).values());

server/core/scheduler/model/pom.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2023 Ant Group CO., Ltd.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+  ~ in compliance with the License. You may obtain a copy of the License at
+  ~
+  ~ http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software distributed under the License
+  ~ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+  ~ or implied.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>com.antgroup.openspg.server</groupId>
+    <artifactId>server-parent</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+    <relativePath>../../../pom.xml</relativePath>
+  </parent>
+
+  <artifactId>core-scheduler-model</artifactId>
+  <dependencies>
+    <dependency>
+      <groupId>com.antgroup.openspg.server</groupId>
+      <artifactId>common-model</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.antgroup.openspg</groupId>
+      <artifactId>common-util</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.alibaba</groupId>
+      <artifactId>fastjson</artifactId>
+    </dependency>
+  </dependencies>
+</project>