UWP不归路——自定义后退事件管理

UWP不归路——自定义后退事件管理_第1张图片
双击退出

UWP 中可以调用如下方法对后退按钮进行事件处理,比如页面导航,退出全屏,双击退出等等。

// 注册后退事件
SystemNavigationManager.GetForCurrentView().BackRequested += PageBackRequested;

// 后退事件处理
private void PageBackRequested(object sender, BackRequestedEventArgs e)
{
    e.Handled = true;// 阻止后面注册的事件继续执行
    // TODO
}

// 注销
SystemNavigationManager.GetForCurrentView().BackRequested -= PageBackRequested;

通过上面的调用已经可以对后退按钮定制不同的点击效果,但是,还存在一个问题。应用中肯定会有很多的页面,每个页面对于后退按钮的处理需求肯定会有所不同,多次注册后退事件(连续注册不注销)是难免的,注册后退事件实际上是把每个事件处理依次加入到一个事件队列中去,每当点击后退按钮的时候,就会按照先后顺序依次执行事件处理,因此就会存在后面处理和前面的处理产生冲突导致无法实现预期中的效果,还需要做一些费劲的特殊处理才能正常使用。

所以可以做一个简单的封装,实现只处理最后注册的事件

using System;
using System.Collections;
using Windows.UI.Core;

namespace indi.anyesu.UWP.Core.Managers
{
    //
    // 自定义后退事件管理:
    //     允许只调用最后注册的后退事件,而SystemNavigationManager的后退事件是按顺序依次执行的。
    public sealed class BackEventManager
    {

        private static Stack BackEventStack = new Stack();

        //
        // 注册后退事件
        //
        public static void Register(EventHandler PageBackRequested)
        {
            if (BackEventStack.Count > 0)
            {
                SystemNavigationManager.GetForCurrentView().BackRequested -= BackEventStack.Peek() as EventHandler;
            }
            SystemNavigationManager.GetForCurrentView().BackRequested += PageBackRequested;// 注册到系统自带的后退事件队列
            BackEventStack.Push(PageBackRequested);
        }

        //
        // 注销最后注册的后退事件
        //
        public static void Unregister(EventHandler PageBackRequested)
        {
            if (BackEventStack.Count > 0)
            {
                var top = BackEventStack.Peek() as EventHandler;
                if (PageBackRequested.Equals(top))
                {
                    SystemNavigationManager.GetForCurrentView().BackRequested -= PageBackRequested;
                    BackEventStack.Pop();
                    if (BackEventStack.Count > 0)
                    {
                        SystemNavigationManager.GetForCurrentView().BackRequested += BackEventStack.Peek() as EventHandler;
                    }
                }
            }
        }
    }
}

主要思路是将所有注册的事件处理压入 BackEventStack 这个栈当中,保证系统自带的后退事件处理队列当中最多只有一个事件处理,即最后注册的那个。调用方法如下:

BackEventManager.Register(PageBackRequested);// 注册后退事件
BackEventManager.Unregister(PageBackRequested);// 注销后退事件
// 注意: 最好保证注册和注销成对出现(如在页面的OnNavigatedTo方法中注册,OnNavigatedFrom方法中注销),避免出现冲突。

有了这个后退事件管理器之后,可以在 APP 初始化的时候完成后退事件的注册,实现一个统一的后退事件处理,特殊页面特殊处理,这样就不用到处贴代码了,维护起来更方便。
App.xaml.cs 中修改 OnLaunched 方法,如下所示:

