WPF框架Prism中導航Navigation用法介紹

2022-02-11 13:00:51

使用場景

在普遍的業務場景當中, 必不可少的是頁面切換, 而Prism就可以使用Navigation功能來進行頁面導航, 在不同的場景當中會有各種用法, 例如在切換頁面驗證、傳遞引數、返回上一頁、返回下一頁等功能。

導航的基本條件

1.註冊顯示區域

2.註冊導航頁面

1.註冊導航

註冊檢視型別或新增別名, 如果為指定別名,名稱預設為當中型別的名稱

public class ModuleAModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {

        }

        public void RegisterTypes(IContainerRegistry containerRegistry)
        {
            //新增別名 "CustomName"
            containerRegistry.RegisterForNavigation<ViewA>("CustomName");
            //預設名稱 "ViewB"
            containerRegistry.RegisterForNavigation<ViewB>();
        }
    }

註冊時,指定ViewModel或新增別名。

 public class ModuleAModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {

        }

        public void RegisterTypes(IContainerRegistry containerRegistry)
        {
            //指定ViewModel
            containerRegistry.RegisterForNavigation<ViewA, ViewAViewModel>();
            //指定ViewModel並且新增別名
            containerRegistry.RegisterForNavigation<ViewB, ViewBViewModel>("CustomName");
        }
    }

2.使用導航

正如前面的章節所講到, Region的註冊以及管理、導航等, 我們可以使用IRegionManager介面,所以,我們現在便可以使用該介面實現導航功能, 如下所示:

IRegionManager regionManager = …;
regionManager.RequestNavigate("RegionName", "ViewName");

可以注意點, 我們呼叫了IRegionManager介面的RequestNavigate方法, 並且傳遞了兩個引數:

RegionName: 該引數為註冊的區域名稱
ViewName: 該引數實際為我們上面註冊過的導航頁, 字串型別, 對應的是我們註冊頁面的nameof

3.帶引數導航

正如,我們想要在導航頁前, 傳遞一些引數, 則可以使用NavigationParameters, 如下所示:

var param = new NavigationParameters();
param.Add("Parameter", param);
_regionManger.RequestNavigate("RegionName", "ViewName", param);

//類似URL地址傳遞引數
_regionManger.RequestNavigate("RegionName", "ViewName?id=1&Name=xiaoming");

疑問?

當我們使用導航為指定區域註冊檢視時, 我們怎麼控制開啟的過程? 所以, 下面我們將講解一下

INavigationAware介面。

INavigationAware

該介面包含3個方法, 每個方法中都包含當前導航的上下文, 如下所示:

        public void OnNavigatedTo(NavigationContext navigationContext)
        {

        }

        public bool IsNavigationTarget(NavigationContext navigationContext)
        {
            return true;
        }

        public void OnNavigatedFrom(NavigationContext navigationContext)
        {

        }

OnNavigatedTo: 導航完成前, 此處可以傳遞過來的引數以及是否允許導航等動作的控制。
IsNavigationTarget: 呼叫以確定此範例是否可以處理導航請求。否則新建範例
OnNavigatedFrom: 當導航離開當前頁時, 類似開啟A, 再開啟B時, 該方法被觸發。

INavigationAware 執行流程

獲取導航請求引數

正如上面所描述, 導航中允許我們傳遞引數, 用於在我們完成導航之前, 進行做對應的邏輯業務處理。這時候, 我們便可以在OnNavigatedTo方法中通過導航上下文中獲取到傳遞的所有引數。如下:

        public void OnNavigatedTo(NavigationContext navigationContext)
        {
            var id = navigationContext.Parameters.GetValue<int>("id");

            var name = navigationContext.Parameters["Name"].ToString();
        }

IConfirmNavigationRequest

該介面繼承於INavigationAware, 所以, 它多了一個功能: 允許使用者針對導航請求進行攔截。

    //多了一個回撥函數, 該值覺得是否攔截該導航請求
    void ConfirmNavigationRequest(NavigationContext navigationContext, Action<bool> continuationCallback);

IConfirmNavigationRequest 執行流程

攔截導航請求

當開啟新的導航時, 或許有些情況下你需要經過使用者進行確認, 這個時候, IConfirmNavigationRequest介面可以滿足需求, 如下:

        public void ConfirmNavigationRequest(NavigationContext navigationContext, Action<bool> continuationCallback)
        {
            bool result = true;

            if (MessageBox.Show("確認導航?", "溫馨提示", MessageBoxButton.YesNo) == MessageBoxResult.No)
                result = false;

            //通過回撥當前返回的確認結果,決定是否啟動該導航
            continuationCallback(result);
        }