Minimal API trong NET 6.0 với ứng dụng Send Email từ Hosted Service

Microsoft vừa phát hành Visual Studio 2022 bản Preview, khá là ngon, đi kèm với nó là .NET 6.0, rất nhiều tính năng mới, mạnh mẽ. Mình khá thích Minimal API của NET 6, nên mình muốn thông qua ví dụ nhỏ này, giới thiệu đến mọi người tính năng mà mình đánh giá khá hay của NET 6

Trong tutorial này, chúng ta sẽ giải quyết 1 case study thường gặp, đó là gửi email. Vậy có những vấn đề gì với case này ? Như chúng ta đã biết, việc gửi email chúng ta có thể làm bằng nhiều cách khác nhau, ví dụ : Gửi bằng STMP, Gửi bằng 3rd party...vv Cách nào cũng vậy, đều có độ trễ nhất định để delivery một email, và case study mình gặp như sau :

Có 1 task làm 1 công việc gì đó tầm 3~5s, sau đó gửi email
Vì task đó đã mất tầm 3~5s, mình nới tay cho hẳn 5s luôn, email gửi mất thêm tầm 1s ~ 2s (tính riêng request gửi, chưa tính effort xử lý template email như binding model...vv) => Độ trễ nếu dùng async - await cho những action trên sẽ là 5+2 = 7s, ít nhất là 7 giây cho 1 request API, nghe rất lậu Đó là chưa kể, nếu action gửi mail đó cần gửi cho nhiều người khác nhau, mỗi người 1 nội dung email khác nhau nữa, ko lẽ 2 * n với n là số email cần gửi ??? => Câu trả lời là ta có thể optimize request đó về 3~5s đúng theo cái task cần làm, còn việc await email ta có thể gửi xuống 1 Hosted Service để xử lý Hoặc mạnh dạn hơn, ta có thể gửi luôn cái Task 3~5s đó xuống 1 Hosted Service khác, và notify cho Client bằng SignalR, nhưng cái đó out scope của tutorial này ^^ Hẹn các bạn trong bài khác Vậy, phương án xử lý cho vấn đề trên, ta sẽ dùng Hosted Service, gửi mail thì mình dùng MailJet Service nhé Công cụ cần thiết cho bài tutorial này

Visual Studio 2012 Preview (Mình xài bản Enterprise)
MailJet Account (dùng để gửi email) - https://www.mailjet.com/ ====== Ok, bắt đầu thôi, tạo mới một dự án Chọn ASP.NET Core Web API

Tiếp theo, đặt tên cho project

Bỏ tick phần "Use controllers..." => Vì chúng ta muốn viết API gọn nhẹ như NODE.JS , sử dụng Minimal API

Mở Program.cs lên và nhìn code ví dụ của Microsoft, khá ngắn gọn cho endpoint GetWeatherForecast

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

var summaries = new[]
{
    "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
};

app.MapGet("/weatherforecast", () =>
{
    var forecast = Enumerable.Range(1, 5).Select(index =>
       new WeatherForecast
       (
           DateTime.Now.AddDays(index),
           Random.Shared.Next(-20, 55),
           summaries[Random.Shared.Next(summaries.Length)]
       ))
        .ToArray();
    return forecast;
})
.WithName("GetWeatherForecast");

app.Run();

internal record WeatherForecast(DateTime Date, int TemperatureC, string? Summary)
{
    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
}

Okay, bây giờ ta sẽ tạo một Class Library tên là "SendEmail.Core", và sẽ đặt code nghiệp vụ gửi Email tại đây Right click vào Solution -> Add -> New Project

Sau đó, chọn "Class Library", bấm Next

Đặt tên project là "SendEmail.Core"

Bây giờ Solution chúng ta sẽ có 2 project

Okay, trong SendEmail.Core, đầu tiên tạo Model cho Email

Nội dung của lớp EmailModel.cs

namespace SendEmail.Core.Common.EmailModel
{
    public class EmailModel
    {
        public string EmailAddress { get; set; } = String.Empty;
        public string Subject { get; set; } = String.Empty;
        public string Body { get; set; } = String.Empty;
        public IEnumerable<MyAttachment>? Attachments { get; set; }
    }
    public class MyAttachment
    {
        public string ContentType { get; set; } = String.Empty;
        public string Name { get; set; } = String.Empty;
        public byte[] Data { get; set; } = new byte[10];
    }
}

Tiếp theo, chúng ta sẽ tạo một abstract class là MailSender, trách nhiệm của nó là sẽ gửi email Nội dung file MailSender.cs

 public abstract class MailSender : IMailSender
    {
        
    }

Tạo interface để implement Nội dung file IMailSender.cs

