如何開源跨平臺運行服務插件TaskCoreMainForm

這期內容當中小編將會給大家帶來有關如何開源跨平臺運行服務插件TaskCoreMainForm，文章內容豐富且以專業的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

. 框架結構介紹及運行效果圖

首先，咋們先來認識下項目源碼的工程目錄結構如圖：

結構看上去應該夠清晰了，源碼文件量也很少，不過的確實現了動態加載程序集dll來執行任務，后面會給出相應的執行截圖，我們再來看下TaskCore.MainForm項目通過vs2015生成之后Bin文件夾中的文件如圖：

如果安裝了.netcore sdk的話在windows上您只需要上面截圖的文件就能運行插件了；再來我們在已經安裝過core sdk的win7系統上執行一下如下命令dotnet TaskCore.MainForm.dll就能看到如圖的效果:

沒錯這就是插件運行起來的效果圖，因為.netcore現目前暫時沒有提供類似于winform那樣的皮膚界面效果，所有只能通過命令行來做跨平臺運行程序

. 如何生成nuget包和使用TaskCore.MainForm

首先，我們要明確服務是由兩部分構成（TaskCore.MainForm和TaskCore.Plugin）；TaskCore.MainForm主要用來運行程序，TaskCore.Plugin用來作為子任務需要繼承的父類插件；當我們下載TaskCore.MainForm運行包之后（如圖2結構），我們還需要做的就是繼承TaskCore.Plugin.dl中的TPlugin這個類，來重寫自己的任務內容，因此我們新建一個項目取名為：TaskCore.Test，再來我們通過vs2015引用功能直接添加TaskCore.MainForm運行包中的TaskCore.Plugin.dl引用，這個時候會提示一個錯誤：

錯誤意思是沒法加載netcore版本的dll，因此這種直接在vs項目中引用方式添加dll依賴不行，需要通過nuget來添加依賴包（.netcore對類庫的引用目前只能通過nuget來安裝依賴，這個需要注意），所以我這里把TaskCore.Plugin項目通過dotnet pack命令來生成nuget包，然后以便我TaskCore.Test項目中來使用；

如何生成nuget包(win7系統dotnet命令來生成包的過程和下載)：

直接在vs中右鍵您需要打包的類庫項目-》選擇"在資源管理器中打開文件夾"-》這樣就到了您類庫的根目錄，然后退到類庫根目錄的上一級文件夾中-》按住鍵盤”shift"鍵并同時鼠標右鍵要打包類庫的項目文件件（我這里是TaskCore.Plugin文件夾）-》選擇“在此處打開命令窗體” 這個時候就進入了cmd命令窗體，當然有些朋友直接喜歡直接先cmd再來找對應的磁盤，反正我覺得第一種更快點（不同人不同選擇吧），下面看下操作截圖:

由上圖可以看到，通過命令生成了nupkg文件，這文件就是咋們需要在項目中下載安裝的TaskCore.Plugin插件包；接下來我們來在TaskCore.Test項目中安裝這個插件如下步奏，右鍵TaskCore.Plugin項目中的“引用”-》選擇“管理nuget程序包”-》然后選擇右上角的這個圖標

-》選擇“Nuget包管理器”-》“程序包源”-》

-》然后選擇新創建的包源，下面設置如圖

這里的“源(S)”指定的本地路徑就是剛才我們生成的nupkg文件文件的磁盤（當然我這里是吧剛才pack命令生成的文件復制到了MyNugPackage文件夾中方便測試）-》然后點擊”確定“按鈕-》然后在返回到

選擇我們的包源MyNugPackage-》再瀏覽這里就能看到我們創建的nuget包了

-》選擇并安裝-》好安裝好后我們可以查看“引用”下面有了如下變化

并且project.json文件中自動添加了依賴項：

好了到我們的TaskCore.Test項目中就可以使用Task.Plugin包里面的方法很類等信息了；

使用TaskCore.MainForm：

由上面的操作TaskCore.Test項目已經安裝了Task.Plugin包，那么我們在項目中分別創建3個子類并繼承自Task.Plugin包的父類TPlugin并重寫方法TPlugin_Load()，對應文件名稱分別為：BlogsObj.cs，BlogsObj01.cs，BlogsObj02.cs，分別添加入下代碼內容：

