WPF Prism 1 - 首次使用 Prism 開發框架來製作一個 Hello World 教學說明程式

在這篇文章，將會帶領想使用 Prism Library 這套開發框架，使用 MVVM 與許多 Prims 內建的設計模式 Design Pattern 功能，來讓想要了解如何進行 WPF 專案開發的程式設計師有實際練習實作 Hands-on 的參考說明教學。

在這個練習中，將會設計一個 Shell ，其中只有一個 Region ，不過，卻要提供三個按鈕，其中兩個按鈕，可以分別動態的加入所指定 View 到這個 Region 內，如此，將會看到這個視窗的畫面將會有所變化。而另外一個按鈕，將會把 Region 的 View 移除。

在這個練習中，將不會使用到 Module 這項功能，所有的相關設計，都將會在同一個專案 (.NET 組件 Assembly ) 下來開發。

這裡將會是一開始執行的畫面，在該畫面中，實際上是在 MainWindow 這個 Window 元件下所設計的成果，而最上方將會有三個按鈕，而在下方，則是一個 Region 區域，這塊區域將會使用 Prism 提供的機制，可以在執行時期，動態的新增、移除、導航到其他 View 上。

當點選了 Hi 按鈕之後，此時，將會透過 MainWindow 之 ViewModel 類別內(注意，這裡沒有使用到 callbehind 的設計方式，而 ViewModel 的指派，也是透過 Prism 提供 ViewModel Locator 定位器來自動設定完成) 的 DelegateCommand 命令物件進行執行相關委派程式碼，在此，將會透過 RegionManager 這個物件(該物件使用相依性注入的方式，透過建構式來取得該物件，也就是使用了建構式注入方法)來進行動態的指定使用 [MyView] 這個檢視 View 到這個應用程式視窗的下方，如此，將會變成底下的畫面截圖。

第二個按鈕， Thank You ，設計方式如同 Hi 按鈕，只不過在這裡將會 [YourView] 注入到這個視窗的 Region 內。

第三個按鈕，則是更加簡單，那就是把這個 Region 內的 View ，全部都移除，當然，所完成的執行結果就是該視窗下方的 Region 區域，將沒有任何動態內容顯示出來。

更多關於 Blazor 教學影片，可以參考 Blazor 教學影片播放清單或者 Blazor 快速體驗教學影片撥放清單。也歡迎訂閱本 .NET / Blazor / Xamarin.Forms 影片頻道。

這個說明專案的原始碼位於 WPFPrismHelloWorld

準備工作

首先，先要安裝 [Prism Template Pack] 到 Visual Studio 2019 內
打開 Prism Template Pack 擴充功能網站
下載並且安裝這個擴充功能

建立 WPF for Prism 的專案

打開 Visual Studio 2019
點選右下方的 [建立新的專案] 按鈕
[建立新專案] 對話窗將會顯示在螢幕上
從[建立新專案] 對話窗的中間區域，找到 [Prism Blank App (WPF)] 這個專案樣板選項，並且選擇這個項目

若沒有看到這個選項，則表示你的 Visual Studio 2019 開發環境中，還沒有安裝 Prism Template Pack 擴充功能
點選右下角的 [下一步] 按鈕
現在 [設定新的專案] 對話窗將會出現
請在這個對話窗內，輸入適當的 [專案名稱] 、 [位置] 、 [解決方案名稱]

在這裡請輸入 [專案名稱] 為 WPFPrismHelloWorld
在最下方的 [架構] 部分，建議選取最新的 [.NET Framework 4.8]
完成後，請點選 [建立] 按鈕
當出現 [PRISM PROJECT WIZARD] 對話窗的時候
請在 [Select Container] 選擇容器這個欄位之下拉選單，選擇你要使用的 DI 相依性注入容器，我個人習慣使用 Unity 這個 Ioc 容器
之後，點選 [CREATE PROJECT] 這個按鈕

稍微等會一段時間，具有 Prism 開發框架的 WPF 專案將會建立起來

加入兩個 View 與進行容器註冊

