在C#中使用RabbitMQ做個簡單的傳送郵件小專案

在C#中使用RabbitMQ做個簡單的傳送郵件小專案

前言

好久沒有做專案了，這次做一個傳送郵件的小專案。發郵件是一個比較耗時的操作，之前在我的個人部落格裡面回覆評論和友鏈申請是會透過傳送郵件來通知對方的，不過當時只是簡單的進行了非同步操作。
那麼這次來使用RabbitMQ去統一傳送郵件，我的想法是透過呼叫郵件傳送介面，將請求傳送到佇列。然後在佇列中接收並執行郵件傳送操作。
本文采用簡單的點對點模式：

在點對點模式中，只會有一個消費者進行消費。

對於常用的RabbitMQ佇列模式不瞭解的可以檢視往期文章：

• .NET 中使用RabbitMQ初體驗 - 妙妙屋（zy） - 部落格園 (cnblogs.com) https://www.cnblogs.com/ZYPLJ/p/17572104.html
• ZY知識庫 · ZY - 在.NET Core中使用RabbitMQ (pljzy.top) https://pljzy.top/blog/post/fa670520e3df2839.html

架構圖

簡單描述下專案結構。專案主要分為生產者、RabbitMQ、消費者這3個物件。

• 生產者（Publisher）：負責將郵件傳送請求傳送到RabbitMQ的佇列中。
• RabbitMQ伺服器：作為訊息中介軟體，用於接收並儲存生產者傳送的訊息。
• 消費者（Consumer）：從RabbitMQ的佇列中接收郵件傳送請求，並執行實際的郵件傳送操作。

專案結構

• RabbitMQEmailProject
  • EamilApiProject 生產者
    • Controllers 控制器
    • Service 服務
  • RabiitMQClient 消費者
    • Program 主程式
  • Model 實體類

開始編碼(一階段)

首先我們先簡單的將生產者和消費者程式碼完成，讓生產者能夠傳送訊息，消費者能夠接受並處理訊息。程式碼有點多，不過註釋也多很容易看懂。
給生產者和消費者都安裝上用於處理RabiitMQ連線的Nuget包：

dotnet add package RabbitMQ.Client

生產者

EamilApiProject

配置檔案

appsetting.json

"RabbitMQ": {  
  "Hostname": "localhost",  
  "Port": "5672",  
  "Username": "guest",  
  "Password": "guest"  
}

控制器

[ApiController]  
[Route("[controller]")]  
public class SendEmailController : ControllerBase  
{  
    private readonly EmailService _emailService;  
  
    public SendEmailController(EmailService emailService)  
    {       
	     _emailService = emailService;  
    }  
    [HttpPost(Name = "SendEmail")]  
    public IActionResult Post([FromBody] EmailDto emailRequest)  
    {        
	    _emailService.SendEamil(emailRequest);  
        return Ok("郵件已傳送");  
    }
}

服務

RabbitMQ連線服務

public class RabbitMqConnectionFactory :IDisposable  
{  
    private readonly RabbitMqSettings _settings;  
    private IConnection _connection;  
  
    public RabbitMqConnectionFactory (IOptions<RabbitMqSettings> settings)  
    {       
	     _settings = settings.Value;  
    }  
    public IModel CreateChannel()  
    {        
    if (_connection == null || _connection.IsOpen == false)  
        {            
        var factory = new ConnectionFactory()  
            {  
                HostName = _settings.Hostname,  
                UserName = _settings.Username,  
                Password = _settings.Password  
            };  
            _connection = factory.CreateConnection();  
        }  
        return _connection.CreateModel();  
    }  
    public void Dispose()  
    {        
	    if (_connection != null)  
        {            
	        if (_connection.IsOpen)  
            {               
	             _connection.Close();  
            }            
            _connection.Dispose();  
        }    
    }
}

傳送郵件服務

public class EmailService
{
    private readonly RabbitMqConnectionFactory _connectionFactory;

    public EmailService(RabbitMqConnectionFactory connectionFactory)
    {
        _connectionFactory = connectionFactory;
    }
    public void SendEamil(EmailDto emailDto)
    {
        using var channel = _connectionFactory.CreateChannel();
        var properties = channel.CreateBasicProperties();
        properties.Persistent = true;//訊息持久化
        
        var message = JsonConvert.SerializeObject(emailDto);
        var body = Encoding.UTF8.GetBytes(message);

        channel.BasicPublish( string.Empty, "email_queue", properties, body);
    }
}

註冊服務