using SendEmail.Core.Common.EmailModel;

namespace SendEmail.Core.Interfaces
{
    public interface IMailSender
    {
        Task SendEmail(string address, string subject, string text);
        Task SendEmail(EmailModel email);
    }
}

Sau đó, quay lại MailSender để implement interface, trước tiên, ta cần library của Mailjet để gửi email, add bằng Nuget Tại project "SendEmail.Core", right click vào Dependencies -> Manage Nuget Packages...

Chọn tab "Browser", gõ vào "Mailjet" Tiến hành cài đặt Mailjet.Api

Sau đó, quay lại MailSender.cs, khai báo function static để tạo mới Client gửi email

 using Mailjet.Client;
using SendEmail.Core.Interfaces;

namespace SendEmail.Core.Common.MailSender
{
    public abstract class MailSender : IMailSender
    {
        public static MailjetClient CreateMailJetV3Client()
        {
            return new MailjetClient("<API KEY>", "<SECRET KEY>");
        }
        protected abstract Task Send(EmailModel.EmailModel email);
        public Task SendEmail(string address, string subject, string text)
        {
            return SendEmail(new EmailModel.EmailModel { EmailAddress = address, Subject = subject, Body = text });
        }

        public Task SendEmail(EmailModel.EmailModel email)
        {
            return Send(email);
        }
    }
}

Chú ý : ApiKey và Secret Key các bạn tự điền vào, các bạn có thể get từ MailJet

Xong, việc tiếp theo, là chúng ta sẽ implement function virtual "Send" của lớp MailSender, vì chúng ta đang xài MailJet nên chúng ta sẽ implement cái action Send này theo kiểu Mailjet, sau này, nếu có thêm nhiều service cần hỗ trợ như :Send Grid, Custom SMTP...vv thì ta sẽ implement tiếp ^^

Tạo 1 lớp MailJetService.cs Chú ý: Vì trong class này có sử dụng JArray, JObject, nên các bạn cần cài thêm Newtonsoft.Json vào project **SendEmail.Core **tương tự cách cài **Mailjet.Client **nhé

Nội dung lớp MailjetService.cs

using Mailjet.Client;
using Newtonsoft.Json.Linq;
using SendEmail.Core.Interfaces;

namespace SendEmail.Core.Common.EmailProvider
{
    public class MailJetService : MailSender.MailSender, IMailSender
    {
        protected override async Task Send(EmailModel.EmailModel email)
        {
            try
            {
                JArray jArray = new JArray();
                JArray attachments = new JArray();
                if (email.Attachments != null && email.Attachments.Count() > 0)
                {

                    email.Attachments.ToList().ForEach(attachment =>
                    attachments.Add(
                        new JObject {
                            new JProperty("Content-type",attachment.ContentType),
                            new JProperty( "Filename",attachment.Name),
                            new JProperty("content",Convert.ToBase64String(attachment.Data))
                    }));
                }

                jArray.Add(new JObject {
                            {
                            "FromEmail",
                            "<your email configuration on MailJet>"
                            }, {
                            "FromName",
                            "<Your Name>"
                            }, {
                            "Recipients",
                            new JArray {
                                new JObject {
                                {
                                    "Email",
                                    email.EmailAddress
                                }, {
                                    "Name",
                                   email.EmailAddress
                                }
                                }
                            }
                            }, {
                            "Subject",
                            email.Subject
                            }, {
                            "Text-part",
                            email.Body
                            }, {
                            "Html-part",
                            email.Body
                            },  {
                            "Attachments",
                            attachments
                            }});

                var client = MailSender.MailSender.CreateMailJetV3Client();
                MailjetRequest request = new MailjetRequest
                {
                    Resource = Mailjet.Client.Resources.Send.Resource,
                }
                 .Property(Mailjet.Client.Resources.Send.Messages, jArray);

                var response = await client.PostAsync(request);
                Console.WriteLine(response.StatusCode);
            }
            catch (Exception ex)
            {
                throw new Exception(ex.Message);
            }
        }
    }
}

============================================== Phần trên là business gửi Email, bây giờ, ta sẽ tạo một HostedService để thực thi việc này trong background HostedService là một interface đến từ Microsoft.Extensions.Hosting , các bạn cũng cần cài nó từ Nuget Packages

Sau đó implement các method missing của interfaces

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using SendEmail.Core.Common.EmailModel;
using SendEmail.Core.Common.EmailProvider;
using SendEmail.Core.Interfaces;
using System.Threading.Tasks.Dataflow;

namespace SendEmail.Core.HostedService
{
    public class EmailHostedService : IHostedService, IDisposable
    {
        private Task? _sendTask;
        private CancellationTokenSource? _cancellationTokenSource;
        private readonly BufferBlock<EmailModel> _mailQueue;
        private readonly IServiceScopeFactory _serviceScopeFactory;
        private readonly IMailSender _mailSender;