首先，滑鼠右擊 [Views] 資料夾
選擇 [加入] > [新增項目]
此時，[新增項目] 對話窗將顯示出來
請在該對話窗的左方，展開節點到 [已安裝] > [Visual C#] > [Prism] > [WPF]
在中間區域選擇 [Prism UserControl (WPF)] 選項
在下方名稱欄位輸入 MyView
最後點選 [新增] 按鈕

此時，將會看到該專案的 [Views] 資料夾內新產生了一個 [MyView.xaml] 這個檔案，另外，在 [ViewModel] 資料夾內也產生了一個 [MyViewViewModel] 這個類別檔案。

打開 [MyView.xaml] 檔案，填入底下 XAML 標記宣告

<UserControl x:Class="WPFPrismHelloWorld.Views.MyView"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:prism="http://prismlibrary.com/"             
             prism:ViewModelLocator.AutoWireViewModel="True">
    <Grid Background="LightGreen">
        <TextBlock Text="Hello World" FontSize="48" Foreground="HotPink"/>
    </Grid>
</UserControl>

接下來，繼續產生一個 YourView 檢視

首先，滑鼠右擊 [Views] 資料夾
選擇 [加入] > [新增項目]
此時，[新增項目] 對話窗將顯示出來
請在該對話窗的左方，展開節點到 [已安裝] > [Visual C#] > [Prism] > [WPF]
在中間區域選擇 [Prism UserControl (WPF)] 選項
在下方名稱欄位輸入 YourView
最後點選 [新增] 按鈕

此時，將會看到該專案的 [Views] 資料夾內新產生了一個 [YourView.xaml] 這個檔案，另外，在 [ViewModel] 資料夾內也產生了一個 [YourViewViewModel] 這個類別檔案。

打開 [YourView.xaml] 檔案，填入底下 XAML 標記宣告

<UserControl x:Class="WPFPrismHelloWorld.Views.YourView"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:prism="http://prismlibrary.com/"             
             prism:ViewModelLocator.AutoWireViewModel="True">
    <Grid Background="Yellow">
        <TextBlock Text="Thank You" FontSize="48" Foreground="LightBlue"/>
    </Grid>
</UserControl>

在該專案根目錄下，找到 App.xaml 這個檔案節點
展開該節點，將會看到一個 [App.xaml.cs] 這個節點
滑鼠雙擊打開 [App.xaml.cs] 這個節點
在 [App.xaml.cs] 檔案內，找到 RegisterTypes 方法
將該方法修改成為底下的程式碼

protected override void RegisterTypes(IContainerRegistry containerRegistry)
{
    containerRegistry.RegisterForNavigation<MyView>(nameof(MyView));
    containerRegistry.RegisterForNavigation<YourView>(nameof(YourView));
}

設計 Shell 頁面架構

在 [Views] 資料夾內，找到並打開 [MainWindow.xaml] 檔案
將底下的 XAML 標記宣告，替換掉這個檔案原先內容

<Window x:Class="WPFPrismHelloWorld.Views.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:prism="http://prismlibrary.com/"
        prism:ViewModelLocator.AutoWireViewModel="True"
        Title="{Binding Title}" Height="350" Width="525">
    <Grid Background="LightGray">
        <Grid.RowDefinitions>
            <RowDefinition Height="50"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>
        <StackPanel
            HorizontalAlignment="Center"
            Orientation="Horizontal">
            <Button Command="{Binding SayHiCommand}" Width="150">Hi</Button>
            <Button Command="{Binding ThankYouCommand}" Width="150">Thank You</Button>
            <Button Command="{Binding RemoveCommand}" Width="150">Remove</Button>
        </StackPanel>
        <ContentControl Grid.Row="1" prism:RegionManager.RegionName="ContentRegion" />
    </Grid>
</Window>

在 [ViewModels] 資料夾內，找到並打開 [MainWindowViewModel.cs] 檔案
使用底下 C# 程式碼替換掉原先內容

using Prism.Commands;
using Prism.Ioc;
using Prism.Mvvm;
using Prism.Regions;
using WPFPrismHelloWorld.Views;

namespace WPFPrismHelloWorld.ViewModels
{
    public class MainWindowViewModel : BindableBase
    {
        private string _title = "Prism Application";
        private readonly IRegionManager regionManager;

        public string Title
        {
            get { return _title; }
            set { SetProperty(ref _title, value); }
        }
        public DelegateCommand SayHiCommand { get; set; }
        public DelegateCommand RemoveCommand { get; set; }
        public DelegateCommand ThankYouCommand { get; set; }
        public MainWindowViewModel(IRegionManager regionManager, IContainerExtension container)
        {
            SayHiCommand = new DelegateCommand(() =>
            {
                IRegion region = regionManager.Regions["ContentRegion"];
                region.RemoveAll();
                var view = container.Resolve<MyView>();
                region.Add(view);
            });
            ThankYouCommand = new DelegateCommand(() =>
            {
                IRegion region = regionManager.Regions["ContentRegion"];
                region.RemoveAll();
                var view = container.Resolve<YourView>();
                region.Add(view);
            });
            RemoveCommand = new DelegateCommand(() =>
            {
                IRegion region = regionManager.Regions["ContentRegion"];
                region.RemoveAll();
            });
        }
    }
}

執行與測試

現在可以執行這個使用 Prism 開發的 WPF 專案，看看是不是如同最初說明一樣的方式來進行運作。

C# .NET Blazor MAUI Xamarin Research

2020年4月13日星期一