.Net Core應用搭建的分散式郵件系統設計

神牛003發表於2017-05-24

本篇分享的是由NetCore搭建的分散式郵件系統,主要採用NetCore的Api控制檯應用程式,由於此係統屬於公司的所以這裡只能分享設計圖和一些單純不設計業務的類或方法;

為什麼要在公司中首例採用NetCore做開發

為什麼要在公司中首例採用NetCore做開發,有些netcoreapi不是還不全面麼,您都敢嘗試?恐怕會有人這樣問我,我只能告訴你NetCore現在出2.0版本了,很多Framwork的常用封裝都已經有了,況且她主打的是MVC模式,能夠高效的開發系統,也有很多Core的Nuget包支援了,已經到達了幾乎可以放心大膽使用的地步,退一萬不說有些東西不支援那這又如何,可以採用介面的方式從其他地方對接過來也是一種不錯的處理方案。為了讓C#這門優秀的語言被廣泛應用,默默努力著。

目前我寫的NetCore方面的文章

AspNetCore - MVC實戰系列目錄

.NetCore上傳多檔案的幾種示例

開源一個跨平臺執行的服務外掛 - TaskCore.MainForm

NET Core-學習筆記

Asp.NetCore1.1版本沒了project.json,這樣來生成跨平臺包

 

正片環節 - 分散式郵件系統設計圖

分散式郵件系統說明

其實由上圖可以知曉這裡我主要採用了Api+服務的模式,這也是現在網際網路公司經常採用的一種搭配預設;利用api接受請求插入待傳送郵件佇列和入庫,然後通過部署多個NetCore跨平臺服務(這裡服務指的是:控制檯應用)來做分散式處理操作,跨平臺服務主要操作有:

. 郵件傳送

. 郵件傳送狀態的通知(如果需要通知子業務,那麼需要通知業務方郵件傳送的狀態)

. 通知失敗處理(自動往繫結的責任人傳送一封郵件)

. 填充佇列(如果待發郵件佇列或者通知佇列資料不完整,需要修復佇列資料)

Api介面的統一驗證入口

這裡我用最簡單的方式,繼承Controller封裝了一個父級的BaseController,來讓各個api的Controller基礎統一來做身份驗證;來看看重寫 public override void OnActionExecuting(ActionExecutingContext context) 的驗證程式碼:

 1 public override void OnActionExecuting(ActionExecutingContext context)
 2         {
 3             base.OnActionExecuting(context);
 4 
 5             var moResponse = new MoBaseRp();
 6             try
 7             {
 8 
 9                 #region 安全性驗證
10 
11                 var key = "request";
12                 if (!context.ActionArguments.ContainsKey(key)) { moResponse.Msg = "請求方式不正確"; return; }
13                 var request = context.ActionArguments[key];
14                 var baseRq = request as MoBaseRq;
15                 //暫時不驗證登入賬號密碼
16                 if (string.IsNullOrWhiteSpace(baseRq.UserName) || string.IsNullOrWhiteSpace(baseRq.UserPwd)) { moResponse.Msg = "登入賬號或密碼不能為空"; return; }
17                 else if (baseRq.AccId <= 0) { moResponse.Msg = "傳送者Id無效"; return; }
18                 else if (string.IsNullOrWhiteSpace(baseRq.FuncName)) { moResponse.Msg = "業務方法名不正確"; return; }
19 
20                 //token驗證
21                 var strToken = PublicClass._Md5($"{baseRq.UserName}{baseRq.AccId}", "");
22                 if (!strToken.Equals(baseRq.Token, StringComparison.OrdinalIgnoreCase)) { moResponse.Msg = "Token驗證失敗"; return; }
23 
24                 //驗證傳送者Id
25                 if (string.IsNullOrWhiteSpace(baseRq.Ip))
26                 {
27                     var account = _db.EmailAccount.SingleOrDefault(b => b.Id == baseRq.AccId);
28                     if (account == null) { moResponse.Msg = "傳送者Id無效。"; return; }
29                     else
30                     {
31                         if (account.Status != (int)EnumHelper.EmStatus.啟用)
32                         {
33                             moResponse.Msg = "傳送者Id已禁用"; return;
34                         }
35 
36                         //驗證ip
37                         var ipArr = account.AllowIps.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
38                         //當前請求的Ip
39                         var nowIp = this.GetUserIp();
40                         baseRq.Ip = nowIp;
41                         //預設*為所有ip , 匹配ip
42                         if (!ipArr.Any(b => b.Equals("*")) && !ipArr.Any(b => b.Equals(nowIp)))
43                         {
44                             moResponse.Msg = "請求IP為授權"; return;
45                         }
46                     }
47                 }
48                 else
49                 {
50                     var account = _db.EmailAccount.SingleOrDefault(b => b.Id == baseRq.AccId && b.AllowIps.Any(bb => bb.Equals(baseRq.Ip)));
51                     if (account == null) { moResponse.Msg = "傳送者未授權"; return; }
52                     else if (account.Status != (int)EnumHelper.EmStatus.啟用)
53                     {
54                         moResponse.Msg = "傳送者Id已禁用"; return;
55                     }
56                 }
57 
58                 //內容非空,格式驗證
59                 if (!context.ModelState.IsValid)
60                 {
61                     var values = context.ModelState.Values.Where(b => b.Errors.Count > 0);
62                     if (values.Count() > 0)
63                     {
64                         moResponse.Msg = values.First().Errors.First().ErrorMessage;
65                         return;
66                     }
67                 }
68 
69                 #endregion
70 
71                 moResponse.Status = 1;
72             }
73             catch (Exception ex)
74             {
75                 moResponse.Msg = "O No請求資訊錯誤";
76             }
77             finally
78             {
79                 if (moResponse.Status == 0) { context.Result = Json(moResponse); }
80             }
81         }