BlogsObj.cs：

namespace TaskCore.Test
{
 // This project can output the Class library as a NuGet Package.
 // To enable this option, right-click on the project and select the Properties menu item. In the Build tab select "Produce outputs on build".
 public class BlogsObj : TPlugin
 {
  public BlogsObj()
  {

  }

  public override void TPlugin_Load()
  {
   var sbLog = new StringBuilder(string.Empty);
   try
   {
    sbLog.Append($"這里是BlogsObj，獲取配置文件：{this.XmlConfig.Name}");

    //代碼塊
    //

    new WriteLog()._WriteLog($"{DateTime.Now}測試引用nuget包");

   }
   catch (Exception ex)
   {
    sbLog.Append($"異常信息：{ex.Message}");
   }
   finally
   {

    PublicClass._WriteLog(sbLog.ToString(), this.XmlConfig.Name);
   }
  }
 }
}

BlogsObj01.cs：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using TaskCore.Plugin;

namespace TaskCore.Test
{
 // This project can output the Class library as a NuGet Package.
 // To enable this option, right-click on the project and select the Properties menu item. In the Build tab select "Produce outputs on build".
 public class BlogsObj01 : TPlugin
 {
  public BlogsObj01()
  {

  }

  public override void TPlugin_Load()
  {
   var sbLog = new StringBuilder(string.Empty);
   try
   {
    sbLog.Append($"這里是BlogsObj01，獲取配置文件：{this.XmlConfig.Name}");

    //代碼塊
    //
   }
   catch (Exception ex)
   {
    sbLog.Append($"異常信息：{ex.Message}");
   }
   finally
   {
    //Console.WriteLine($"這里是Blogs，獲取配置文件：{this.XmlConfig.Name}");
    PublicClass._WriteLog(sbLog.ToString(), this.XmlConfig.Name);
   }
  }
 }
}

BlogsObj02.cs：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using TaskCore.Plugin;

namespace TaskCore.Test
{
 // This project can output the Class library as a NuGet Package.
 // To enable this option, right-click on the project and select the Properties menu item. In the Build tab select "Produce outputs on build".
 public class BlogsObj02 : TPlugin
 {
  public BlogsObj02()
  {

  }

  public override void TPlugin_Load()
  {
   //Console.WriteLine($"這里是Blogs，獲取配置文件：{this.XmlConfig.Name}");
   PublicClass._WriteLog($"這里是BlogsObj02，獲取配置文件：{this.XmlConfig.Name}", this.XmlConfig.Name);
  }
 }
}

好了測試代碼寫完，咋們生成一下，然后把這個TaskCore.Test.dll拷貝到TaskCore.MainForm運行包中，還需要在PluginXml文件夾中分別創建繼承TPlugin的子類的配置文件對應的截圖如（注：這里xml配置文件名稱必須和子類名稱一樣）：

配置文件內容如BlogsObj.xml：

<!--
 1.xml配置模板
 2.utf-8文件
 3.復制到程序根目錄下面PluginXml文件夾下
 4.每個任務建議創建和程序dll名稱相同xml配置文件
-->
<TaskMain>
 <!--固定：執行任務時間計時器（分鐘）-->
 <Timer>1</Timer>
 <!--固定：任務名稱-->
 <Name>獲取博客信息</Name>
 <!--固定：賬號-->
 <UserName></UserName>
 <!--固定：密碼-->
 <UserPwd></UserPwd>
 <!--固定：key-->
 <ApiKey></ApiKey>
 <!--固定：key-->
 <ApiUrl></ApiUrl>
 <!--固定：是否關閉任務 1:是 0：否-->
 <CloseTask>0</CloseTask>
 
<!--固定：描述-->
 <Des>獲取博客信息</Des>
 <!--自定義：其他配置信息-->
 <Other>
 <ShenNiuBuXing3>神牛步行3</ShenNiuBuXing3>
 </Other>
</TaskMain>

