在net Core3.1上基於winform實現依賴注入實例

時間  2019-12-23
標籤 core3.1 core 基於 winform 實現 依賴 注入 實例 欄目 設計模式 简体版
原文   原文鏈接

目錄html

在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服務管理者根據注入時的配置返回給程序對應的實例以及配置好實例的生命週期。windows

一張圖就能夠理解依賴注入實例調用過程
設計模式

圖片來源出處，感謝做者。mvc

這裏再向讀者作個說明ServiceCollection是服務容器，serviceProvider是服務管理者，管理着服務容器，當程序發送抽象接口，或者類型時，serviceProvider會根據設置好的生命週期，返回須要的實例配置好實例的生命週期給程序員使用。app

2.1依賴注入的目的

經過代理模式serviceProvider控制反轉，他將持有控制權，將全部須要用到的接口，類型，反射出對應的實例，實例化以及設置好實例的生命週期，而後將控制權返還給程序員，不用再去new 一個個實例，也不用去考慮實例之間的依賴關係，也不用去考慮實例的生命週期，最終目的就是解放程序員的生產力，讓程序員更輕鬆地寫程序。async

2.2依賴注入帶來的好處

2.2.1生命週期的控制

在注入的同時能夠設置以下三種生命週期：ide

  • 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;
 
            }
 
        }
    }

本方法摘自此文

這樣至少有兩個缺點：

  1. Form1中構造函數的依賴注入實例調用泄露在了他的調用層，這不符合6大程序設計原則中的依賴倒置原則；

  2. 當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號攝像頭的安裝時間。

4.最後

原本就想寫篇短文，誰知道洋洋灑灑還寫得有點長。本文若是你們讀了有疑惑，請提出來，我會耐心解答；若是知識點上有不穩當不正確或者不一樣看法的地方，也懇請指出，我同時也很渴望進步。最後祝你們冬至安康，闔家幸福。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程