builder.Services.Configure<RabbitMqSettings>(builder.Configuration.GetSection("RabbitMQ"));
builder.Services.AddSingleton<RabbitMqConnectionFactory >();
builder.Services.AddTransient<EmailService>();

實體

Model

public class EmailDto  
{  
    /// <summary>  
    /// 郵箱地址  
    /// </summary>  
    public string Email { get; set; }  
    /// <summary>  
    /// 主題  
    /// </summary>  
    public string Subject { get; set; }  
    /// <summary>  
    /// 內容  
    /// </summary>  
    public string Body { get; set; }  
}

public class RabbitMqSettings  
{  
    public string Hostname { get; set; }  
    public string Port { get; set; }  
    public string Username { get; set; }  
    public string Password { get; set; }  
}

消費者

RabiitMQClient

static void Main(string[] args)  
{  
    var factory = new ConnectionFactory { HostName = "localhost", Port = 5672, UserName = "guest", Password = "guest" };  
    using var connection = factory.CreateConnection();  
    using var channel = connection.CreateModel();  
  
    channel.QueueDeclare(queue: "email_queue",  
        durable: true,//是否持久化  
        exclusive: false,//是否排他  
        autoDelete: false,//是否自動刪除  
        arguments: null);//引數  
  
    //這裡可以設定prefetchCount的值，表示一次從佇列中取多少條訊息，預設是1，可以根據需要設定  
    //這裡設定了prefetchCount為1，表示每次只取一條訊息，然後處理完後再確認收到，這樣可以保證訊息的順序性  
    //global是否全域性  
    channel.BasicQos(prefetchSize: 0, prefetchCount: 1, global: false);  
  
    Console.WriteLine(" [*] 正在等待訊息...");  
  
    //建立消費者  
    var consumer = new EventingBasicConsumer(channel);  
    //註冊事件處理方法  
    consumer.Received += (model, ea) =>  
    {  
        byte[] body = ea.Body.ToArray();  
        var message = Encoding.UTF8.GetString(body);  
        var email = JsonConvert.DeserializeObject<EmailDto>(message);  
        Console.WriteLine(" [x] 傳送郵件 {0}", email.Email);  
        //處理完訊息後，確認收到  
        //multiple是否批次確認  
        channel.BasicAck(deliveryTag: ea.DeliveryTag, multiple: false);  
    };    //開始消費  
    //queue佇列名  
    //autoAck是否自動確認，false表示手動確認  
    //consumer消費者  
    channel.BasicConsume(queue: "email_queue",  
        autoAck: false,  
        consumer: consumer);  
  
    Console.WriteLine(" 按任意鍵退出");  
    Console.ReadLine();  
}	

一階段測試效果

一階段就是消費者和生產者能正常執行。

可以看到生產者傳送郵件之後，消費者能夠正常消費請求。那麼開始二階段，將郵件傳送程式碼完成，並實現能夠透過佇列處理郵件傳送。
對於郵件傳送失敗就簡單的做下處理，相對較好的解決方案就是使用死信佇列，將傳送失敗的訊息放到死信佇列處理，我這裡就不用死信佇列，對於死信佇列感興趣的可以檢視往期文章：

• .NET中使用RabbitMQ延時佇列和死信佇列 - 妙妙屋（zy） - 部落格園 (cnblogs.com)
• ZY知識庫 · ZY - RabbitMQ延時佇列和死信佇列 (pljzy.top)

開始編碼(二階段)

簡單的建立一個用於傳送郵件的類，這裡使用MailKit庫傳送郵件。

public class EmailService  
{  
	private readonly SmtpClient client;  

	public EmailService(SmtpClient client)  
	{  
		this.client = client;  
	}  

	public async Task SendEmailAsync(string from, string to, string subject, string body)  
	{
		try
		{
			await client.ConnectAsync("smtp.163.com", 465, SecureSocketOptions.SslOnConnect); 
			// 認證  
			await client.AuthenticateAsync("zy1767992919@163.com", "");  

			// 建立一個郵件訊息  
			var message = new MimeMessage(); 
			message.From.Add(new MailboxAddress("發件人名稱", from));  
			message.To.Add(new MailboxAddress("收件人名稱", to));  
			message.Subject = subject;  

			// 設定郵件正文  
			message.Body = new TextPart("html")  
			{  
				Text = body  
			};  

			// 傳送郵件  
			var response =await client.SendAsync(message);  
			
			// 斷開連線  
			await client.DisconnectAsync(true);  
		}
		catch (Exception ex)
		{
			// 斷開連線  
			await client.DisconnectAsync(true);  
			throw new EmailServiceException("郵件傳送失敗", ex);  
		}
	}  
}  