最后在CrossFiles.xml配置文件中添加TaskCore.Test.dll文件名稱如：

<!--
 CrossFiles指定對應任務的dll文件，必須存在的文件
-->
<TaskMain>
 <File>TaskCore.Test.dll</File>
</TaskMain>

好了完成了，我們在windows開發環境上運行看下效果圖：

到這里我們來簡單總結下怎么使用TaskCore.MainForm插件，在自己項目中安裝TaskCore.Plugin的nuget包-》重寫父類TPlugin的TPlugin_Load()方法-》生成自己的項目，拷貝項目的dll到TaskCore.MainForm運行包中-》在運行包中PluginXml文件夾中增加任務子類相同類名的xml文件并配置如上的配置信息-》增加CrossFiles.xml中的任務dll文件配置-》使用命令dotnet TaskCore.MainForm.dll運行服務插件，挺簡單的吧

. win7和ubuntu16.04運行TaskCore.MainForm的兩種方式和測試截圖（也可認為.netcore項目在win7和ubuntu系統運行的兩種方式）

由于環境影響，這里跨平臺運行測試我只測試win7和ubuntu16.04，其他系統的發布測試希望朋友們在使用過程中得到結果告知我下謝謝；先來講在win7中運行：

1. 安裝了netcore sdk環境的發布運行

安裝了sdk后直接可以在cmd命令中dotnet TaskCore.MainForm.dll來運行服務，開篇上面講解的示例都是在安裝了sdk后的截圖，服務運行所需要的文件如圖：

就只有這些文件(當然程序需要的某些平臺依賴項使用的是安裝的sdk中的文件，所以看起來很少實際應該包含netcore sdk里面的文件才能運行)，通過命令運行的效果圖：

2. 未安裝netcore sdk環境的發布運行

在為安裝sdk平臺上系統上運行才是重點，這樣才可以說是跨平臺；首先，為了更好看效果我們復制一份如圖的兩個文件到TaskCore.MainForm01文件夾中：

沒錯，只需要這兩個文件，然后我們需要修改project.json文件的內容如下注釋的地方：

{
 "version": "1.0.0-*",
 "buildOptions": {
 "emitEntryPoint": true
 },

 "dependencies": {
 "Microsoft.NETCore.App": {
  //"type": "platform", 跨平臺發布需要注釋
  "version": "1.0.0"
 },
 "System.IO.FileSystem": "4.0.1",
 "System.Reflection": "4.1.0",
 "System.Text.Encoding.CodePages": "4.0.1",
 "System.Threading.Timer": "4.0.1",
 "System.Xml.XDocument": "4.0.11",
 "TaskCore.Plugin": "1.0.0"
 },

 "frameworks": {
 "netcoreapp1.0": {
  "imports": "dnxcore50"
 }
 },
 //跨平臺發布需要添加如下節點
 "runtimes": {
 "ubuntu.16.04-x64": { }, //運行在ubuntu.16.04的64位系統
 "win7-x64": { } //運行在win7的64位系統
 }
}

然后使用cmd分別錄入并回車運行指令dotnet restore此時TaskCore.MainForm01文件夾中會自動生成一個project.lock.json文件(大家注意看下)，然后再錄入指令dotnet publish -r win7-x64，可以看到命令窗信息如：

就表示成功了，并且有返回生成運行文件的路徑，我們按照路徑找到生成的文件publish文件夾，里面沒有PluginXml配置文件夾和配置文件和測試項目TaskCore.Test.dll，我們為了方便直接復制上面配置好的配置文件到publish文件夾中如下截圖就是生成的發布文件：

沒錯TaskCore.MainForm01.exe這個就是自動生成的運行文件，然后我們雙擊運行效果圖：

運行成功了，有朋友會問您之前系統不是安裝了sdk么，這種測試能算么，我想說的是這個我通過QQ發給qq群里面的朋友@南宮亦琦（不要怪我貼出了您的昵稱）測試過了，她沒有安裝過sdk的；

ubuntu16.04運行：

1. 安裝了netcore sdk環境的發布運行

