update 定时任务计划相关

This commit is contained in:
2021-07-15 15:53:11 +08:00
parent 82460caf6a
commit 231e998277
14 changed files with 1452 additions and 346 deletions

View File

@@ -19,5 +19,6 @@ namespace Ewide.Core.Service
Task<bool> SetAsync(string key, object value);
Task<string> GetAsync(string key);
Task<T> GetAsync<T>(string key);
bool Exists(string cacheKey);
}
}

View File

@@ -174,5 +174,16 @@ namespace Ewide.Core.Service
{
await _cache.SetAsync(CommonConst.CACHE_AREA_CODE, areaCodes);
}
/// <summary>
/// 检查给定 key 是否存在
/// </summary>
/// <param name="cacheKey">键</param>
/// <returns></returns>
[NonAction]
public bool Exists(string cacheKey)
{
return _cache.Equals(cacheKey);
}
}
}

View File

@@ -1,4 +1,5 @@
using Furion.DataValidation;
using Furion.TaskScheduler;
using System;
using System.ComponentModel.DataAnnotations;
@@ -7,53 +8,44 @@ namespace Ewide.Core.Service
/// <summary>
/// 任务调度参数
/// </summary>
public class JobInput : PageInputBase
public class JobPageInput : PageInputBase
{
/// <summary>
/// 任务名称
/// </summary>
/// <example>ewide</example>
public string JobName { get; set; }
/// <summary>
/// 任务分组
/// 只执行一次
/// </summary>
/// <example>ewide</example>
public string JobGroup { get; set; }
public bool DoOnce { get; set; } = false;
/// <summary>
/// 开始时间
/// 立即执行(默认等待启动)
/// </summary>
public DateTime BeginTime { get; set; } = DateTime.Now;
public bool StartNow { get; set; } = false;
/// <summary>
/// 结束时间
/// 执行类型(并行、列队)
/// </summary>
/// <example>null</example>
public DateTime? EndTime { get; set; }
public SpareTimeExecuteTypes ExecuteType { get; set; }
/// <summary>
/// 执行间隔时间(单位秒)
/// </summary>
/// <example>5</example>
public int Interval { get; set; }
/// <summary>
/// Cron表达式
/// </summary>
/// <example></example>
public string Cron { get; set; }
/// <summary>
/// 执行次数(默认无限循环)
/// 定时器类型
/// </summary>
/// <example>10</example>
public int? RunNumber { get; set; }
/// <summary>
/// 执行间隔时间单位秒如果有Cron则IntervalSecond失效
/// </summary>
/// <example>5</example>
public int? Interval { get; set; }
/// <summary>
/// 触发器类型
/// </summary>
public TriggerTypeEnum TriggerType { get; set; } = TriggerTypeEnum.Simple;
public SpareTimeTypes TimerType { get; set; }
/// <summary>
/// 请求url
@@ -71,6 +63,152 @@ namespace Ewide.Core.Service
/// </summary>
public string Headers { get; set; }
/// <summary>
/// 请求类型
/// </summary>
public RequestTypeEnum RequestType { get; set; }
/// <summary>
/// 备注
/// </summary>
public string Remark { get; set; }
}
public class AddJobInput
{
/// <summary>
/// 任务名称
/// </summary>
public string JobName { get; set; }
/// <summary>
/// 只执行一次
/// </summary>
public bool DoOnce { get; set; } = false;
/// <summary>
/// 立即执行(默认等待启动)
/// </summary>
public bool StartNow { get; set; } = false;
/// <summary>
/// 执行类型(并行、列队)
/// </summary>
public SpareTimeExecuteTypes ExecuteType { get; set; }
/// <summary>
/// 执行间隔时间(单位秒)
/// </summary>
/// <example>5</example>
public int Interval { get; set; }
/// <summary>
/// Cron表达式
/// </summary>
public string Cron { get; set; }
/// <summary>
/// 定时器类型
/// </summary>
public SpareTimeTypes TimerType { get; set; }
/// <summary>
/// 请求url
/// </summary>
public string RequestUrl { get; set; }
/// <summary>
/// 请求参数PostPut请求用
/// </summary>
public string RequestParameters { get; set; }
/// <summary>
/// Headers(可以包含如Authorization授权认证)
/// 格式:{"Authorization":"userpassword.."}
/// </summary>
public string Headers { get; set; }
/// <summary>
/// 请求类型
/// </summary>
public RequestTypeEnum RequestType { get; set; }
/// <summary>
/// 备注
/// </summary>
public string Remark { get; set; }
}
public class StopJobInput
{
public string JobName { get; set; }
}
public class DeleteJobInput : QueryJobInput
{
}
public class UpdateJobInput : QueryJobInput
{
/// <summary>
/// 任务名称
/// </summary>
/// <example>dilon</example>
[Required, MaxLength(20)]
public string JobName { get; set; }
/// <summary>
/// 只执行一次
/// </summary>
public bool DoOnce { get; set; } = false;
/// <summary>
/// 立即执行(默认等待启动)
/// </summary>
public bool StartNow { get; set; } = false;
/// <summary>
/// 执行类型(并行、列队)
/// </summary>
public SpareTimeExecuteTypes ExecuteType { get; set; } = SpareTimeExecuteTypes.Parallel;
/// <summary>
/// 执行间隔时间(单位秒)
/// </summary>
/// <example>5</example>
public int? Interval { get; set; } = 5;
/// <summary>
/// Cron表达式
/// </summary>
/// <example></example>
[MaxLength(20)]
public string Cron { get; set; }
/// <summary>
/// 定时器类型
/// </summary>
public SpareTimeTypes TimerType { get; set; } = SpareTimeTypes.Interval;
/// <summary>
/// 请求url
/// </summary>
[MaxLength(200)]
public string RequestUrl { get; set; }
/// <summary>
/// 请求参数PostPut请求用
/// </summary>
public string RequestParameters { get; set; }
/// <summary>
/// Headers(可以包含如Authorization授权认证)
/// 格式:{"Authorization":"userpassword.."}
/// </summary>
public string Headers { get; set; }
/// <summary>
/// 请求类型
/// </summary>
@@ -78,32 +216,15 @@ namespace Ewide.Core.Service
public RequestTypeEnum RequestType { get; set; } = RequestTypeEnum.Post;
/// <summary>
/// 描述
/// 备注
/// </summary>
[MaxLength(100)]
public string Remark { get; set; }
/// <summary>
/// 任务状态
/// </summary>
public string DisplayState { get; set; }
}
public class DeleteJobInput : JobInput
public class QueryJobInput
{
/// <summary>
/// 任务Id
/// </summary>
[Required(ErrorMessage = "任务Id不能为空")]
[Required(ErrorMessage = "Id不能为空")]
public string Id { get; set; }
}
public class UpdateJobInput : DeleteJobInput
{
}
public class QueryJobInput : DeleteJobInput
{
}
}