        public EmailHostedService(IServiceScopeFactory serviceScopeFactory)
        {

            _mailSender = new MailJetService(); ;
            _serviceScopeFactory = serviceScopeFactory;
            _cancellationTokenSource = new CancellationTokenSource();
            _mailQueue = new BufferBlock<EmailModel>();
        }
        public void Dispose()
        {
            throw new NotImplementedException();
        }

        public Task StartAsync(CancellationToken cancellationToken)
        {
            throw new NotImplementedException();
        }

        public Task StopAsync(CancellationToken cancellationToken)
        {
            throw new NotImplementedException();
        }
    }
}

Tiến hành code cho các method này, đầu tiên, khi Dispose, chúng ta sẽ hủy các Task

  private void DestroyTask()
        {
            try
            {
                if (_cancellationTokenSource != null)
                {
                    _cancellationTokenSource.Cancel();
                    _cancellationTokenSource = null;
                }
                Console.WriteLine("[EMAIL HOSTED SERVICE] DESTROY SERVICE");
            }
            catch
            {

            }
        }
        public void Dispose()
        {
            DestroyTask(); throw new NotImplementedException();
        }

Khi khởi động Service, ta sẽ thực hiện viện lắng nghe action gửi mail thông qua BufferBlock

 private async Task BackgroundSendEmailAsync(CancellationToken token)
        {
            while (!token.IsCancellationRequested)
            {
                try
                {
                    var email = await _mailQueue.ReceiveAsync();
                    await _mailSender.SendEmail(email);
                }
                catch (OperationCanceledException)
                {
                    break;
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"[BACKGROUND EMAIL SERVICE] {ex.Message}", "EmailHostedService");
                }
                Console.WriteLine("[BACKGROUND EMAIL SERVICE] END SEND", "EmailHostedService");
            }
        }

        public Task StartAsync(CancellationToken cancellationToken)
        {
            _sendTask = BackgroundSendEmailAsync(_cancellationTokenSource!.Token);
            return Task.CompletedTask;
        }

Và kill task khi StopService

public async Task StopAsync(CancellationToken cancellationToken)
        {
            DestroyTask();
            await Task.WhenAny(_sendTask!, Task.Delay(Timeout.Infinite, cancellationToken));
        }

Cuối cùng, add function để gọi action gửi mail của Hosted Service từ các Controller khác

  public async Task SendEmailAsync(EmailModel emailWithAddress)
        {
            await _mailQueue.SendAsync(emailWithAddress);
            Console.WriteLine($"SEND {emailWithAddress.EmailAddress}");
        }

Okay, vậy là phần core gửi mail của chúng ta đã xong, quay lại project "SendEmail.WebAPI" để tích hợp thôi nào Xóa code mẫu của MS, tạo một code mới của chúng ta

app.MapGet("/test-email", () =>
{
    return Results.Ok();
})

Tiến hành inject HostedService Resolve error

Gọi Service đã được inject ở trong request

Xong ! Chạy và test thôi, request vào endpoint rất nhanh Background nhận lệnh và gửi email Và kết quả nhận đc

Vậy, chúng ta đã xử lý được việc transparent cái quá trình gửi Email với phía Client, bảo vệ được request time rất nhanh, ko phụ thuộc vào action SendEmail

Nhưng, có 1 số vấn đề chúng ta cần care:

Giả sử khi Email đang được Hosted Service xử lý nhưng chúng ta restart App, những email trong queue sẽ bị mất, không được gửi => thất lạc email
Những email gửi đến cho MailJet xử lý, gửi được hay không là do MailJet => Ta muốn lưu những email không gửi thành công để kiểm tra (k muốn dựa vào Dashboard của Mailjet), muốn thống kê riêng...vv ? ===> Đó là những vấn đề ta cần giải quyết, trong bài viết tiếp theo, mình sẽ trình bày giải pháp của mình, mong các bạn góp ý

Thân chào, chúc các bạn thành công !

How To Validate Email Using jQuery

Cơ chế xác thực JSON Web Token (JWT) hoạt động như thế nào?

Laravel 8 Custom Email Verification Tutorial

Nhận thông báo email mới theo cách lập trình viên

How to Send E-mail Using Queue in Laravel 7/8

6.5 Change Email User API Quiz App

Simplifying APIs with coroutines and Flow

API Rate Limiting là gì và một số thuật toán hay dùng

Goong Maps Tutorial 2: Creating Heatmaps with Goong Maps

Tại sao TẤT CẢ API không nhất quán?