郵件請求父類實體:

 1 /// <summary>
 2     /// 郵件請求父類
 3     /// </summary>
 4     public class MoBaseRq
 5     {
 6 
 7         public string UserName { get; set; }
 8 
 9         public string UserPwd { get; set; }
10 
11         /// <summary>
12         /// 驗證token(Md5(賬號+配置傳送者賬號資訊的Id+Ip))   必填
13         /// </summary>
14         public string Token { get; set; }
15 
16         /// <summary>
17         /// 配置傳送者賬號資訊的Id  必填
18         /// </summary>
19         public int AccId { get; set; }
20 
21         /// <summary>
22         /// 業務方法名稱
23         /// </summary>
24         public string FuncName { get; set; }
25 
26         /// <summary>
27         /// 請求者Ip,如果客戶端沒賦值,預設服務端獲取
28         /// </summary>
29         public string Ip { get; set; }
30 
31     }

第三方Nuget包的便利

此郵件系統使用到了第三方包,這也能夠看出有很多朋友正為開源,便利,NetCore的推廣努力著;

首先看看MailKit(郵件傳送)包,通過安裝下載命令: Install-Package MailKit 能夠下載最新包,然後你不需要做太花哨的分裝,只需要正對於郵件傳送的伺服器,埠,賬號,密碼做一些設定基本就行了,如果可以您可以直接使用我的程式碼:

 1 /// <summary>
 2         /// 傳送郵件
 3         /// </summary>
 4         /// <param name="dicToEmail"></param>
 5         /// <param name="title"></param>
 6         /// <param name="content"></param>
 7         /// <param name="name"></param>
 8         /// <param name="fromEmail"></param>
 9         /// <returns></returns>
10         public static bool _SendEmail(
11             Dictionary<string, string> dicToEmail,
12             string title, string content,
13             string name = "愛留圖網", string fromEmail = "841202396@qq.com",
14             string host = "smtp.qq.com", int port = 587,
15             string userName = "841202396@qq.com", string userPwd = "123123")
16         {
17             var isOk = false;
18             try
19             {
20                 if (string.IsNullOrWhiteSpace(title) || string.IsNullOrWhiteSpace(content)) { return isOk; }
21 
22                 //設定基本資訊
23                 var message = new MimeMessage();
24                 message.From.Add(new MailboxAddress(name, fromEmail));
25                 foreach (var item in dicToEmail.Keys)
26                 {
27                     message.To.Add(new MailboxAddress(item, dicToEmail[item]));
28                 }
29                 message.Subject = title;
30                 message.Body = new TextPart("html")
31                 {
32                     Text = content
33                 };
34 
35                 //連結傳送
36                 using (var client = new SmtpClient())
37                 {
38                     // For demo-purposes, accept all SSL certificates (in case the server supports STARTTLS)
39                     client.ServerCertificateValidationCallback = (s, c, h, e) => true;
40 
41                     //採用qq郵箱伺服器傳送郵件
42                     client.Connect(host, port, false);
43 
44                     // Note: since we don't have an OAuth2 token, disable
45                     // the XOAUTH2 authentication mechanism.
46                     client.AuthenticationMechanisms.Remove("XOAUTH2");
47 
48                     //qq郵箱,密碼(安全設定簡訊獲取後的密碼)  ufiaszkkulbabejh
49                     client.Authenticate(userName, userPwd);
50 
51                     client.Send(message);
52                     client.Disconnect(true);
53                 }
54                 isOk = true;
55             }
56             catch (Exception ex)
57             {
58 
59             }
60             return isOk;
61         }