public class EmailServiceFactory  
{  
	public EmailService CreateEmailService()  
	{  
		var client = new SmtpClient();  
		return new EmailService(client);  
	}  
}  
public class EmailServiceException : Exception  
{  
	public EmailServiceException(string message) : base(message)  
	{  
	}  

	public EmailServiceException(string message, Exception innerException) : base(message, innerException)  
	{  
	}  
}  

接下來我們在消費者中呼叫郵件傳送方法即可，如果不使用死信佇列，我們只需要在事件處理程式碼加上郵件傳送邏輯就行了。

consumer.Received += async (model, ea) =>
{
	byte[] body = ea.Body.ToArray();
	var message = Encoding.UTF8.GetString(body);
	
	var email = JsonConvert.DeserializeObject<EmailDto>(message);
	
	// 建立一個EmailServiceFactory例項
	var emailServiceFactory = new EmailServiceFactory();  
	  
	// 使用EmailServiceFactory建立一個EmailService例項  
	var emailService = emailServiceFactory.CreateEmailService();  
	  
	// 呼叫EmailService的SendEmailAsync方法來傳送電子郵件  
	string from = "zy1767992919@163.com"; // 發件人地址  
	string to = email.Email; // 收件人地址  
	string subject = email.Subject; // 郵件主題  
	string emailbody = email.Body; // 郵件正文  
	  
	try  
	{  
		await emailService.SendEmailAsync(from, to, subject, emailbody);  
		Console.WriteLine(" [x] 傳送郵件 {0}", email.Email);
	}  
	catch (Exception ex)  
	{  
		Console.WriteLine(" [x] 傳送郵件失敗 " + ex.Message);  
		//這裡可以記錄日誌
		//可以使用BasicNack方法，重新回到佇列，重新消費
	}  
	
	
	//處理完訊息後，確認收到
	//multiple是否批次確認
	channel.BasicAck(deliveryTag: ea.DeliveryTag, multiple: false);
};

在上面中可以將傳送失敗的郵件重新放佇列，多試幾次，這裡就不做多餘的介紹了。

完成效果展示

一封正確的郵件

ok，現在展示郵件傳送Demo的完整展示。
首先我們來寫一個正確的郵箱地址進行傳送：

可以看到當我們傳送請求之後，消費者正常消費了這條請求，同時郵件傳送服務也正常執行。

多條傳送郵件請求

那麼接下來，我們透過Api測試工具，一次性傳送多條郵件請求。其中包含正確的郵箱地址、錯誤的郵箱地址，看看消費者能不能正常消費呢~
這裡簡單的傳送3條請求，2封正確的郵件地址，一封錯誤的，看看2封正常郵件地址的能不能正常傳送出去。

這裡有個問題，如果我填的郵件格式是正確的但是這個郵件地址是不存在的，他是能正常傳送過去的，然後會被郵箱伺服器退回來，這裡不知道該怎麼判斷是否傳送成功。所以我這的錯誤地址是格式就不對的郵件地址，用來模擬因為網路原因或者其他原因導致的郵件傳送不成功。

可以看到3條請求都成功了，並且消費者接收到並正確消費了。2條正確郵件也收到了，1條錯誤的郵件也捕獲到了。

總結

本文透過使用RabiitMQ點對點模式來完成一個傳送郵件的小專案，透過佇列去處理郵件傳送。
透過RabbitMQ.Client庫去連線RabbitMQ伺服器。
使用MailKit庫傳送郵件。
透過使用RabbitMQ來避免郵件傳送請求時間長的問題，同時能在消費者中重試、記錄傳送失敗的郵件，來統一傳送、統一處理。
不足點就是被退回的郵件不知道該如何處理。
可最佳化點：

• 可以使用WorkQueues工作佇列佇列模式將訊息分發給多個消費者，適用於訊息量較大的情況。
• 可以使用死信佇列處理傳送失敗的郵件

參考連結

• RabbitMQ tutorial - Work Queues | RabbitMQ https://www.rabbitmq.com/tutorials/tutorial-two-dotnet
• .NET 中使用RabbitMQ初體驗 - 妙妙屋（zy） - 部落格園 (cnblogs.com) https://www.cnblogs.com/ZYPLJ/p/17572104.html
• ZY知識庫 · ZY - RabbitMQ延時佇列和死信佇列 (pljzy.top) https://pljzy.top/blog/post/8a8b75ca23896940.html