View File

@@ -1,4 +1,5 @@
using Quartz;
using Furion.TaskScheduler;
using Quartz;
using System;
namespace Ewide.Core.Service
@@ -8,89 +9,142 @@ namespace Ewide.Core.Service
/// </summary>
public class JobOutput
{
/// <summary>
/// Id
/// </summary>
public string Id { get; set; }
/// <summary>
/// 已执行次数
/// </summary>
public long? RunNumber { get; set; }
/// <summary>
/// 定时器状态
/// </summary>
public SpareTimeStatus TimerStatus { get; set; } = SpareTimeStatus.Stopped;
/// <summary>
/// 异常信息
/// </summary>
public string Exception { get; set; }
/// <summary>
/// 任务名称
/// </summary>
public string JobName { get; set; }
/// <summary>
/// 任务组名
/// 只执行一次
/// </summary>
public string JobGroup { get; set; }
public bool DoOnce { get; set; } = false;
/// <summary>
/// 下次执行时间
/// 立即执行(默认等待启动)
/// </summary>
public DateTime? NextFireTime { get; set; }
public bool StartNow { get; set; } = false;
/// <summary>
/// 上次执行时间
/// 执行类型(并行、列队)
/// </summary>
public DateTime? PreviousFireTime { get; set; }
public SpareTimeExecuteTypes ExecuteType { get; set; }
/// <summary>
/// 开始时间
/// 执行间隔时间(单位秒)
/// </summary>
public DateTime BeginTime { get; set; }
public int Interval { get; set; }
/// <summary>
/// 结束时间
/// Cron表达式
/// </summary>
public DateTime? EndTime { get; set; }
public string Cron { get; set; }
/// <summary>
/// 上次执行的异常信息
/// 定时器类型
/// </summary>
public string LastErrMsg { get; set; }
public SpareTimeTypes TimerType { get; set; }
/// <summary>
/// 任务状态
/// </summary>
public TriggerState TriggerState { get; set; }
/// <summary>
/// 描述
/// </summary>
public string Remark { get; set; }
/// <summary>
/// 显示状态
/// </summary>
public string DisplayState
{
get
{
return TriggerState switch
{
TriggerState.Normal => "正常",
TriggerState.Paused => "暂停",
TriggerState.Complete => "完成",
TriggerState.Error => "异常",
TriggerState.Blocked => "阻塞",
TriggerState.None => "不存在",
_ => "未知",
};
}
}
/// <summary>
/// 时间间隔
/// </summary>
public string Interval { get; set; }
/// <summary>
/// 请求地址
/// 请求url
/// </summary>
public string RequestUrl { get; set; }
/// <summary>
/// 请求类型
/// </summary>
public string RequestType { get; set; }
/// <example>2</example>
public RequestTypeEnum RequestType { get; set; }
/// <summary>
/// 已经执行的次数
/// 备注
/// </summary>
public string RunNumber { get; set; }
public string Remark { get; set; }
}
/// <summary>
/// 任务方法信息
/// </summary>
public class TaskMethodInfo
{
/// <summary>
/// 方法名
/// </summary>
public string MethodName { get; set; }
/// <summary>
/// 方法所属类的Type对象
/// </summary>
public Type DeclaringType { get; set; }
/// <summary>
/// 任务名称
/// </summary>
public string JobName { get; set; }
/// <summary>
/// 只执行一次
/// </summary>
public bool DoOnce { get; set; } = false;
/// <summary>
/// 立即执行(默认等待启动)
/// </summary>
public bool StartNow { get; set; } = false;
/// <summary>
/// 执行类型(并行、列队)
/// </summary>
public SpareTimeExecuteTypes ExecuteType { get; set; }
/// <summary>
/// 执行间隔时间(单位秒)
/// </summary>
public int Interval { get; set; }
/// <summary>
/// Cron表达式
/// </summary>
public string Cron { get; set; }
/// <summary>
/// 定时器类型
/// </summary>
public SpareTimeTypes TimerType { get; set; }
/// <summary>
/// 请求url
/// </summary>
public string RequestUrl { get; set; }
/// <summary>
/// 请求类型
/// </summary>
/// <example>2</example>
public RequestTypeEnum RequestType { get; set; }
/// <summary>
/// 备注
/// </summary>
public string Remark { get; set; }
}
}

