前言

在计算机系统中,定时执行一些后台任务是很常见的场景,比如定时发送邮件、备份数据等等。

那么,.NET 技术如何通过编程灵活地实现项目里复杂的自定义任务呢?

如果是 Windows 生态,通常来说,可以有这些方式:

  1. 编写一个程序,通过 Windows 内置的任务计划来定时执行。
  2. 编写一个程序,通过 Windows 内置的 Services 来定时执行。
  3. 编写一个定时循环执行任务的程序,在 Windows 系统启动时配置为自动执行。

    ……

但是,如果是一个中小型的 Web 应用系统,这些方法方式就显得不太合适。Asp.net core Webapi 有没有办法执行定时任务呢?答案是有的,Asp.net core Webapi 可以通过常驻后台的托管服务来执行定时任务。

本文是 Asp.net core Webapi 运行一个常驻后台并从数据库中导出数据的托管服务的例子,写出来供大家指点,在讨论过程中共同提高水平。

Step By Step 实现步骤

  1. 创建一个 asp.net core webapi 项目
  2. 从 Nuget 安装以下包

    Microsoft.AspNetCore.Identity.EntityFrameworkCore

    Microsoft.EntityFrameworkCore.Relational

    Microsoft.EntityFrameworkCore.SqlServer

    Microsoft.EntityFrameworkCore.Tools

  3. 打开 appsettings.json 并添加数据库连接字符串,如:
    {
    "Logging": {
    "LogLevel": {
    "Default": "Information",
    "Microsoft.AspNetCore": "Warning"
    }
    },
    "AllowedHosts": "*",
    "ConnectionStrings": {
    "Default": "Server=(localdb)\\mssqllocaldb;Database=IdentityTestDB;Trusted_Connection=True;MultipleActiveResultSets=true"
    }
    }
  4. 添加一个继承于 IdentityUser 的 User 类
    using Microsoft.AspNetCore.Identity;
    
    public class User: IdentityUser<long>
    {
    public DateTime CreationTime { get; set; }
    public string? NickName { get; set; }
    }
  5. 添加一个继承于 IdentityRole 的 Role 类
    using Microsoft.AspNetCore.Identity;
    
    public class Role: IdentityRole<long>
    { }
  6. 创建数据库上下文
    using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
    using Microsoft.EntityFrameworkCore; public class TestDbContext: IdentityDbContext<User, Role, long>
    {
    public TestDbContext(DbContextOptions<TestDbContext> options):base(options)
    { } protected override void OnModelCreating(ModelBuilder builder)
    {
    base.OnModelCreating(builder);
    builder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
    }
    }
  7. 创建一个 ExplortStatisticBgService 类并继承 BackgroundService,这是托管服务类
    using Microsoft.EntityFrameworkCore;
    using System.Text; public class ExplortStatisticBgService : BackgroundService
    {
    private readonly TestDbContext ctx;
    private readonly ILogger<ExplortStatisticBgService> logger;
    private readonly IServiceScope serviceScope; /// <summary>
    /// 在构造方法注入IServiceScopeFactory服务,
    /// 用来创建IServiceScope对象,
    /// 这样就可以通过IServiceScope来创建短生命周期的服务了
    /// </summary>
    /// <param name="scopeFactory"></param>
    public ExplortStatisticBgService(IServiceScopeFactory scopeFactory)
    {
    this.serviceScope = scopeFactory.CreateScope();
    var sp = serviceScope.ServiceProvider;
    this.ctx = sp.GetRequiredService<TestDbContext>();
    this.logger = sp.GetRequiredService<ILogger<ExplortStatisticBgService>>();
    } protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
    // 用 while 循环实现服务常驻
    while (!stoppingToken.IsCancellationRequested)
    {
    // 用 try...catch 捕捉异常记录错误信息并避免方法退出
    try
    {
    // 这里实现每隔5秒从数据库中导出数据
    // 更复杂的配置可以用第三方开源的框架
    await DoExecuteAsync();
    await Task.Delay(5000);
    }
    catch (Exception ex)
    {
    logger.LogError(ex, "获取用户统计数据失败");
    await Task.Delay(1000);
    }
    }
    } private async Task DoExecuteAsync()
    {
    var items = ctx.Users.AsNoTracking().GroupBy(u => u.CreationTime.Date)
    .Select(e => new
    {
    Date = e.Key,
    Count = e.Count()
    });
    StringBuilder sb = new StringBuilder(1024);
    sb.AppendLine($"Date: {DateTime.Now}");
    foreach (var item in items)
    {
    sb.Append(item.Date).AppendLine($": {item.Count}");
    }
    await File.WriteAllTextAsync("d:/1.txt", sb.ToString());
    logger.LogInformation($"导出完成");
    } /// <summary>
    /// IServiceScope 需要释放
    /// 所以重写 Dispose 方法
    /// </summary>
    public override void Dispose()
    {
    base.Dispose();
    serviceScope.Dispose();
    }
    }
  8. 打开 Program.cs,注入托管服务等,看代码的注释
    using Microsoft.AspNetCore.Identity;
    using Microsoft.EntityFrameworkCore; var builder = WebApplication.CreateBuilder(args); // Add services to the container. builder.Services.AddControllers();
    // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen(); IServiceCollection services = builder.Services; // 注册托管服务
    services.AddHostedService<ExplortStatisticBgService>(); // 注入数据库上下文
    services.AddDbContext<TestDbContext>(options => {
    string connStr = builder.Configuration.GetConnectionString("Default")!;
    options.UseSqlServer(connStr);
    }); // 数据保护服务注入
    // ----数据保护提供了一个简单、基于非对称加密改进的加密API用于确保Web应用敏感数据的安全存储
    // ----不需要开发人员自行生成密钥,它会根据当前应用的运行环境,生成该应用独有的一个私钥
    services.AddDataProtection(); // 注入 Identity 框架的一些重要的基础配置
    // 如果没有这个,下面的注入 UserManager 等服务会有问题,程序无法编译
    services.AddIdentityCore<User>(options =>
    {
    options.Password.RequireDigit = false;
    options.Password.RequireLowercase = false;
    options.Password.RequireNonAlphanumeric = false;
    options.Password.RequireUppercase = false;
    options.Password.RequiredLength = 6;
    options.Tokens.PasswordResetTokenProvider = TokenOptions.DefaultEmailProvider;
    options.Tokens.EmailConfirmationTokenProvider = TokenOptions.DefaultEmailProvider;
    }); // 注入 UserManager、RoleManager 等Identity 框架服务
    var idBuilder = new IdentityBuilder(typeof(User), typeof(Role), services);
    idBuilder.AddEntityFrameworkStores<TestDbContext>()
    .AddDefaultTokenProviders()
    .AddRoleManager<RoleManager<Role>>()
    .AddUserManager<UserManager<User>>(); var app = builder.Build(); // Configure the HTTP request pipeline.
    if (app.Environment.IsDevelopment())
    {
    app.UseSwagger();
    app.UseSwaggerUI();
    } app.UseHttpsRedirection(); app.UseAuthorization(); app.MapControllers(); app.Run();
    ``
  9. Ctrl+F5 运行项目,不做任何操作,托管程序会自动导出数据

