MicroService.Core MicroService.Core 的初衷是為了方便的創建一個微服務, 可作為 Windows Service 或者控制台模式啟動。 它底層使用了 OWin 自托管技術,拋棄了微軟 Mvc 的那套東 西,進而選擇了 Nancy,使得開發過程很順心,很簡單! 快速入 ...
MicroService.Core
MicroService.Core
的初衷是為了方便的創建一個微服務, 可作為 Windows Service 或者控制台模式啟動。 它底層使用了 OWin 自托管技術,拋棄了微軟 Mvc 的那套東 西,進而選擇了 Nancy,使得開發過程很順心,很簡單!
快速入門
一、創建控制台項目(需要.net 4.5以上)
二、安裝Nuget包
PM> Install-Package MicroService.Core -Version 1.1.1
或在 Nuget 包管理器中搜索 MicroService.Core
安裝。
三、編寫 Program.cs,輸入以下代碼
添加引用:using MicroService.Core;
Main 方法中寫如下代碼:
1 var service = new MicroServiceBase("MyService"); 2 service.Run(args);
這時 Program.cs 文件內容如下
1 using MicroService.Core; 2 namespace MicroService.Samples 3 { 4 class Program 5 { 6 static void Main(string[] args) 7 { 8 var service = new MicroServiceBase("MyService"); 9 service.Run(args); 10 } 11 } 12 }
生成項目,然後在生成的 EXE 文件目錄下打開一個命令行視窗,執行:
如生成的 EXE 文件為
MicroService.Samples.exe
1、命令行模式運行:
MicroService.Samples.exe --console
即可看到如下的運行效果:
2、Windows 服務模式
MicroService.Samples.exe --install
運行結果如果出現下麵這個情況:
是因為許可權不夠,無法安裝windows服務,以管理員許可權運行命令行視窗再次執行以上命令, 截圖如下:
查看 Windows 服務
列表,可以看到此服務已經正常運行:
四、如何測試此服務是否已經正常運行?
此微服務框架預設提供了服務狀態地址 /health
,如圖,預設綁定地址是 http://127.0.0.1:8080
,從瀏覽器訪問地址http://127.0.0.1:8080/health 可以得到如下的輸出:
可以看出服務的一些情況,運行時常,暴露端點等等...
五、是否被驚到?
僅僅3行代碼,拋去 using 引用,就只有2行代碼,就可以做一個可以運行在命令行 /windows 服務的對外提供 API
能力的程式。
原理
- 通過集成 Owin 使得她有了自托管的能力
- 通過實現了一個內部的 ServiceBase 類使得她有了能作為 windows 服務運行的能力
- 通過集成 Nancy (http://nancyfx.org/) 使得她有了很容易開放 Api 服務的能力
有人可能會說,這有個鳥用?先別急,我們來擴展一下,做個什麼呢? 就先來個加法器吧,輸入兩個數字,返回兩個數字之和。
進階
一、寫一個 Nancy 模塊:
關於 Nancy 模塊的編寫,請自行前往鏈接 http://nancyfx.org/ 學習,作為技術人員,學習是必不可少的技能。當然,你看到這裡,先不用著急去學習 Nancy, 繼續往下看,很簡單的!
1、新增一個類
在項目中新建一個名為 AddModule
的 Nancy 模塊,代碼如下:
1 using Nancy; 2 using System.Threading.Tasks; 3 namespace MicroService.Samples 4 { 5 public class AddModule : NancyModule 6 { 7 public AddModule() 8 { 9 Get["/add", true] = async (_, ctx) => 10 { 11 return await Task.Run(() => 12 { 13 int? num1 = Request.Query.num1; 14 int? num2 = Request.Query.num2; 15 if (num1.HasValue && num2.HasValue) 16 { 17 return $"{num1} + {num2} = {num1 + num2}"; 18 } 19 return "Paramters num1 and num2 missing!"; 20 }); 21 }; 22 } 23 } 24 }
這段代碼可能對沒有 Nancy 模塊經驗的人,稍微有點難度,但是代碼通俗易懂,一看就會!
停掉上面運行的 Windows 服務,然後重新生成項目,啟動服務。
訪問瀏覽器:http://127.0.0.1:8080/add?num1=1&num2=2
如果不出意外,你的運行結果應該和我無異!
到這裡可能你有點想法了,那我不能用 VS 調試嗎? 答案是:可以!
在 VS 項目上右鍵,進入項目屬性頁面,在調試選項卡下的啟動參數里輸入 --console,然後啟動項目 如圖:
現在重新看看控制台的運行效果:
看紅色箭頭處,新增了兩行,載入剛剛新建的模塊成功!
連暴露的URL都列出來了,是否很貼心?
到這裡我感覺還是沒有體現出他的優勢,我們再將這個項目處理處理!
2、再單獨新建一個類 RedisService.cs
代碼如下:
1 using System; 2 namespace MicroService.Samples 3 { 4 public class RedisService 5 { 6 public string RedisServiceStatus 7 { 8 get 9 { 10 var rnd = new Random().Next(1, 10); 11 if (rnd % 3 == 0) 12 { 13 return "DOWN"; 14 } 15 return "UP"; 16 } 17 } 18 } 19 }
代碼很簡單,只有一個只讀屬性,獲取了 Redis 服務的狀態(模擬)。 下麵,我們把他加入到上面的 /health
端點中,讓我們的服務更加直觀的展示出整體服務的狀態。
修改 Program.cs 類中的代碼:
1 using MicroService.Core; 2 using Nancy.TinyIoc; 3 namespace MicroService.Samples 4 { 5 class Program 6 { 7 static void Main(string[] args) 8 { 9 var service = new MicroServiceBase("MyService"); 10 service.OnServiceStarting += Service_OnServiceStarting; 11 service.OnServiceStatusUpdating += Service_OnServiceStatusUpdating; 12 service.Run(args); 13 } 14 /// <summary> 15 /// 服務啟動之前執行事件 16 /// </summary> 17 /// <param name="service"></param> 18 /// <param name="container"></param> 19 private static void Service_OnServiceStarting( 20 MicroServiceBase service, 21 TinyIoCContainer container) 22 { 23 var redisService = new RedisService(); 24 container.Register(redisService); 25 } 26 /// <summary> 27 /// 服務狀態更新事件 28 /// </summary> 29 /// <param name="service"></param> 30 /// <param name="serviceStatus"></param> 31 private static void Service_OnServiceStatusUpdating( 32 MicroServiceBase service, 33 ServiceStatus serviceStatus) 34 { 35 var redisService = service.GetComponent<RedisService>(); 36 if (redisService != null) 37 { 38 serviceStatus.AddOrUpdate("RedisStatus", redisService.RedisServiceStatus); 39 } 40 } 41 } 42 }
有人可能要罵我了,你 TM 逗我啊,這麼多代碼這叫簡單?其實仔細看看不難!
加了兩個事件,服務啟動之前執行事件和服務狀態更新事件,在服務啟動之前執行事件代碼中, 使用 Nancy 內置的 TinyIoCContainer IoC容器註冊了一個 RedisService 的實例。 在服務狀態更新事件中,通過 service.GetComponent<RedisService>()
獲取到了這個 RedisService 實例,在 serviceStatus 添加進去。
現在,再次運行,看看結果:
這樣就完成了一個小型的微服務啦,當然這條路還很長,這隻是一個核