View File

@@ -1,16 +1,17 @@
using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Ewide.Core.Service
{
public interface ISysTimerService
{
Task AddJob(JobInput input);
Task DeleteJob(DeleteJobInput input);
Task<dynamic> GetJobPageList([FromQuery] JobInput input);
Task<dynamic> GetTimerPageList([FromQuery] JobPageInput input);
Task<dynamic> GetLocalJobList();
Task AddTimer(AddJobInput input);
Task DeleteTimer(DeleteJobInput input);
Task UpdateTimber(UpdateJobInput input);
Task<dynamic> GetTimer([FromQuery] QueryJobInput input);
Task StopScheduleJobAsync(JobInput input);
Task TriggerJobAsync(JobInput input);
Task UpdateJob(UpdateJobInput input);
Task<IEnumerable<TaskMethodInfo>> GetTaskMethods();
}
}

View File

@@ -1,12 +1,20 @@
using Furion.DatabaseAccessor;
using Ewide.Core.Extension;
using Furion;
using Furion.DatabaseAccessor;
using Furion.DatabaseAccessor.Extensions;
using Furion.DependencyInjection;
using Furion.DynamicApiController;
using Furion.FriendlyException;
using Furion.JsonSerialization;
using Furion.RemoteRequest.Extensions;
using Furion.TaskScheduler;
using Mapster;
using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;
namespace Ewide.Core.Service
@@ -18,12 +26,14 @@ namespace Ewide.Core.Service
public class SysTimerService : ISysTimerService, IDynamicApiController, IScoped
{
private readonly IRepository<SysTimer> _sysTimerRep; // 任务表仓储
private readonly SchedulerCenter _schedulerCenter;
private readonly ISysCacheService _cache;
public SysTimerService(IRepository<SysTimer> sysTimerRep, SchedulerCenter schedulerCenter)
//private readonly SchedulerCenter _schedulerCenter; //随框架更新已弃用
public SysTimerService(IRepository<SysTimer> sysTimerRep, ISysCacheService cache)
{
_sysTimerRep = sysTimerRep;
_schedulerCenter = schedulerCenter;
_cache = cache;
}
/// <summary>
@@ -32,21 +42,37 @@ namespace Ewide.Core.Service
/// <param name="input"></param>
/// <returns></returns>
[HttpPost("/sysTimers/page")]
public async Task<dynamic> GetJobPageList([FromBody] JobInput input)
public async Task<dynamic> GetTimerPageList([FromBody] JobPageInput input)
{
var jobList = await _schedulerCenter.GetJobList();
var workers = SpareTime.GetWorkers().ToList();
var jobName = !string.IsNullOrEmpty(input.JobName?.Trim());
var timers = await _sysTimerRep.DetachedEntities
.Where((jobName, u => EF.Functions.Like(u.JobName, $"%{input.JobName.Trim()}%")))
.Select(u => u.Adapt<JobInput>())
.ToPagedListAsync(input.PageIndex, input.PageSize);
.Where(!string.IsNullOrEmpty(input.JobName?.Trim()), u => EF.Functions.Like(u.JobName, $"%{input.JobName.Trim()}%"))
.Select(u => u.Adapt<JobOutput>())
.ToPagedListAsync(input.PageIndex, input.PageSize);
timers.Items.ToList().ForEach(u =>
{
u.DisplayState = jobList.Find(m => m.JobName == u.JobName)?.DisplayState;
var timer = workers.FirstOrDefault(m => m.WorkerName == u.JobName);
if (timer != null)
{
u.TimerStatus = timer.Status;
u.RunNumber = timer.Tally;
u.Exception = Newtonsoft.Json.JsonConvert.SerializeObject(timer.Exception);
}
});
return PageDataResult<JobInput>.PageResult(timers);
return PageDataResult<JobOutput>.PageResult(timers);
}
/// <summary>
/// 获取所有本地任务
/// </summary>
/// <returns></returns>
[HttpGet("/sysTimers/localJobList")]
public async Task<dynamic> GetLocalJobList()
{
// 获取本地所有任务方法
return await GetTaskMethods();
}
/// <summary>
@@ -55,7 +81,7 @@ namespace Ewide.Core.Service
/// <param name="input"></param>
/// <returns></returns>
[HttpPost("/sysTimers/add")]
public async Task AddJob(JobInput input)
public async Task AddTimer(AddJobInput input)
{
var isExist = await _sysTimerRep.AnyAsync(u => u.JobName == input.JobName, false);
if (isExist)
@@ -64,8 +90,8 @@ namespace Ewide.Core.Service
var timer = input.Adapt<SysTimer>();
await _sysTimerRep.InsertAsync(timer);
// 添加到调度
await _schedulerCenter.AddScheduleJobAsync(input);
// 添加到任务调度
AddTimerJob(input);
}
/// <summary>
@@ -74,7 +100,7 @@ namespace Ewide.Core.Service
/// <param name="input"></param>
/// <returns></returns>
[HttpPost("/sysTimers/delete")]
public async Task DeleteJob(DeleteJobInput input)
public async Task DeleteTimer(DeleteJobInput input)
{
var timer = await _sysTimerRep.FirstOrDefaultAsync(u => u.Id == input.Id);
if (timer == null)
@@ -82,8 +108,8 @@ namespace Ewide.Core.Service
await timer.DeleteAsync();
// 从调度器里删除
await _schedulerCenter.DeleteScheduleJobAsync(input);
// 从调度器里取消
SpareTime.Cancel(timer.JobName);
}
/// <summary>
@@ -92,21 +118,21 @@ namespace Ewide.Core.Service
/// <param name="input"></param>
/// <returns></returns>
[HttpPost("/sysTimers/edit")]
public async Task UpdateJob(UpdateJobInput input)
public async Task UpdateTimber(UpdateJobInput input)
{
// 排除自己并且判断与其他是否相同
var isExist = await _sysTimerRep.AnyAsync(u => u.JobName == input.JobName && u.Id != input.Id, false);
if (isExist) throw Oops.Oh(ErrorCode.D1100);
// 先从调度器里取消
var oldTimer = await _sysTimerRep.FirstOrDefaultAsync(u => u.Id == input.Id, false);
SpareTime.Cancel(oldTimer.JobName);
var timer = input.Adapt<SysTimer>();
await timer.UpdateAsync(ignoreNullValues: true);
// 先从调度器里删除
var oldTimer = await _sysTimerRep.FirstOrDefaultAsync(u => u.Id == input.Id, false);
await _schedulerCenter.DeleteScheduleJobAsync(oldTimer.Adapt<DeleteJobInput>());
// 再加到调度里
await _schedulerCenter.AddScheduleJobAsync(timer.Adapt<JobInput>());
var addJobInput = input.Adapt<AddJobInput>();
// 再添加到任务调度里
AddTimerJob(addJobInput);
}
/// <summary>
@@ -126,9 +152,9 @@ namespace Ewide.Core.Service
/// <param name="input"></param>
/// <returns></returns>
[HttpPost("/sysTimers/stop")]
public async Task StopScheduleJobAsync(JobInput input)
public void StopTimerJob(StopJobInput input)
{
await _schedulerCenter.StopScheduleJobAsync(input);
SpareTime.Stop(input.JobName);
}
/// <summary>
@@ -137,9 +163,161 @@ namespace Ewide.Core.Service
/// <param name="input"></param>
/// <returns></returns>
[HttpPost("/sysTimers/start")]
public async Task TriggerJobAsync(JobInput input)
public void StartTimerJob(AddJobInput input)
{
await _schedulerCenter.TriggerJobAsync(input);
var timer = SpareTime.GetWorkers().ToList().Find(u => u.WorkerName == input.JobName);
if (timer == null)
//AddTimerJob(input);
throw Oops.Oh("启动失败:任务不存在");
// 如果 StartNow 为 flase , 执行 AddTimerJob 并不会启动任务
SpareTime.Start(input.JobName);
}
/// <summary>
/// 新增定时任务
/// </summary>
/// <param name="input"></param>
[NonAction]
public void AddTimerJob(AddJobInput input)
{
Action<SpareTimer, long> action = null;
switch (input.RequestType)
{
// 创建本地方法委托
case RequestTypeEnum.Run:
{
// 查询符合条件的任务方法
var taskMethod = GetTaskMethods()?.Result.FirstOrDefault(m => m.RequestUrl == input.RequestUrl);
if (taskMethod == null) break;
// 创建任务对象
var typeInstance = Activator.CreateInstance(taskMethod.DeclaringType);
// 创建委托
action = (Action<SpareTimer, long>)Delegate.CreateDelegate(typeof(Action<SpareTimer, long>), typeInstance, taskMethod.MethodName);
break;
}
// 创建网络任务委托
default:
{
action = async (_, _) =>
{
var requestUrl = input.RequestUrl.Trim();
requestUrl = requestUrl?.IndexOf("http") == 0 ? requestUrl : "http://" + requestUrl;
var requestParameters = input.RequestParameters;
var headersString = input.Headers;
var headers = string.IsNullOrEmpty(headersString)
? null
: JSON.Deserialize<Dictionary<string, string>>(headersString);
switch (input.RequestType)
{
case RequestTypeEnum.Get:
await requestUrl.SetHeaders(headers).GetAsync();
break;
case RequestTypeEnum.Post:
await requestUrl.SetHeaders(headers).SetQueries(requestParameters).PostAsync();
break;
case RequestTypeEnum.Put:
await requestUrl.SetHeaders(headers).SetQueries(requestParameters).PutAsync();
break;
case RequestTypeEnum.Delete:
await requestUrl.SetHeaders(headers).DeleteAsync();
break;
}
};
break;
}
}
if (action == null) return;
// 缓存任务配置参数,以供任务运行时读取
if (input.RequestType == RequestTypeEnum.Run)
{
var jobParametersName = $"{input.JobName}_Parameters";
var jobParameters = _cache.Exists(jobParametersName);
var requestParametersIsNull = string.IsNullOrEmpty(input.RequestParameters);
// 如果没有任务配置却又存在缓存,则删除缓存
if (requestParametersIsNull && jobParameters)
_cache.DelAsync(jobParametersName);
else if (!requestParametersIsNull)
_cache.SetAsync(jobParametersName, JSON.Deserialize<Dictionary<string, string>>(input.RequestParameters));
}
// 创建定时任务
switch (input.TimerType)
{
case SpareTimeTypes.Interval:
if (input.DoOnce)
SpareTime.DoOnce(input.Interval * 1000, action, input.JobName, input.Remark, input.StartNow, executeType: input.ExecuteType);
else
SpareTime.Do(input.Interval * 1000, action, input.JobName, input.Remark, input.StartNow, executeType: input.ExecuteType);
break;
case SpareTimeTypes.Cron:
SpareTime.Do(input.Cron, action, input.JobName, input.Remark, input.StartNow, executeType: input.ExecuteType);
break;
}
}
/// <summary>
/// 启动自启动任务
/// </summary>
[NonAction]
public void StartTimerJob()
{
var sysTimerList = _sysTimerRep.DetachedEntities.Where(t => t.StartNow).Select(u => u.Adapt<AddJobInput>()).ToList();
sysTimerList.ForEach(AddTimerJob);
}
/// <summary>
/// 获取所有本地任务
/// </summary>
/// <returns></returns>
[NonAction]
public async Task<IEnumerable<TaskMethodInfo>> GetTaskMethods()
{
// 有缓存就返回缓存
var taskMethods = await _cache.GetAsync<IEnumerable<TaskMethodInfo>>(CommonConst.CACHE_KEY_TIMER_JOB);
if (taskMethods != null) return taskMethods;
// 获取所有本地任务方法必须有spareTimeAttribute特性
taskMethods = App.EffectiveTypes
.Where(u => u.IsClass && !u.IsInterface && !u.IsAbstract && typeof(ISpareTimeWorker).IsAssignableFrom(u))
.SelectMany(u => u.GetMethods(BindingFlags.Public | BindingFlags.Instance)
.Where(m => m.IsDefined(typeof(SpareTimeAttribute), false) &&
m.GetParameters().Length == 2 &&
m.GetParameters()[0].ParameterType == typeof(SpareTimer) &&
m.GetParameters()[1].ParameterType == typeof(long) && m.ReturnType == typeof(void))
.Select(m =>
{
// 默认获取第一条任务特性
var spareTimeAttribute = m.GetCustomAttribute<SpareTimeAttribute>();
return new TaskMethodInfo
{
JobName = spareTimeAttribute.WorkerName,
RequestUrl = $"{m.DeclaringType.Name}/{m.Name}",
Cron = spareTimeAttribute.CronExpression,
DoOnce = spareTimeAttribute.DoOnce,
ExecuteType = spareTimeAttribute.ExecuteType,
Interval = (int)spareTimeAttribute.Interval / 1000,
StartNow = spareTimeAttribute.StartNow,
RequestType = RequestTypeEnum.Run,
Remark = spareTimeAttribute.Description,
TimerType = string.IsNullOrEmpty(spareTimeAttribute.CronExpression) ? SpareTimeTypes.Interval : SpareTimeTypes.Cron,
MethodName = m.Name,
DeclaringType = m.DeclaringType
};
}));
await _cache.SetAsync(CommonConst.CACHE_KEY_TIMER_JOB, taskMethods);
return taskMethods;
}
}
}