詳解使用DotNet CLI創(chuàng)建自定義的WPF項目模板

更新時間：2019年04月15日 10:30:48 作者：http://www.cnblogs.com/hippieZhou/p/10691339.html

這篇文章主要介紹了詳解使用DotNet CLI創(chuàng)建自定義的WPF項目模板，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

本文主要介紹了使用DotNet CLI創(chuàng)建自定義的WPF項目模板，分享給大家，具體如下：

描述

當我們安裝完 DotNetCore 3.0 版本的 SDK 后，我們就可以創(chuàng)建基于 DotNetCore 的 WPF 項目模板，通過如下 CLI 可以方便快捷的創(chuàng)建并運行我們的項目：

dotnet new wpf -n WpfApp
cd WpfApp
dotnet restore
dotnet run

做過 WPF 開發(fā)的朋友都知道，這個項目模板肯定不符合我們的預期，我們希望我們的項目模板能夠加入 MVVM 的默認代碼段，并且能夠和 DotNetCore 緊密合作，這樣豈不是更加方便了嗎？所以本文使用 MVVM 的一種實現(xiàn) MvvmLightStd10 來教大家如何創(chuàng)建一個我們理想的項目模板。

操作

首先，我們基于 DotNetCore 3.0 創(chuàng)建一個原始的 WPF 項目模板，然后引用如下庫：

Microsoft.Extensions.DependencyInjection
MvvmLightLibsStd10

可通過執(zhí)行 cli 命令進行安裝

dotnet add package Microsoft.Extensions.DependencyInjection
dotnet add package MvvmLightLibsStd10

注：因為我們使用了 DotNetCore，所以我們盡量讓我們安裝的第三方包是基于 .NET Standard 方式來實現(xiàn)。

然后，嘗試修改我們的這個項目，把它改成我們以后期望創(chuàng)建的項目模板的樣子。可以參考我的如下修改：

項目結構如下圖所示：

其中，src\Models\DataItem.cs 的示例代碼如下所示：

using System;
using System.Collections.Generic;
using System.Text;

namespace WpfApp.Models
{
  public class DataItem
  {
    public string Title { get; private set; }

    public DataItem(string title)
    {
      Title = title;
    }
  }
}

src\Models\IDataService.cs 的示例代碼如下所示：

using System;
using System.Collections.Generic;
using System.Text;

namespace WpfApp.Models
{
  public interface IDataService
  {
    void GetData(Action<DataItem, Exception> callback);
  }
}

src\Models\DataService.cs 的示例代碼如下所示：

using System;
using System.Collections.Generic;
using System.Text;

namespace WpfApp.Models
{
  public class DataService : IDataService
  {
    public void GetData(Action<DataItem, Exception> callback)
    {
      var item = new DataItem("Hello .NET Core!");
      callback(item, null);
    }
  }
}

src\ViewModels\MainViewModel.cs 的示例代碼如下所示：

using GalaSoft.MvvmLight;
using WpfApp.Models;

namespace WpfApp.ViewModels
{
  public class MainViewModel : ViewModelBase
  {
    private readonly IDataService _dataService;

    private string _welcomeTitle;
    public string WelcomeTitle
    {
      get { return _welcomeTitle; }
      set { Set(ref _welcomeTitle, value); }
    }

    public MainViewModel(IDataService dataService)
    {
      _dataService = dataService;
       _dataService.GetData(
        (item, error) =>
        {
          if (error != null)
          {
            return;
          }

          WelcomeTitle = item.Title;
        });
    }
  }
}

src\Views\MainView.xaml 的示例代碼如下所示：

<Window
  x:Class="WpfApp.Views.MainView"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:local="clr-namespace:WpfApp"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  Title="MainWindow"
  Width="800"
  Height="450"
  mc:Ignorable="d">
  <Grid>
    <Label
      HorizontalAlignment="Center"
      VerticalAlignment="Center"
      Content="{Binding WelcomeTitle}"
      FontSize="40" />
  </Grid>
</Window>

src\Views\MainView.xaml.cs 的示例代碼如下所示：

using System.Windows;
using WpfApp.ViewModels;