扩展

托管服务在后台运行,通过它可以实现在很多事情,比如:

  1. 监控消息队列,当有数据进入消息队列就处理。
  2. 再如每隔10s把A数据库中的数据同步到B数据库中
  3. ...... 等等

Asp.net core Webapi 如何执行定时任务?的更多相关文章

  1. ASP.Net Core WebApi几种版本控制对比

    版本控制的好处: (1)助于及时推出功能, 而不会破坏现有系统. (2)它还可以帮助为选定的客户提供额外的功能. API 版本控制可以采用不同的方式进行控制,方法如下: (1)在 URL 中追加版本或 ...

  2. ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

    引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...

  3. ASP.NET Core WebApi使用Swagger生成api

    引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...

  4. ASP.NET Core WebApi使用Swagger生成api说明文档

    1. Swagger是什么? Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件 ...

  5. asp.net core webapi 使用ef 对mysql进行增删改查,并生成Docker镜像构建容器运行

    1.构建运行mysql容器,添加数据库user 参考Docker创建运行多个mysql容器,地址 http://www.cnblogs.com/heyangyi/p/9288402.html 添加us ...

  6. Docker 为 ASP.NET Core WebApi 应用程序生成 Docker 映像,创建容器并运行

    1.使用VS2017新建ASP.NET Core WebApi项目 选择API启用Docker支持 2.为 ASP.NET Core WebApi 应用程序生成 Docker 映像,并创建容器运行 生 ...

  7. 【转】ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

    原文链接:https://www.cnblogs.com/yilezhu/p/9241261.html 引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必 ...

  8. ASP.NET CORE WEBAPI文件下载

    ASP.NET CORE WEBAPI文件下载 最近要使用ASP.NET CORE WEBAPI用来下载文件,使用的.NET CORE 3.1.考虑如下场景: 文件是程序生成的. 文件应该能兼容各种格 ...

  9. ionic + asp.net core webapi + keycloak实现前后端用户认证和自动生成客户端代码

    概述 本文使用ionic/angular开发网页前台,asp.net core webapi开发restful service,使用keycloak保护前台页面和后台服务,并且利用open api自动 ...

  10. 记一次使用Asp.Net Core WebApi 5.0+Dapper+Mysql+Redis+Docker的开发过程

    #前言 我可能有三年没怎么碰C#了,目前的工作是在全职搞前端,最近有时间抽空看了一下Asp.net Core,Core版本号都到了5.0了,也越来越好用了,下面将记录一下这几天以来使用Asp.Net ...

