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

描述
當(dāng)我們安裝完 DotNetCore 3.0 版本的 SDK 后,我們就可以創(chuàng)建基于 DotNetCore 的 WPF 項(xiàng)目模板,通過如下 CLI 可以方便快捷的創(chuàng)建并運(yùn)行我們的項(xiàng)目:
dotnet new wpf -n WpfApp cd WpfApp dotnet restore dotnet run
做過 WPF 開發(fā)的朋友都知道,這個(gè)項(xiàng)目模板肯定不符合我們的預(yù)期,我們希望我們的項(xiàng)目模板能夠加入 MVVM 的默認(rèn)代碼段,并且能夠和 DotNetCore 緊密合作,這樣豈不是更加方便了嗎? 所以本文使用 MVVM 的一種實(shí)現(xiàn) MvvmLightStd10 來教大家如何創(chuàng)建一個(gè)我們理想的項(xiàng)目模板。
操作
首先,我們基于 DotNetCore 3.0 創(chuàng)建一個(gè)原始的 WPF 項(xiàng)目模板,然后引用如下庫:
- Microsoft.Extensions.DependencyInjection
- MvvmLightLibsStd10
可通過執(zhí)行 cli 命令進(jìn)行安裝
dotnet add package Microsoft.Extensions.DependencyInjection dotnet add package MvvmLightLibsStd10
注:因?yàn)槲覀兪褂昧?DotNetCore,所以我們盡量讓我們安裝的第三方包是基于 .NET Standard 方式來實(shí)現(xiàn)。
然后,嘗試修改我們的這個(gè)項(xiàng)目,把它改成我們以后期望創(chuàng)建的項(xiàng)目模板的樣子。可以參考我的如下修改:
項(xiàng)目結(jié)構(gòu)如下圖所示:

其中,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>();
}
}
}
修改完畢后嘗試編譯運(yùn)行我們的項(xiàng)目,確??梢哉>幾g運(yùn)行。
之后,在我們的項(xiàng)目根目錄 src 下新建一個(gè) .template.config 文件夾,然后在里面新建一個(gè) template.json 文件,進(jìn)行如下示例配置:
{
"$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
}
最后,打開我們的終端,將目錄切換至當(dāng)前項(xiàng)目目錄下(就是 .template.config 所在的目錄),然后執(zhí)行下述安裝操作
dotnet new -i C:\Users\hippieZhou\Desktop\helloworld\wpfapp
此時(shí),我們的項(xiàng)目模板會(huì)被打包到 DotNetCore 的 CLI 中,如下圖所示:

同時(shí),在 C:\Users\hippieZhou.templateengine\dotnetcli\v3.0.100-preview3-010431 目錄下的以 templatecache.json 結(jié)尾的 JSON 文件內(nèi)容也會(huì)發(fā)生修改,會(huì)在 TemplateInfo 結(jié)點(diǎn)下新增一個(gè)如下的節(jié)點(diǎn)內(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
},
注:如果后期我們不慎將我們的模板刪除了,我們通過刪除掉這兩個(gè)文件里面對(duì)應(yīng)的模板節(jié)點(diǎn)就可以在 CLI 中取消應(yīng)用了。
我們可以使用下述操作進(jìn)行測(cè)試一下:
# 使用我們自定義的項(xiàng)目模板,創(chuàng)建 wpf 項(xiàng)目 dotnet new wpf-mvvmlight -n test cd test dotnet restore dotnet run
如果不出意外的話,我們就可以看到這個(gè)項(xiàng)目的代碼段和我們自定義的模板代碼段是一樣的。
如果卸載我們的項(xiàng)目模板可以使用如下命令:
dotnet new -u C:\Users\hippieZhou\Desktop\helloworld\wpfapp
注:我們需要確保我們的自定義模板不能丟失,要不然到時(shí)候就卸載就麻煩了(至少目前看來是這樣的)。
關(guān)于如何將我們的自定義模板可以上傳到 NuGet 供別人下載使用,這里就不做介紹了,具體操作可參考園里介紹如何在 DotNetCore MVC 中打造自己的項(xiàng)目模板方法是一樣的。我在本文中的創(chuàng)建的代碼模板也不會(huì)提交上去,還是等著 MVVMLight 的原作者 Laurent Bugnion 來操刀會(huì)好一些。
總結(jié)
本文介紹了如何通過 DotNet CLI 來創(chuàng)建自定義的 WPF 項(xiàng)目模板。在實(shí)際的使用過程中,CLI 的功能和支持的參數(shù)會(huì)更多,所以感興趣的朋友可以自行研究。
how-to-create-a-dot-net-new-project-template-in-dot-net-core
以上就是本文的全部內(nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
ASP.NET中用js取CheckBoxList中值的方法實(shí)例
用腳本取CheckBoxList中的值,并用"|"將其分開,之后將取到的值放入文本框,返回?cái)?shù)據(jù)庫做添加或者修改2013-07-07
.NET CORE中使用AutoMapper進(jìn)行對(duì)象映射的方法
這篇文章主要給大家介紹了關(guān)于.NET CORE中使用AutoMapper進(jìn)行對(duì)象映射的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用.NET CORE具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
ASP.NET下將Excel表格中的數(shù)據(jù)規(guī)則的導(dǎo)入數(shù)據(jù)庫思路分析及實(shí)現(xiàn)
今天接到新的需求,要求將Excel表格中的數(shù)據(jù)顯示在頁面上個(gè)人想法:首先是規(guī)則的Excel數(shù)據(jù)導(dǎo)入,再有就是不規(guī)則的Excel數(shù)據(jù)導(dǎo)入,還有就是根據(jù)數(shù)據(jù)生成Excel2013-01-01
ASP.NET存儲(chǔ)過程實(shí)現(xiàn)分頁效果(三層架構(gòu))
這篇文章主要為大家詳細(xì)介紹了ASP.NET存儲(chǔ)過程實(shí)現(xiàn)分頁,利用三層架構(gòu)實(shí)現(xiàn)分頁效果,有參考價(jià)值的一篇文章,感興趣的小伙伴們可以參考一下2016-05-05
.net?6?配置QuartZ定時(shí)任務(wù)的過程
這篇文章主要介紹了.net?6?配置QuartZ定時(shí)任務(wù)的過程,在VS2022中,通過Nuget包管理器安裝Quartz?3.8.1 ,這是.net 6 依賴的最高版本,在此記錄學(xué)習(xí)一下,需要的朋友可以參考下2024-04-04
Biwen.Settings如何添加對(duì)IConfiguration&IOptions的集成支持
Biwen.Settings?是一個(gè)簡(jiǎn)易的配置項(xiàng)管理模塊,主要的作用就是可以校驗(yàn)并持久化配置項(xiàng),比如將自己的配置存儲(chǔ)到數(shù)據(jù)庫中,JSON文件中等,這篇文章主要介紹了Biwen.Settings如何添加對(duì)IConfiguration&IOptions的集成支持,需要的朋友可以參考下2024-05-05
Grid或者DataTable中數(shù)據(jù)導(dǎo)出為Excel原來這么簡(jiǎn)單
以前一直認(rèn)為,將Grid 或者DataTable中的數(shù)據(jù)導(dǎo)出到Excel功能實(shí)現(xiàn)會(huì)非常復(fù)雜,可能會(huì)想用什么類庫什么的或者實(shí)在太難就用csv算了,沒想到真的很簡(jiǎn)單,需要了解的朋友可以參考下2012-12-12
關(guān)于兩個(gè)自定義控件的取值問題及接口的應(yīng)用
一個(gè).aspx的頁面中,用到了兩個(gè)用戶控件,其中想做的到A控件有一個(gè)按鈕,點(diǎn)擊的時(shí)候獲取到B控件中的一個(gè)textbox的值想必大家會(huì)使用findcontrol獲取控件吧,而在生成的時(shí)候名字是不確定的,那么如何書寫呢?接下來為您提供詳細(xì)的解決方法,感興趣的朋友可以了解下啊2013-01-01