namespace WpfApp.Views
{
  public partial class MainView : Window
  {
    public MainView(MainViewModel vm)
    {
      InitializeComponent();
      this.DataContext = vm;
    }
  }
}

src\App.xaml 的示例代碼如下所示：

<Application
  x:Class="WpfApp.App"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:local="clr-namespace:WpfApp" />

src\App.xaml.cs 的示例代碼如下所示：

using Microsoft.Extensions.DependencyInjection;
using System.Windows;
using WpfApp.Models;
using WpfApp.ViewModels;
using WpfApp.Views;

namespace WpfApp
{
  public partial class App : Application
  {
    public ServiceProvider ServiceProvider { get; private set; }

    protected override void OnStartup(StartupEventArgs e)
    {
      base.OnStartup(e);

      var serviceCollection = new ServiceCollection();
      ConfigureServices(serviceCollection);

      ServiceProvider = serviceCollection.BuildServiceProvider();

      var mainWindow = ServiceProvider.GetRequiredService<MainView>();
      mainWindow.Show();
    }

    private void ConfigureServices(ServiceCollection services)
    {
      services.AddTransient<MainView>();
      services.AddTransient<MainViewModel>();

      services.AddScoped<IDataService, DataService>();
    }
  }
}

修改完畢后嘗試編譯運行我們的項目，確保可以正常編譯運行。

之后，在我們的項目根目錄 src 下新建一個 .template.config 文件夾，然后在里面新建一個 template.json 文件，進行如下示例配置：

{
  "$schema": "http://json.schemastore.org/template",
  "author": "hippiezhou <hippiezhou@outlook.com>",
  "classifications": ["wpf", "mvvmlight", "Dependency Injection"],
  "name": "wpf mvvmlight: use dotnetcore to create wpf with mvvmlight.",
  "tags": {
    "language": "C#",
    "type": "project"
  },
  "identity": "wpf.mvvmlight",
  "shortName": "wpf-mvvmlight",
  "sourceName": "wpf.mvvmlight",
  "preferNameDirectory": true
}

最后，打開我們的終端，將目錄切換至當前項目目錄下（就是 .template.config 所在的目錄），然后執(zhí)行下述安裝操作

dotnet new -i C:\Users\hippieZhou\Desktop\helloworld\wpfapp

此時，我們的項目模板會被打包到 DotNetCore 的 CLI 中，如下圖所示：

同時，在 C:\Users\hippieZhou.templateengine\dotnetcli\v3.0.100-preview3-010431 目錄下的以 templatecache.json 結尾的 JSON 文件內(nèi)容也會發(fā)生修改，會在 TemplateInfo 結點下新增一個如下的節(jié)點內(nèi)容：

 {
   "ConfigMountPointId": "f3861181-7a43-4fc5-ab1c-12d95e734c0a",
   "Author": "hippiezhou <hippiezhou@outlook.com>",
   "Classifications": [
    "wpf",
    "mvvmlight",
    "Dependency Injection"
   ],
   "DefaultName": null,
   "Description": "",
   "Identity": "wpf.mvvmlight",
   "GeneratorId": "0c434df7-e2cb-4dee-b216-d7c58c8eb4b3",
   "GroupIdentity": "",
   "Precedence": 0,
   "Name": "wpf mvvmlight: use dotnetcore to create wpf with mvvmlight.",
   "ShortNameList": [
    "wpf-mvvmlight"
   ],
   "Tags": {
    "language": {
     "Description": null,
     "ChoicesAndDescriptions": {
      "C#": ""
     },
     "DefaultValue": "C#"
    },
    "type": {
     "Description": null,
     "ChoicesAndDescriptions": {
      "project": ""
     },
     "DefaultValue": "project"
    }
   },
   "CacheParameters": {
    "name": {
     "DataType": "string",
     "DefaultValue": null,
     "Description": "The default name symbol"
    }
   },
   "ConfigPlace": "/.template.config/template.json",
   "LocaleConfigMountPointId": "00000000-0000-0000-0000-000000000000",
   "LocaleConfigPlace": null,
   "HostConfigMountPointId": "00000000-0000-0000-0000-000000000000",
   "HostConfigPlace": null,
   "ThirdPartyNotices": null,
   "BaselineInfo": {},
   "HasScriptRunningPostActions": false,
   "ConfigTimestampUtc": null
},

