在net Core3.1上基於winform實現依賴注入實例
1.背景
net core3.1是微軟LTS長期3年支持版本，正式發布於2019-12-03，並且在windows平台上支持了Winfrom跟WPF桌面應用。本文介紹了使用Winform時的第一步，將應用層以及ORM涉及到的DBconfig，倉儲層等依賴注入到容器中，並通過構造函數法從容器中調用實例，供給各窗體控件使用。
備注：本文的依賴注入講解基於微軟原生自帶的DI，通過Ninject或者AutoFac可自行仿照操作，原理相通。
2.依賴注入
2.1依賴注入是什么？
依賴注入是通過反轉控制(IOC)，設計模式屬於代理模式+工廠模式，由serviceProvider根據實例接口或者實例類型調用，注入時生命周期的設置，控制實例化及配置實例生命周期，並返回實例給程序員調用，從而達到解放程序員的生產力，不用再去new 一個個實例，也不用去考慮實例之間的依賴關系，也不用去考慮實例的生命周期。實現，分為三個階段，第一,程序員將服務注入服務容器階段，第二程序員DI實例調用階段，第三serviceProvider服務管理者根據注入時的配置返回給程序對應的實例以及配置好實例的生命周期。
一張圖就可以理解依賴注入實例調用過程
圖片來源出處，感謝作者。
這里再向讀者做個說明ServiceCollection是服務容器，serviceProvider是服務管理者，管理着服務容器，當程序發送抽象接口，或者類型時，serviceProvider會根據設置好的生命周期，返回需要的實例配置好實例的生命周期給程序員使用。
2.1依賴注入的目的
通過代理模式serviceProvider控制反轉，他將持有控制權，將所有需要用到的接口，類型，反射出對應的實例，實例化以及設置好實例的生命周期，然后將控制權返還給程序員，不用再去new 一個個實例，也不用去考慮實例之間的依賴關系，也不用去考慮實例的生命周期，最終目的就是解放程序員的生產力，讓程序員更輕松地寫程序。
2.2依賴注入帶來的好處
2.2.1生命周期的控制
在注入的同時可以設置如下三種生命周期：
- Transient
每次注入時，都重新 new 一個新的實例。 - Scoped
每個 Request 都重新 new 一個新的實例，同一個 Request 不管經過多少個 Pipeline 都是用同一個實例。 - Singleton
被實例化后就不會消失，程序運行期間只會有一個實例。
2.2.1.1 生命周期測試舉例
- 定義同一個例子對應三個不同生命周期的接口
public interface ISample
{
int Id { get; }
}
public interface ISampleTransient : ISample
{
}
public interface ISampleScoped : ISample
{
}
public interface ISampleSingleton : ISample
{
}
public class Sample : ISampleTransient, ISampleScoped, ISampleSingleton
{
private static int _counter;
private int _id;
public Sample()
{
_id = ++_counter;
}
public int Id => _id;
}
- 將對應的服務與接口注冊到容器中
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddTransient<ISampleTransient, Sample>();
services.AddScoped<ISampleScoped, Sample>();
services.AddSingleton<ISampleSingleton, Sample>();
// Singleton 也可以用以下方法注冊
// services.AddSingleton<ISampleSingleton>(new Sample());
}
}
- Controller中獲取對應DI實例的HashCode
public class HomeController : Controller
{
private readonly ISample _transient;
private readonly ISample _scoped;
private readonly ISample _singleton;
public HomeController(
ISampleTransient transient,
ISampleScoped scoped,
ISampleSingleton singleton)
{
_transient = transient;
_scoped = scoped;
_singleton = singleton;
}
public IActionResult Index() {
ViewBag.TransientId = _transient.Id;
ViewBag.TransientHashCode = _transient.GetHashCode();
ViewBag.ScopedId = _scoped.Id;
ViewBag.ScopedHashCode = _scoped.GetHashCode();
ViewBag.SingletonId = _singleton.Id;
ViewBag.SingletonHashCode = _singleton.GetHashCode();
return View();
}
}
- VewBag 顯示組件
<table border="1">
<tr><td colspan="3">Cotroller</td></tr>
<tr><td>Lifetimes</td><td>Id</td><td>Hash Code</td></tr>
<tr><td>Transient</td><td>@ViewBag.TransientId</td><td>@ViewBag.TransientHashCode</td></tr>
<tr><td>Scoped</td><td>@ViewBag.ScopedId</td><td>@ViewBag.ScopedHashCode</td></tr>
<tr><td>Singleton</td><td>@ViewBag.SingletonId</td><td>@ViewBag.SingletonHashCode</td></tr>
</table>
可自行做測試，具體可參考此博客
2.2.2 實現了展現層(調用者)與服務類之間的解耦
如上，實例是在HomeController中通過接口來調用實例的，因此修改程序只需要在實例中需改，而不需要在調用層修改。
這符合了6大程序設計原則中的依賴倒置原則:
1.高層模塊不應該依賴於低層模塊，兩者都應該依賴其抽象
展現層Controller沒有依賴Model層Sample類，兩者都依賴了Sample的接口抽象ISample，ISampleTransient，ISampleScoped，ISampleSingleton.
2.抽象不應該依賴於細節
接口層只定義規范，沒有定義細節。
public interface ISample
{
int Id { get; }
}
public interface ISampleTransient : ISample
{
}
public interface ISampleScoped : ISample
{
}
public interface ISampleSingleton : ISample
{
}
3.細節應該依賴於抽象
DI中取實例依賴於接口：
ISampleTransient transient；
服務類的實現也依賴於接口：
public class Sample : ISampleTransient, ISampleScoped, ISampleSingleton
{
private static int _counter;
private int _id;
public Sample()
{
_id = ++_counter;
}
public int Id => _id;
}
2.2.3 開發者不用再去考慮依賴之間的關系
使程序員不用再去考慮各個DI實例之間的依賴，以及new很多個相互依賴的實例。
2.3 依賴注入使用的設計模式
2.3.1 代理模式
在依賴注入的服務調用的地方，容器管理者serviceProvider從程序員手中取得控制權，控制所需服務實例化以及設置好他的生命周期，然后返回給程序員。
2.3.2 工廠模式
根據DI的生命周期設置，根據接口或者類型，生產出各種生命周期的實例，需要注意的是這里有可能是同一實例（scope的單次請求中，或者Transient生命周期），Transient每次產生的都是新的實例。
3.在Net Core 3.1上基於winform實現依賴注入
3.1 Net Core 3.1中對winform的支持。
筆者發現在最新的VS發行版中，能創建winform工程，但卻無法打開設計器，也無法打開winform的工具箱。怎么辦？
在微軟官方博客中提到在VS16.5預覽版中支持了winform設計器，根據博客中提到，需要在此下載鏈接下載VS16.5預覽版。
NetCore3.1 winform截圖如下：
可以看到控件明顯比基於dot Net Framework的好看很多，同時，工具箱中的控件很少，微軟把一些老的已經有替代的控件刪除了，並且以后會慢慢加入一些必要的控件。
3.2 winform依賴注入與net core MVC的不同？
net core MVC容器是自動創建好的，只需要在ConfigureServices方法里配置服務即可。而在Net Core3.1上創建了winform工程之后窗體是new實例，以單例的形式跑的。容器的配置創建，都需要自己來做。
static class Program
{
/// <summary>
/// The main entry point for the application.
/// </summary>
[STAThread]
static void Main()
{
Application.SetHighDpiMode(HighDpiMode.SystemAware);
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
Application.Run(new Form1());
}
}
那如果需要向Form窗體中注入服務就需要在new實例的時候就傳入實參。
[STAThread]
static void Main()
{
Application.SetHighDpiMode(HighDpiMode.SystemAware);
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
var services = new ServiceCollection();
ConfigureServices(services);
using (ServiceProvider serviceProvider = services.BuildServiceProvider())
{
var logg = services.BuildServiceProvider().GetRequiredService<ILogger<Form1>>();
var businessObject = services.BuildServiceProvider().GetRequiredService<IBusinessLayer>();
Application.Run(new Form1(logg, businessObject));
}
}
調用的時候用窗體的構造函數調用服務接口即可。
public partial class Form1 : Form
{
private readonly ILogger _logger;
private readonly IBusinessLayer _business;
public Form1(ILogger<Form1> logger, IBusinessLayer business)
{
_logger = logger;
_business = business;
InitializeComponent();
}
private void button1_Click(object sender, EventArgs e)
{
try
{
_logger.LogInformation("Form1 {BusinessLayerEvent} at {dateTime}", "Started", DateTime.UtcNow);
// Perform Business Logic here
_business.PerformBusiness();
MessageBox.Show("Hello .NET Core 3.0 . This is First Forms app in .NET Core");
_logger.LogInformation("Form1 {BusinessLayerEvent} at {dateTime}", "Ended", DateTime.UtcNow);
}
catch (Exception ex)
{
//Log technical exception
_logger.LogError(ex.Message);
//Return exception repsponse here
throw;
}
}
}
本方法摘自此文
這樣至少有兩個缺點：
- Form1中構造函數的依賴注入實例調用泄露在了他的調用層，這不符合6大程序設計原則中的依賴倒置原則；
- 當Form1中需要從DI中增加接口實例調用時，也需要在如下調用代碼中增加對應實參。而且實參多了，會很冗長。
Application.Run(new Form1(logg, businessObject));
3.3 解決3.2的思路
把form的類型也以單例的形式注入到容器中，調用時，獲取MainForm類型的服務。這樣此服務實例依賴於其他的服務。ServiceProvider容器管理者會自動解決好服務之間的依賴關系，並將對應的服務實例化並根據生命周期設置好，交給程序員去使用。問題完美解決。
此思路有借鑒於以下兩篇文章
微軟MSDN
stackoverflow
這里向大家重點推薦下stackoverflow，這個基於世界級的程序員論壇，在我遇到很多的疑難雜症，孤立無援的時候，他都會給予我解決問題的思路，方向甚至方案，再次致敬感謝stackoverflow，同時也感謝谷歌。
3.4代碼實現
3.4.1 在Program.cs中建立服務注冊靜態方法
private static void ConfigureServices(ServiceCollection services)
{
//App
services.ApplicationServiceIoC();
//Infra
//Repo
services.InfrastructureORM<DapperIoC>();
//Presentation 其他的窗體也可以注入在此處
services.AddSingleton(typeof(MainForm));
}
這里需要說明的是，筆者這里的IoC是應用層，展現層，倉儲層分層注入了，每層都寫了ServiceCollection服務容器的靜態方法，所以服務可以在各層注入，讀者可以不去追究，將自己的服務注入在此即可。
分層注入：
分層注入簡單實現
CameraDM_Service注冊在了ApplicationServiceIoC，ApplicationServiceIoC注冊在了ConfigureServices。這就是我剛說的分層注入每層的依賴。
public static class ServicesIoC
{
public static void ApplicationServiceIoC(this IServiceCollection services)
{
services.AddScoped(typeof(IServiceBase<>), typeof(ServiceBase<>));
services.AddScoped<ICameraDM_Service, CameraDM_Service>();
}
}
重點關注
將窗體類型注入，當然后續加入其它窗體也可用同樣方法進行注入。
services.AddSingleton(typeof(MainForm));
3.4.2 創建服務容器對象
var services = new ServiceCollection();
3.4.3 添加服務注冊
ConfigureServices(services);
此步驟調用的就是3.4.1中的方法。
3.4.4 構建ServiceProvider對象
var serviceProvider = services.BuildServiceProvider();
3.4.5 運行MainForm服務
向服務管理者請求MainForm類型的實例服務，具體調用過程詳見2.1。
Application.Run(serviceProvider.GetService<MainForm>());
這一步是重點，也是winform跟MVC使用上的區別，但是本質卻是相同的，都是由serviceProvider管理着WPF,winform或者MVC這些實例以及他們對應的類型，只不過MVC容器已經創建好了，容器管理者serviceProvider也已經創建好了，直接往容器里Add服務即可，而winform,WPF,net core控制台程序需要我們自己去往容器里添加注冊服務，並且創建容器管理者serviceProvider。因為ServiceCollection容器是死的，只有創建了serviceProvider容器管理者這個代理角色，容器才能體現出他的價值。而只有serviceProvider，沒有ServiceCollection里的服務也是毫無意義的。
3.4.1到3.4.5整體代碼如下：
static class Program
{
/// <summary>
/// The main entry point for the application.
/// </summary>
[STAThread]
static void Main()
{
Application.SetHighDpiMode(HighDpiMode.SystemAware);
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
//創建服務容器對象
var services = new ServiceCollection();
//添加服務注冊
ConfigureServices(services);
//構建ServiceProvider對象
var serviceProvider = services.BuildServiceProvider();
//向服務管理者請求MainForm類型的實例服務
Application.Run(serviceProvider.GetService<MainForm>());
}
private static void ConfigureServices(ServiceCollection services)
{
//App
services.ApplicationServiceIoC();
//Infra
//Repo
services.InfrastructureORM<DapperIoC>();
//Presentation 其他的窗體也可以注入在此處
services.AddSingleton(typeof(MainForm));
}
}
3.4.6構造函數法調用DI實例
public partial class MainForm : Form
{
ICameraDM_Service _cameraDM_Service;
public MainForm(ICameraDM_Service cameraDM_Service)
{
_cameraDM_Service = cameraDM_Service;
InitializeComponent();
}
private async void button1_Click(object sender, EventArgs e)
{
MessageBox.Show(_cameraDM_Service.GetAllCameraInfo().ToList().Count().ToString());
var _camera =await _cameraDM_Service.GetAllIncludingTasksAsync();
//textBox1.Text = _camera.ToList().Count().ToString();
var _cameraNo3 = await _cameraDM_Service.GetByIdAsync(3);
textBox1.Text = _cameraNo3.InstallTime.ToString();
}
}
3.5演示效果
點擊按鈕之后從攝像頭服務中獲取到了攝像頭的數量。
點擊確定之后從攝像頭服務中獲取到了3號攝像頭的安裝時間。
3.6 如何調用用依賴注入在母窗體中調用子窗體
3.6屬於12/23/13:33新增，為了答復1樓網友 編程老油條所問問題。
問題如下：
假設在MainForm中的button1_Click，還需要打開其他窗口，要如何實現？（只能往 MainForm 中傳遞serviceProvider嗎？）
把serviceProvider設計成全局靜態的，可設計成單例模式或直接放在Main的屬性中，供全局任意子窗體訪問獲取DI實例即可，當然同時，其他窗體也需要注入到容器中。
3.6.1 注入子窗體
注入生命周期為瞬時的Form1類型。
services.AddTransient(typeof(Form1));
private static void ConfigureServices(ServiceCollection services)
{
//App
services.ApplicationServiceIoC();
//Infra
//Repo
services.InfrastructureORM<DapperIoC>();
//Presentation 其他的窗體也可以注入在此處
services.AddSingleton(typeof(MainForm));
services.AddTransient(typeof(Form1));
}
因為Form1是MainForm的子窗體，而MainForm設置成了單例模式，所以在MainForm中打開Form1是屬於同一次請求，姑不能用AddSingleton跟AddScope模式。如果使用以上兩種模式，會報如下異常：
比如設置Form1生命周期為單例模式
services.AddSingleton(typeof(MainForm));
services.AddSingleton(typeof(Form1));
第一次調用正常，
關閉Form1第二次點擊MainForm的button1時，報如下異常：
因為是單例模式，我們關閉了Form1，MainForm還在，再次點擊button1,會找不到生命周期是單例模式的Form1實例，就會報如上異常。
修改成
services.AddTransient(typeof(Form1));
問題得到完美解決，無論關閉多少次Form1，都能通過MainForm的button1調用打開Form1。
3.6.2 設置全局serviceProvider容器服務管理者
修改serviceProvider為Program靜態類的公用屬性（全局），以給子窗體或其他winform中的組件來容器服務者獲取DI實例
public static IServiceProvider serviceProvider { get; set; }
Program.cs全部代碼如下。
static class Program
{
public static IServiceProvider serviceProvider { get; set; }
/// <summary>
/// The main entry point for the application.
/// </summary>
[STAThread]
static void Main()
{
Application.SetHighDpiMode(HighDpiMode.SystemAware);
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
//創建服務容器對象
var services = new ServiceCollection();
//添加服務注冊
ConfigureServices(services);
//構建ServiceProvider對象
serviceProvider = services.BuildServiceProvider();
//向服務管理者請求MainForm類型的實例服務
Application.Run(serviceProvider.GetService<MainForm>());
}
private static void ConfigureServices(ServiceCollection services)
{
//App
services.ApplicationServiceIoC();
//Infra
//Repo
services.InfrastructureORM<DapperIoC>();
//Presentation 其他的窗體也可以注入在此處
services.AddSingleton(typeof(MainForm));
services.AddTransient(typeof(Form1));
}
}
3.6.3 MainForm中調用Form1
到Program服務管理者屬性手中拿到對應所需類型的設置好生命周期的Form1實例。顯示Form1。
public partial class MainForm : Form
{
public MainForm()
{
InitializeComponent();
}
private async void button1_Click(object sender, EventArgs e)
{
var child = (Form)Program.serviceProvider.GetService((typeof(Form1)));
child.Show();
}
}
3.6.4 構造函數法調用DI實例
Form1調用camera服務
此處同3.5
public partial class Form1 : Form
{
ICameraDM_Service _cameraDM_Service;
public Form1(ICameraDM_Service cameraDM_Service)
{
_cameraDM_Service = cameraDM_Service;
InitializeComponent();
}
private async void button1_Click(object sender, EventArgs e)
{
MessageBox.Show(_cameraDM_Service.GetAllCameraInfo().ToList().Count().ToString());
}
}
3.6.5效果
4.最后
本來就想寫篇短文，誰知道洋洋灑灑還寫得有點長。本文如果大家讀了有疑惑，請提出來，我會耐心解答；如果知識點上有不妥當不正確或者不同見解的地方，也懇請指出，我同時也很渴望進步。最后祝大家冬至安康，闔家幸福。