首先，我們需要把在win7上生成的項目復制到ubuntu系統磁盤中(我們使用上面配置好的TaskCore.MainForm包)，我這里采用共享目錄的方式把文件拷貝到ubuntu系統磁盤上，如圖：

然后，鼠標右鍵點擊空白地方，選擇“在終端打開”，然后在窗體中錄入如下指令dotnet TaskCore.MainForm.dll，能看到如下運行起的結果：

這個命令方式是不是很上面win7上的方式很相同，本來就是一樣的，只要安裝了.netcore sdk這種方式幾乎可以共用

2. 未安裝netcore sdk環境的發布運行

不安裝sdk環境運行才是咋們需要關注的，下面就來看下怎么生成再ubuntu系統上能運行的文件；我們復制一份上面的TaskCore.MainForm01項目到TaskCore.MainForm02中來測試，由于之前我們在講生成win7執行文件時候，執行了命令dotnet restore和dotnet publish -r win7-x64命令所以文件中有project.lock和bin文件夾，為了測試我們需要刪除掉部分文件，只剩下如圖文件，這里需要注意的是之前已經配置過project.xml我們無需在修改了：

然后，分別執行和生成win7運行文件幾乎相同的命令dotnet restore和dotnet publish -r ubuntu.16.04-x64不同之處在于生成的文件存放的位置不同和使用的運行環境不同，運行結果如圖：

publish文件夾中的文件就是在ubuntu系統執行的文件，然后我們需要把任務配置文件夾PluginXml和測試項目TaskCore.Test.dll復制到該目錄中，再來咋們通過共享吧TaskCore.MainForm02目錄中的publish復制到ubuntu中；然后我們需要把TaskCore.MainForm02可執行文件設置下權限，鼠標右鍵點擊TaskCore.MainForm02可執行文件，選擇“屬性”，再選擇“權限”選項卡，勾選“允許作為程序執行”，如圖：

然后，我們右鍵文件夾中空白處，選擇“在終端打開”，再執行如下命令./TaskCore.MainForm02，最后看運行效果圖：

好了，發布在ubuntu系統上執行文件和運行的步奏就這些，幾乎和win7上相同

. 框架代碼解讀及感悟

怎么使用跨平臺TaskCore.MainForm任務框架講解完了，下面來具體看下主要代碼Program.cs文件中：

namespace TaskCore.MainForm
{
 /// <summary>
 /// author 神牛步行3
 /// contact 841202396@qq.com
 /// des TaskCore.MainForm跨平臺插件由神牛步行3提供
 /// </summary>
 public class Program
 {

  private static Dictionary<string, MoAssembly> dicTasks = new Dictionary<string, MoAssembly>();

  public static void Main(string[] args)
  {
   //注冊編碼，防止亂碼
   Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);

   //初始化程序集文件
   _Init();

   //是否繼續開啟任務，默認沒有待執行任務，不提示
   if (dicTasks.Count <= 0) { _LoopAlert("是否退出？(Y/N)"); return; }
   _LoopAlert("是否開始執行任務？(Y / N)");

   //執行任務
   foreach (var item in dicTasks.Values)
   {
    //使用Task防止異常后相互影響
    Task.Run(() =>
    {
     try
     {

      //創建任務對象
      var tp = item.Asm.CreateInstance(item.FullName) as TPlugin;
      if (!string.IsNullOrEmpty(tp.XmlConfig.TpError)) { _Alert($"{DateTime.Now.ToString("yyyy/MM/dd HH:mm")}：{tp.XmlConfig.Name} - 異常信息：{tp.XmlConfig.TpError}"); }
      else
      {

       //timer定時器
       var timer = new Timer((param) =>
       {
        var msg = $"{DateTime.Now.ToString("yyyy/MM/dd HH:mm")}：{tp.XmlConfig.Name}";
        try
        {
         var tpObj = param as TPlugin;
         //是否關閉暫停任務
         if (tpObj.XmlConfig.CloseTask) { return; }
         _Alert($"{msg} - 開始執行...{tp.XmlConfig.Timer}分鐘一次");
         //任務入口
         tpObj.TPlugin_Load();
        }
        catch (Exception ex) { _Alert($"{msg} - 異常信息：{ex.Message}"); }
       }, tp, 0, 1000 * 60 * tp.XmlConfig.Timer);
      }

     }
     catch (Exception ex)
     {
      _Alert($"{DateTime.Now.ToString("yyyy/MM/dd HH:mm")}：{item.Name} - 異常信息：{ex.Message}");
     }
    });
   }
   _LoopAlert("正在監控執行的任務，是否退出？(Y / N)");
  }