/// 
/// 在应用程序由最终用户正常启动时进行调用。
/// 将在启动应用程序以打开特定文件等情况下使用。
/// 
/// 有关启动请求和过程的详细信息。
protected override async void OnLaunched(LaunchActivatedEventArgs e)
{
    Frame rootFrame = Window.Current.Content as Frame;
    // 不要在窗口已包含内容时重复应用程序初始化,
    // 只需确保窗口处于活动状态
    if (rootFrame == null)
    {
        // 创建要充当导航上下文的框架,并导航到第一页
        rootFrame = new Frame();
        rootFrame.NavigationFailed += OnNavigationFailed;
        // 下面这句话是关键
        rootFrame.Navigated += OnNavigated;// 注册页面加载完毕事件
        if (e.PreviousExecutionState == ApplicationExecutionState.Terminated)
        {
            //TODO: 从之前挂起的应用程序加载状态
        }
        // 将框架放在当前窗口中
        Window.Current.Content = rootFrame;
    }
    if (rootFrame.Content == null)
    {
        // 当导航堆栈尚未还原时,导航到第一页,
        // 并通过将所需信息作为导航参数传入来配置
        rootFrame.Navigate(typeof(MainPage), e.Arguments);
    }
    // 如果是移动端,则设置可以设置顶部状态栏(电量、时间...)的颜色、是否显示
    if (Windows.Foundation.Metadata.ApiInformation.IsTypePresent("Windows.UI.ViewManagement.StatusBar"))
    {
        StatusBar statusBar = StatusBar.GetForCurrentView();
        // statusBar.ForegroundColor = Colors.White;// 设置背景色
        await statusBar.HideAsync();// 隐藏状态栏
    }
    Window.Current.Activate();// 确保当前窗口处于活动状态
}
// 在OnNavigated方法中进行事件的注册和控制后退按钮的显示与否
private void OnNavigated(object sender, NavigationEventArgs e)
{
    //显示标题栏后退按钮
    //SystemNavigationManager.GetForCurrentView().AppViewBackButtonVisibility = ((Frame)sender).CanGoBack ? AppViewBackButtonVisibility.Visible : AppViewBackButtonVisibility.Collapsed;
    SystemNavigationManager.GetForCurrentView().AppViewBackButtonVisibility = AppViewBackButtonVisibility.Visible;// 在PC客户端左上角显示后退按钮
    BackEventManager.Register(PageBackRequested);// 注册后退事件
}

这里最关键的一句就是 rootFrame.Navigated += OnNavigated;PageBackRequested 方法中做了统一的后退事件处理,比如在我的应用中,我希望显示 MainPage 时后退按钮能够双击彻底退出应用,显示其他页面时后退按钮能够处理正常的页面后退导航,具体处理如下:

private void PageBackRequested(object sender, BackRequestedEventArgs e)
{
    e.Handled = true;
    GoBack();
}
/// 
/// 自定义全局后退事件处理
/// 
public static async void GoBack()
{
    var rootFrame = Window.Current.Content as Frame;// App的根Frame
    if (rootFrame == null)
    {
        return;
    }
    if (rootFrame.CurrentSourcePageType == typeof(MainPage))// 判断rootFrame 当前页面类型是否为MainPage
    {
        if (!IsQuit)// IsQuit表示是否已点击了后退按钮,用来处理双击事件
        {
            IsQuit = true;
            await (rootFrame.Content as MainPage).showMessage("再按一次返回键退出", Colors.Red);// 异步调出页面的提示框
            IsQuit = false;
        }
        else
        {
            Current.Exit();// 彻底退出App
        }
    }
    else if (rootFrame.CanGoBack)
    {
        rootFrame.GoBack();
    }
}

在MainPage中

public async Task showMessage(string msg, Color color)
{
    Hint.Text = msg;// 设置提示框文本内容
    if (color != null)
    {
        if (color == Colors.Green)
        {
            color = Color.FromArgb(255, 91, 159, 82);
        }
        messageBorder.Background = new SolidColorBrush(color);// 设置提示框背景色
    }
    message.Visibility = Visibility.Visible;// 显示提示框
    await Task.Delay(1500);// 延时1500ms
    message.Visibility = Visibility.Collapsed;// 隐藏提示框
}

//以下为xaml内容,一个自定义的文本提示框

    
    
        
    

总结


在我的开发过程中,这个后退事件管理器已经基本满足所有需求了,不过每次执行后退事件的时候都很任性的抛弃了之前注册的事件,之后会考虑加入与前面注册的事件共存的方法并做一些优化,以便灵活地适应更多的通用需求。


转载请注明出处:https://www.jianshu.com/p/55d6cd6b632d

你可能感兴趣的:(UWP不归路——自定义后退事件管理)