在C#中使用RabbitMQ做個簡單的發送郵件小項目

来源:https://www.cnblogs.com/ZYPLJ/p/18279034
-Advertisement-
Play Games

在C#中使用RabbitMQ做個簡單的發送郵件小項目 前言 好久沒有做項目了，這次做一個發送郵件的小項目。發郵件是一個比較耗時的操作，之前在我的個人博客裡面回覆評論和友鏈申請是會通過發送郵件來通知對方的，不過當時只是簡單的進行了非同步操作。 那麼這次來使用RabbitMQ去統一發送郵件，我的想法是通過 ...


在C#中使用RabbitMQ做個簡單的發送郵件小項目

前言

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

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

對於常用的RabbitMQ隊列模式不瞭解的可以查看往期文章：

架構圖

image

簡單描述下項目結構。項目主要分為生產者、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();  
}

一階段測試效果

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

image
image

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

開始編碼(二階段)

簡單的創建一個用於發送郵件的類，這裡使用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("[email protected]", "");  

			// 創建一個郵件消息  
			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 = "[email protected]"; // 發件人地址  
	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的完整展示。
首先我們來寫一個正確的郵箱地址進行發送：

image
image
image

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

多條發送郵件請求

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

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

image
image
image
image

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

總結

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

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

參考鏈接


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • WTM的項目中EFCore如何適配人大金倉資料庫
    一、WTM是什麼 WalkingTec.Mvvm框架（簡稱WTM）最早開發與2013年，基於Asp.net MVC3 和 最早的Entity Framework, 當初主要是為瞭解決公司內部開發效率低，代碼風格不統一的問題。2017年9月，將代碼移植到了.Net Core上，併進行了深度優化和重構， ...
  • Simple WPF: WPF 實現按鈕的長按，短按功能
    實現了一個支持長短按得按鈕組件，單擊可以觸發Click事件，長按可以觸發LongPressed事件，長按鬆開時觸發LongClick事件。還可以和自定義外觀相結合，實現自定義的按鈕外形。 ...
  • Simple WPF: WPF 自定義按鈕外形
    WPF的按鈕提供了Template模板，可以通過修改Template模板中的內容對按鈕的樣式進行自定義。結合資源字典，可以將自定義資源在xaml視窗、自定義控制項或者整個App當中調用 ...
  • UWP WinUI 製作一個路徑矢量圖標按鈕樣式入門
    在 Visual Studio 中，至少可以創建三種不同類型的類庫： 類庫（.NET Framework） 類庫（.NET 標準） 類庫 (.NET Core) 雖然第一種是我們多年來一直在使用的，但一直感到困惑的一個主要問題是何時使用 .NET Standard 和 .NET Core 類庫類型。 ...
  • 基於 .net core 8.0 的 swagger 文檔優化分享-根據命名空間分組顯示
    之前也分享過 Swashbuckle.AspNetCore 的使用，不過版本比較老了，本次演示用的示例版本為 .net core 8.0，從安裝使用開始，到根據命名空間分組顯示，十分的有用 ...
  • Playwright for .NET使用
    1.簡單使用實例 1.1 添加log4net.dll的引用。 在NuGet程式包中搜索log4net並添加，此次我所用版本為2.0.17。如下圖： 1.2 添加配置文件 右鍵項目，添加新建項，搜索選擇應用程式配置文件，命名為log4net.config，步驟如下圖： 1.2.1 log4net.co ...
  • 推薦一款Win11主題WPF UI框架
    最近在微軟商店，官方上架了新款Win11風格的WPF版UI框架【WPF Gallery Preview 1.0.0.0】,這款應用引入了前沿的Fluent Design UI設計，為用戶帶來全新的視覺體驗。 ...
  • Advanced .Net Debugging 10：事後調試
    當你使用Edge等瀏覽器或系統軟體播放媒體時，Windows控制中心就會出現相應的媒體信息以及控制播放的功能，如圖。 SMTC (SystemMediaTransportControls) 是一個Windows App SDK (舊為UWP) 中提供的一個API，用於與系統媒體交互。接入SMTC的好 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類