  /// <summary>
  /// 初始化程序集文件
  /// </summary>
  private static void _Init()
  {
   try
   {

    _Alert("初始化任務中...");
    //獲取文件
    var files = PublicClass._GetPluginFile("");
    if (files.Length <= 0) { _Alert("未能找到可用的程序集,請檢查配置"); return; }

    //讀取任務文件
    _Alert("讀取CrossFiles.xml配置中...");
    var baseAddr = Path.Combine(Directory.GetCurrentDirectory(), "PluginXml", "CrossFiles.xml");
    var doc = XDocument.Load(baseAddr);
    var fileables = files.AsEnumerable();
    var taskFiles = new List<FileInfo>();
    foreach (var item in doc.Root.Nodes())
    {
     var crossFile = item.ToString().ToUpper();
     var choiceFiles = fileables.Where(b => crossFile.Contains(b.Name.ToUpper()));
     if (!choiceFiles.Any()) { continue; }

     taskFiles.AddRange(choiceFiles);
    }

    //展示文件信息
    _Alert($"待遍歷{taskFiles.Count}個文件信息...");
    foreach (var item in taskFiles.OrderBy(b => b.CreationTime))
    {
     var asmName = new AssemblyName($"{item.Name.Replace(".dll", "")}");
     Assembly sm = Assembly.Load(asmName);
     if (sm == null) { continue; }
     var ts = sm.GetTypes();
     //判斷特定的任務類，加入任務dic
     foreach (var t in ts.Where(b => b.Name != "TPlugin" && b.GetMethod("TPlugin_Load") != null))
     {

      dicTasks.Add(
       t.FullName,
       new MoAssembly
       {
        Asm = sm,
        FullName = t.FullName,
        Name = t.Name
       });
     }
    }
    _Alert($"獲取待執行任務量：{dicTasks.Count}個");
   }
   catch (Exception ex)
   {
    _Alert($"異常信息：{ ex.Message}");
   }
  }

  /// <summary>
  /// 消息提醒
  /// </summary>
  /// <param name="msg">提示信息</param>
  /// <param name="isReadLine">是否需要用戶輸入指令</param>
  /// <returns>用戶錄入的指令</returns>
  private static string _Alert(string msg = "神牛步行3-消息提醒", bool isReadLine = false)
  {
   Console.WriteLine(msg);
   if (isReadLine) { return Console.ReadLine(); }
   return "";
  }

  private static void _LoopAlert(string msg = "是否開始執行任務？(Y/N)")
  {
   do
   {
    var readKey = _Alert(msg, true);
    if (readKey.ToUpper().Contains("Y")) { break; }
   } while (true);
  }
 }

 public class MoAssembly
 {
  public Assembly Asm { get; set; }
  public string FullName { get; set; }

  public string Name { get; set; }
 }
}

TPlugin.cs文件中代碼：

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using System.Xml.Linq;

namespace TaskCore.Plugin
{
 /// <summary>
 /// 插件基類
 /// </summary>
 public class TPlugin : IDisposable
 {

  public TPlugin()
  {

   XmlConfig = _InitConfig();
  }

  #region 初始化Xml配置文件 _InitConfig +XmlConfig

  /// <summary>
  /// xml配置信息
  /// </summary>
  public XmlConfig XmlConfig;


