色综合久久天天综合网,蜜桃臀av一区二区三区,青娱乐av

Asp.net core Webapi 有沒有辦法執行定時任務呢？答案是有的

Asp.net core Webapi 如何執行定時任務？

前言

在計算機系統中，定時執行一些后臺任務是很常見的場景，比如定時發送郵件、備份數據等等。

那么，.NET 技術如何通過編程靈活地實現項目里復雜的自定義任務呢？

如果是 Windows 生態，通常來說，可以有這些方式：

編寫一個程序，通過 Windows 內置的任務計劃來定時執行。
編寫一個程序，通過 Windows 內置的 Services 來定時執行。
編寫一個定時循環執行任務的程序，在 Windows 系統啟動時配置為自動執行。
……

但是，如果是一個中小型的 Web 應用系統，這些方法方式就顯得不太合適。Asp.net core Webapi 有沒有辦法執行定時任務呢？答案是有的，Asp.net core Webapi 可以通過常駐后臺的托管服務來執行定時任務。

本文是 Asp.net core Webapi 運行一個常駐后臺并從數據庫中導出數據的托管服務的例子，寫出來供大家指點，在討論過程*同提高水平。

Step By Step 實現步驟

創建一個 asp.net core webapi 項目
從 Nuget 安裝以下包

Microsoft.AspNetCore.Identity.EntityFrameworkCore
Microsoft.EntityFrameworkCore.Relational
Microsoft.EntityFrameworkCore.SqlServer
Microsoft.EntityFrameworkCore.Tools

打開 appsettings.json 并添加數據庫連接字符串，如：

{
  "Logging": {
	"LogLevel": {
	  "Default": "Information",
	  "Microsoft.AspNetCore": "Warning"
	}
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
	"Default": "Server=(localdb)\\mssqllocaldb;Database=IdentityTestDB;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
}

添加一個繼承于 IdentityUser 的 User 類

using Microsoft.AspNetCore.Identity;

public class User: IdentityUser<long>
{
	public DateTime CreationTime { get; set; }
	public string? NickName { get; set; }
}

添加一個繼承于 IdentityRole 的 Role 類

using Microsoft.AspNetCore.Identity;

public class Role: IdentityRole<long>
{

}

創建數據庫上下文

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);
	}
}

創建一個 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();
	}
}

打開 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();
``