随机推荐

  1. torch-1 tensor & optim

    开个新坑, pytorch源码阅读-从python代码开始读起. torch/ 1.tensor.py 继承自torch._C._TensorBase , 包括各种操作,TODO:随后看cpp代码 _ ...

  2. prometheus 监控实战篇

    prometheus 监控 目录 prometheus 监控 1.上传tar包 2.解压到对应文件夹 3.配置开机自启动 4.配置Prometheus 5.black_exporter 监控网站状态 ...

  3. c语言代码练习12

    //计算1/1-1/2+1/3...-1/100的和#define _CRT_SECURE_NO_WARNINGS 1 #include <stdio.h> int main() { in ...

  4. Linux系列教程——Linux磁盘管理、Linux进程管理、Linux系统服务、 Linux计划任务

    @ 目录 1 Linux磁盘管理 1.磁盘的基本概念 1.什么是磁盘 2.磁盘的基本结构 3.磁盘的预备知识 1.磁盘的接口类型 2.磁盘的基本术语 3.磁盘在系统上的命名方式 4.磁盘基本分区Fdi ...

  5. Jmeter将响应数据的结果保存到本地的一个文件(xls和csv)

    打印excel和csv文件的区别?? 第一种:打印excel 第二种:打印csv文件 创建beanshell后置处理器  import org.json.*;import java.io.*; Str ...

  6. Android下音视频对讲演示程序(声学回音消除、噪音抑制、语音活动检测、自动增益控制、自适应抖动缓冲)(2023年07月13日更新)

    Android下音视频对讲演示程序 必读说明 简介   本软件根据<道德经>为核心思想而设计,实现了两个设备之间进行音视频对讲,一般可用于楼宇对讲.智能门铃对讲.企业员工对讲.智能对讲机. ...

  7. 小景的Dba之路--如何导出0记录表以及数据泵的使用

    小景最近在系统压测相关的工作,其中涉及了数据备份导出的操作.今天的问题是:exp命令不会导出0记录表,那么我们探讨下如何导出0记录表以及数据泵的使用. 首先,我们先刨析一下问题现象及原因: 在 Ora ...

  8. Java替换RequestBody和RequestParam参数的属性

    Java替换RequstBody和RequestParam参数的属性 本文主要讲解在Java环境中如何替换RequestBody和RequestParam参数中的属性 背景 近期由于接手的老项目中存在 ...

  9. Kurator v0.5.0发布,打造统一的多集群备份与存储体验

    本文分享自华为云社区<Kurator v0.5.0正式发布! 打造统一的多集群备份与存储体验>,作者: 云容器大未来 . Kurator 是由华为云推出的开源分布式云原生套件.面向分布式云 ...

  10. TypeScript学习小结:基础使用

    TypeScript学习小结:基础使用 某册子买了两年多了,到最近才开始学习TypeScript,拖延症的严重症状了:不过我还是深信人做一件事是需要一个契机的. 学完之后整体感受是:TypeScrip ...