  /// <summary>
  /// 初始化配置信息
  /// </summary>
  /// <param name="configPath">配置文件對應路徑</param>
  /// <returns></returns>
  public virtual XmlConfig _InitConfig(string configPath = "")
  {
   XmlConfig config = new XmlConfig();
   config.Timer = 1;
   config.Name = this.GetType().Name;
   try
   {

    if (string.IsNullOrEmpty(configPath))
    {

     //默認各個dllXml配置
     var defaultConfigFolder = "PluginXml";
     var baseAddr = Directory.GetCurrentDirectory();
     configPath = Path.Combine(baseAddr, defaultConfigFolder, config.Name + ".xml");
    }

    var doc = XDocument.Load(configPath);
    config.doc = doc;
    var taskMain = doc.Root;

    config.Timer = Convert.ToInt32(taskMain.Element(XName.Get("Timer", "")).Value);
    config.Name = taskMain.Element(XName.Get("Name", "")).Value;
    config.Des = taskMain.Element(XName.Get("Des", "")).Value;

    config.UserName = taskMain.Element(XName.Get("UserName", "")).Value;
    config.UserPwd = taskMain.Element(XName.Get("UserPwd", "")).Value;
    config.ApiKey = taskMain.Element(XName.Get("ApiKey", "")).Value;
    config.ApiUrl = taskMain.Element(XName.Get("ApiUrl", "")).Value;
    config.CloseTask = taskMain.Element(XName.Get("CloseTask", "")).Value == "1";

   }
   catch (Exception ex)
   {
    config.TpError = ex.Message;
    PublicClass._WriteLog($"{config.Name}初始化配置信息異常：{ex.Message}", "BaseLog");
    throw new Exception(ex.Message);
   }
   return config;
  }
  #endregion

  #region 初始化-開始加載 _Load

  /// <summary>
  /// 初始化-開始起
  /// </summary>
  public virtual void TPlugin_Load()
  {

   PublicClass._WriteLog("測試");
  }

  #endregion

  #region 釋放資源

  public void Dispose()
  {

   GC.SuppressFinalize(this);//不需要再調用本對象的Finalize方法
  }

  public virtual void Dispose(Action action)
  {

   action();
  }

  #endregion
 }

 #region 配置文件 XmlConfig

 public class XmlConfig
 {
  public XmlConfig()
  {

  }

  /// <summary>
  /// 定制器時間（分鐘）
  /// </summary>
  public int Timer { get; set; }

  /// <summary>
  /// 運行名稱
  /// </summary>
  public string Name { get; set; }

  /// <summary>
  /// 描述(第一次獲取dll描述，后面獲取xml配置文件描述)
  /// </summary>
  public string Des { get; set; }

  /// <summary>
  /// 接口賬號
  /// </summary>
  public string UserName { get; set; }

  /// <summary>
  /// 接口密碼
  /// </summary>
  public string UserPwd { get; set; }

  /// <summary>
  /// 接口秘鑰
  /// </summary>
  public string ApiKey { get; set; }

  /// <summary>
  /// 接口地址
  /// </summary>
  public string ApiUrl { get; set; }

  /// <summary>
  /// 是否關閉任務
  /// </summary>
  public bool CloseTask { get; set; }

  /// <summary>
  /// 插件中錯誤
  /// </summary>
  public string TpError { get; set; }


  /// <summary>
  /// xml信息
  /// </summary>
  public XDocument doc { get; set; }
 }

 #endregion
}

具體的說明和邏輯處理代碼中都有注釋，各位可以詳細看下；這里要訴說的是該框架主要原理是動態加載任務dll來創建對象，netcore的程序集類Assembly不像framework里面的Assembly一樣那么多可以用方法，我這里用的Assembly.Load()，netcore只能加載當前系統根目錄的dll（這里我花了幾個小時測試，有不同結果的朋友，請及時聯系我謝謝），框架使用Task.Run()方法創建不同任務，實現并行執行的效果，并且各個容易出錯地方使用try...catch來容錯，避免了某個子任務異常后，導致框架全部中斷運行，個人覺得其實還是不錯的是吧；

下面給出幾個不同環境下的壓縮包，以供使用和參考：

TaskCore.MainForm-純文件 TaskCore.MainForm01 git源碼地址

上述就是小編為大家分享的如何開源跨平臺運行服務插件TaskCoreMainForm了，如果剛好有類似的疑惑，不妨參照上述分析進行理解。如果想知道更多相關知識，歡迎關注億速云行業資訊頻道。