Redis方面的操作包StackExchange.Redis,現在NetCore支援很多資料庫驅動(例如:Sqlserver,mysql,postgressql,db2等)這麼用可以參考下這篇文章AspNetCore - MVC實戰系列(一)之Sqlserver表對映實體模型,不僅如此還支援很多快取服務(如:Memorycach,Redis),這裡講到的就是Redis,我利用Redis的list的佇列特性來做分散式任務儲存,儘管目前我用到的只有一個主Redis服務還沒有業務場景需要用到主從複製等功能;這裡分享的程式碼是基於StackExchange.Redis基礎上封裝對於string,list的操作:

  1   public class StackRedis : IDisposable
  2     {
  3         #region 配置屬性   基於 StackExchange.Redis 封裝
  4         //連線串 (注:IP:埠,屬性=,屬性=)
  5         public string _ConnectionString = "127.0.0.1:6377,password=shenniubuxing3";
  6         //操作的庫(注:預設0庫)
  7         public int _Db = 0;
  8         #endregion
  9 
 10         #region 管理器物件
 11 
 12         /// <summary>
 13         /// 獲取redis操作類物件
 14         /// </summary>
 15         private static StackRedis _StackRedis;
 16         private static object _locker_StackRedis = new object();
 17         public static StackRedis Current
 18         {
 19             get
 20             {
 21                 if (_StackRedis == null)
 22                 {
 23                     lock (_locker_StackRedis)
 24                     {
 25                         _StackRedis = _StackRedis ?? new StackRedis();
 26                         return _StackRedis;
 27                     }
 28                 }
 29 
 30                 return _StackRedis;
 31             }
 32         }
 33 
 34         /// <summary>
 35         /// 獲取併發連結管理器物件
 36         /// </summary>
 37         private static ConnectionMultiplexer _redis;
 38         private static object _locker = new object();
 39         public ConnectionMultiplexer Manager
 40         {
 41             get
 42             {
 43                 if (_redis == null)
 44                 {
 45                     lock (_locker)
 46                     {
 47                         _redis = _redis ?? GetManager(this._ConnectionString);
 48                         return _redis;
 49                     }
 50                 }
 51 
 52                 return _redis;
 53             }
 54         }
 55 
 56         /// <summary>
 57         /// 獲取連結管理器
 58         /// </summary>
 59         /// <param name="connectionString"></param>
 60         /// <returns></returns>
 61         public ConnectionMultiplexer GetManager(string connectionString)
 62         {
 63             return ConnectionMultiplexer.Connect(connectionString);
 64         }
 65 
 66         /// <summary>
 67         /// 獲取運算元據庫物件
 68         /// </summary>
 69         /// <returns></returns>
 70         public IDatabase GetDb()
 71         {
 72             return Manager.GetDatabase(_Db);
 73         }
 74         #endregion
 75 
 76         #region 操作方法
 77 
 78         #region string 操作
 79 
 80         /// <summary>
 81         /// 根據Key移除
 82         /// </summary>
 83         /// <param name="key"></param>
 84         /// <returns></returns>
 85         public async Task<bool> Remove(string key)
 86         {
 87             var db = this.GetDb();
 88 
 89             return await db.KeyDeleteAsync(key);
 90         }
 91 
 92         /// <summary>
 93         /// 根據key獲取string結果
 94         /// </summary>
 95         /// <param name="key"></param>
 96         /// <returns></returns>
 97         public async Task<string> Get(string key)
 98         {
 99             var db = this.GetDb();
100             return await db.StringGetAsync(key);
101         }
102 
103         /// <summary>
104         /// 根據key獲取string中的物件
105         /// </summary>
106         /// <typeparam name="T"></typeparam>
107         /// <param name="key"></param>
108         /// <returns></returns>
109         public async Task<T> Get<T>(string key)
110         {
111             var t = default(T);
112             try
113             {
114                 var _str = await this.Get(key);
115                 if (string.IsNullOrWhiteSpace(_str)) { return t; }
116 
117                 t = JsonConvert.DeserializeObject<T>(_str);
118             }
119             catch (Exception ex) { }
120             return t;
121         }
122 
123         /// <summary>
124         /// 儲存string資料
125         /// </summary>
126         /// <param name="key"></param>
127         /// <param name="value"></param>
128         /// <param name="expireMinutes"></param>
129         /// <returns></returns>
130         public async Task<bool> Set(string key, string value, int expireMinutes = 0)
131         {
132             var db = this.GetDb();
133             if (expireMinutes > 0)
134             {
135                 return db.StringSet(key, value, TimeSpan.FromMinutes(expireMinutes));
136             }
137             return await db.StringSetAsync(key, value);
138         }
139 
140         /// <summary>
141         /// 儲存物件資料到string
142         /// </summary>
143         /// <typeparam name="T"></typeparam>
144         /// <param name="key"></param>
145         /// <param name="value"></param>
146         /// <param name="expireMinutes"></param>
147         /// <returns></returns>
148         public async Task<bool> Set<T>(string key, T value, int expireMinutes = 0)
149         {
150             try
151             {
152                 var jsonOption = new JsonSerializerSettings()
153                 {
154                     ReferenceLoopHandling = ReferenceLoopHandling.Ignore
155                 };
156                 var _str = JsonConvert.SerializeObject(value, jsonOption);
157                 if (string.IsNullOrWhiteSpace(_str)) { return false; }
158 
159                 return await this.Set(key, _str, expireMinutes);
160             }
161             catch (Exception ex) { }
162             return false;
163         }
164         #endregion
165 
166         #region List操作(注:可以當做佇列使用)
167 
168         /// <summary>
169         /// list長度
170         /// </summary>
171         /// <typeparam name="T"></typeparam>
172         /// <param name="key"></param>
173         /// <returns></returns>
174         public async Task<long> GetListLen<T>(string key)
175         {
176             try
177             {
178                 var db = this.GetDb();
179                 return await db.ListLengthAsync(key);
180             }
181             catch (Exception ex) { }
182             return 0;
183         }
184 
185         /// <summary>
186         /// 獲取佇列出口資料並移除
187         /// </summary>
188         /// <typeparam name="T"></typeparam>
189         /// <param name="key"></param>
190         /// <returns></returns>
191         public async Task<T> GetListAndPop<T>(string key)
192         {
193             var t = default(T);
194             try
195             {
196                 var db = this.GetDb();
197                 var _str = await db.ListRightPopAsync(key);
198                 if (string.IsNullOrWhiteSpace(_str)) { return t; }
199                 t = JsonConvert.DeserializeObject<T>(_str);
200             }
201             catch (Exception ex) { }
202             return t;
203         }
204 
205         /// <summary>
206         /// 集合物件新增到list左邊
207         /// </summary>
208         /// <typeparam name="T"></typeparam>
209         /// <param name="key"></param>
210         /// <param name="values"></param>
211         /// <returns></returns>
212         public async Task<long> SetLists<T>(string key, List<T> values)
213         {
214             var result = 0L;
215             try
216             {
217                 var jsonOption = new JsonSerializerSettings()
218                 {
219                     ReferenceLoopHandling = ReferenceLoopHandling.Ignore
220                 };
221                 var db = this.GetDb();
222                 foreach (var item in values)
223                 {
224                     var _str = JsonConvert.SerializeObject(item, jsonOption);
225                     result += await db.ListLeftPushAsync(key, _str);
226                 }
227                 return result;
228             }
229             catch (Exception ex) { }
230             return result;
231         }
232 
233         /// <summary>
234         /// 單個物件新增到list左邊
235         /// </summary>
236         /// <typeparam name="T"></typeparam>
237         /// <param name="key"></param>
238         /// <param name="value"></param>
239         /// <returns></returns>
240         public async Task<long> SetList<T>(string key, T value)
241         {
242             var result = 0L;
243             try
244             {
245                 result = await this.SetLists(key, new List<T> { value });
246             }
247             catch (Exception ex) { }
248             return result;
249         }
250 
251 
252         #endregion
253 
254         #region 額外擴充套件
255 
256         /// <summary>
257         /// 手動回收管理器物件
258         /// </summary>
259         public void Dispose()
260         {
261             this.Dispose(_redis);
262         }
263 
264         public void Dispose(ConnectionMultiplexer con)
265         {
266             if (con != null)
267             {
268                 con.Close();
269                 con.Dispose();
270             }
271         }
272 
273         #endregion
274 
275         #endregion
276     }

用到Redis的那些操作就新增哪些就行了,也不用太花哨能用就行;

如何生成跨平臺的api服務和應用程式服務

這小節的內容最重要,由於之前有相關的文章,這裡就不用再贅述了,來這裡看看:Asp.NetCore1.1版本沒了project.json,這樣來生成跨平臺包

相關文章