注：如果后期我們不慎將我們的模板刪除了，我們通過刪除掉這兩個文件里面對應的模板節(jié)點就可以在 CLI 中取消應用了。

我們可以使用下述操作進行測試一下：

# 使用我們自定義的項目模板，創(chuàng)建 wpf 項目
dotnet new wpf-mvvmlight -n test

cd test

dotnet restore

dotnet run

如果不出意外的話，我們就可以看到這個項目的代碼段和我們自定義的模板代碼段是一樣的。

如果卸載我們的項目模板可以使用如下命令：

dotnet new -u C:\Users\hippieZhou\Desktop\helloworld\wpfapp

注：我們需要確保我們的自定義模板不能丟失，要不然到時候就卸載就麻煩了（至少目前看來是這樣的）。

關于如何將我們的自定義模板可以上傳到 NuGet 供別人下載使用，這里就不做介紹了，具體操作可參考園里介紹如何在 DotNetCore MVC 中打造自己的項目模板方法是一樣的。我在本文中的創(chuàng)建的代碼模板也不會提交上去，還是等著 MVVMLight 的原作者 Laurent Bugnion 來操刀會好一些。

總結

本文介紹了如何通過 DotNet CLI 來創(chuàng)建自定義的 WPF 項目模板。在實際的使用過程中，CLI 的功能和支持的參數(shù)會更多，所以感興趣的朋友可以自行研究。

打造自己的.NET Core項目模板

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

DotNetCore深入了解之HttpClientFactory類詳解

ASP.NET MVC+EF框架+EasyUI實現(xiàn)權限管系列
在學習MVC之前，我們有必要知道這些知識點（自動屬性，隱式類型var，對象初始化器和集合初始化器，匿名類，擴展方法，Lambda表達式），如果你還不知道的話就請看我下面的簡單的介紹，看下面我建立的項目的初步圖像，然后下篇我們開始簡單的介紹。
2014-11-11
獲取asp.net服務器控件的客戶端ID和Name的實現(xiàn)方法
下面小編就為大家?guī)硪黄@取asp.net服務器控件的客戶端ID和Name的實現(xiàn)方法。小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-05-05
有潛在危險的 Request.Form 值避免方法
在 .net framework 4.0中在 system.web 中加上httpRuntime requestValidationMode="2.0" 這句即可解決，需要的朋友可以了解下
2013-12-12
.net泛型通用函數(shù)的特殊問題的解決方法
本文介紹了.net泛型通用函數(shù)的特殊問題的解決方法，需要的朋友可以參考一下
2013-02-02
ASP.net中獲取客戶端參數(shù)操作系統(tǒng)信息
這篇文章主要介紹了ASP.net中如何獲取客戶端參數(shù)或操作系統(tǒng)信息,需要的朋友可以參考下
2014-03-03
對WPF中Expander控件美化
這篇文章介紹了對WPF中Expander控件美化的方法，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2022-01-01
Asp.net XMLHTTP封裝類(GET,Post發(fā)送和接收數(shù)據(jù))
XMLHTTP封裝類可以向遠程發(fā)送URL和參數(shù),接受返回信息(無亂碼)
2008-11-11
ASP.NET MVC5添加驗證（4）
這篇文章主要介紹了ASP.NET MVC5添加驗證，需要的朋友可以參考下
2015-09-09
asp.net使用FCK編輯器中的分頁符實現(xiàn)長文章分頁功能
這篇文章主要介紹了asp.net使用FCK編輯器中的分頁符實現(xiàn)長文章分頁功能,涉及asp.net字符串及分頁操作的相關技巧,需要的朋友可以參考下
2016-06-06
asp.net網(wǎng)頁里面為什么找不到CS文件
這篇文章主要介紹了asp.net為什么網(wǎng)頁里面找不到CS文件，如何才能夠cs文件顯示出來
2014-05-05