重新想象 Windows 8 Store Apps (64) - 后台任务: 开发一个简单的后台任务

作者：webabcd

介绍
重新想象 Windows 8 Store Apps 之后台任务

开发一个简单的后台任务

示例
1、通过“Windows 运行时组件”新建一个后台任务
BackgroundTaskLib/Demo.cs

/*
 * 后台任务
 * 
 * 注：
 * 后台任务项目的输出类型需要设置为“Windows 运行时组件”，其会生成 .winmd 文件，winmd - Windows Metadata
 */

using System;
using System.Threading.Tasks;
using Windows.ApplicationModel.Background;
using Windows.Storage;

namespace BackgroundTaskLib
{
    // 实现 IBackgroundTask 接口，其只有一个方法，即 Run()
    public sealed class Demo : IBackgroundTask
    {
        public async void Run(IBackgroundTaskInstance taskInstance)
        {
            // 后台任务在执行中被终止执行时所触发的事件
            taskInstance.Canceled += taskInstance_Canceled;

            // 异步操作，即通知系统后台任务可在 IBackgroundTask.Run 方法返回后继续工作
            BackgroundTaskDeferral deferral = taskInstance.GetDeferral();

            try
            {
                // 指定后台任务的进度
                taskInstance.Progress = 0;
                // taskInstance.InstanceId - 后台任务实例的唯一标识，由系统生成，与前台的 IBackgroundTaskRegistration.TaskId 一致

                // 写入相关数据到文件
                StorageFile file = await ApplicationData.Current.LocalFolder.CreateFileAsync(@"webabcdBackgroundTask\demo.txt", CreationCollisionOption.ReplaceExisting);
                await FileIO.WriteTextAsync(file, "progress: 0, currentTime: " + DateTime.Now.ToString());

                for (uint progress = 10; progress <= 100; progress += 10)
                {
                    await Task.Delay(1000);

                    // 更新后台任务的进度
                    taskInstance.Progress = progress;

                    // 写入相关数据到文件
                    file = await ApplicationData.Current.LocalFolder.GetFileAsync(@"webabcdBackgroundTask\demo.txt");
                    await FileIO.AppendTextAsync(file, "progress: " + progress.ToString() + ", currentTime: " + DateTime.Now.ToString());
                }
            }
            finally
            {
                // 完成异步操作
                deferral.Complete();
            }
        }

        void taskInstance_Canceled(IBackgroundTaskInstance sender, BackgroundTaskCancellationReason reason)
        {
            /*
             * BackgroundTaskCancellationReason - 后台任务在执行中被终止执行的原因
             *     Abort - 前台 app 调用了 IBackgroundTaskRegistration.Unregister(true)
             *     Terminating - 因为系统策略，而被终止
             *     LoggingOff - 因为用户注销系统而被取消
             *     ServicingUpdate - 因为 app 更新而被取消
             */
        }
    }
}

2、演示后台任务的应用
BackgroundTask/Demo.xaml

<Page
    x:Class="XamlDemo.BackgroundTask.Demo"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:XamlDemo.BackgroundTask"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    mc:Ignorable="d">

    <Grid Background="Transparent">
        <StackPanel Margin="120 0 0 0">

            <TextBlock Name="lblMsg" FontSize="14.667" />
            
            <Button Name="btnRegister" Content="注册一个后台任务" Margin="0 10 0 0" Click="btnRegister_Click_1" />
            <Button x:Name="btnUnregister" Content="取消注册的后台任务" Margin="0 10 0 0" Click="btnUnregister_Click_1" />

        </StackPanel>
    </Grid>
</Page>

BackgroundTask/Demo.xaml.cs

/*
 * 演示后台任务的应用
 * 
 * 注：
 * 1、需要引用后台任务项目，后台任务的示例代码在 BackgroundTaskLib/Demo.cs
 * 2、需要在 Package.appxmanifest 添加“后台任务”声明，并指定 EntryPoint（后台任务的类全名）
 * 
 * 另：
 * 关于后台任务的介绍文档请参见本目录下的 Introduction_to_Background_Tasks.docx 文件
 */

using System;
using System.Collections.Generic;
using Windows.ApplicationModel.Background;
using Windows.UI.Core;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Navigation;

namespace XamlDemo.BackgroundTask
{
    public sealed partial class Demo : Page
    {
        // 所注册的后台任务的名称
        private string _taskName = "demo";

        // 所注册的后台任务的 EntryPoint，即后台任务的类全名
        // 需要在 Package.appxmanifest 添加“后台任务”声明，并指定 EntryPoint 如下：<Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTaskLib.Demo" />
        private string _taskEntryPoint = "BackgroundTaskLib.Demo";

        // 后台任务是否已在系统中注册
        private bool _taskRegistered = false;

        // 后台任务执行状况的进度说明
        private string _taskProgress = "";

        public Demo()
        {
            this.InitializeComponent();
        }
       
        protected override void OnNavigatedTo(NavigationEventArgs e)
        {
            // 遍历所有已注册的后台任务
            foreach (KeyValuePair<Guid, IBackgroundTaskRegistration> task in BackgroundTaskRegistration.AllTasks)
            {
                if (task.Value.Name == _taskName) // 注：后台任务的唯一标识是 IBackgroundTaskRegistration.TaskId，此处用 Name 只是为了演示方便
                {
                    // 如果找到了指定的后台任务，则为其增加 Progress 和 Completed 事件监听，以便前台 app 接收后台任务的进度汇报和完成汇报
                    AttachProgressAndCompletedHandlers(task.Value);
                    _taskRegistered = true;
                    break;
                }
            }

            UpdateUI();
        }

        private void btnRegister_Click_1(object sender, RoutedEventArgs e)
        {
            // 用于构造一个后台任务
            BackgroundTaskBuilder builder = new BackgroundTaskBuilder();

            builder.Name = _taskName; // 后台任务的名称，显示用
            builder.TaskEntryPoint = _taskEntryPoint; // 后台任务入口点，即后台任务的类全名

            /*
             * 后台任务触发器 IBackgroundTrigger
             *     TimeTrigger - 需要 app 在锁屏上，最小周期 15 分钟
             *     MaintenanceTrigger - 与 TimeTrigger 类似，但是不要求 app 在锁屏上，最小周期 15 分钟，如果 app 不在锁屏上则最快 2 小时执行一次
             *     SystemTrigger - 一般不要求 app 在锁屏上
             *         SmsReceived - 接收到新的 sms 消息时
             *         LockScreenApplicationAdded - app 添加到锁屏时
             *         LockScreenApplicationRemoved - app 从锁屏移除时
             *         OnlineIdConnectedStateChange - 当前连接的 Microsoft 帐户更改时
             *         TimeZoneChange - 时区发生更改时
             *         ServicingComplete - 系统完成了 app 的更新时
             *         ControlChannelReset - 重置控制通道时，需要 app 在锁屏上
             *         NetworkStateChange - 网络状态发生改变时
             *         InternetAvailable - Internet 变为可用时
             *         SessionConnected - 会话状态连接时，需要 app 在锁屏上
             *             这里的 Session 指的是，用户与本机之间的 Session，也就是说当切换用户时 Session 会发生改变
             *         UserPresent - 用户变为活动状态时，需要 app 在锁屏上
             *         UserAway - 用户变为非活动状态时，需要 app 在锁屏上
             *     PushNotificationTrigger - 需要 app 在锁屏上。关于“推送通知”请参见：BackgroundTask/PushNotification.xaml
             *     ControlChannelTrigger - 需要 app 在锁屏上。关于“推送通道”请参见：BackgroundTask/ControlChannel.xaml
             */
            builder.SetTrigger(new SystemTrigger(SystemTriggerType.TimeZoneChange, false));

            /*
             * 后台任务执行条件 SystemConditionType，当后台任务触发器触发后，只有满足了指定的条件才能执行
             *     UserPresent - 用户为活动状态
             *     UserNotPresent - 用户为非活动状态
             *     InternetAvailable - Internet 状态为可用
             *     InternetNotAvailable - Internet 状态为不可用
             *     SessionConnected - 会话状态是连接的。这里的 Session 指的是，用户与本机之间的 Session，也就是说如果系统中有用户登录则 SessionConnected
             *     SessionDisconnected - 会话状态是断开的。这里的 Session 指的是，用户与本机之间的 Session，也就是说如果系统中没有用户登录（所有用户都注销了）则 SessionDisconnected
             */
            builder.AddCondition(new SystemCondition(SystemConditionType.InternetAvailable));

            // 向系统注册此后台任务
            BackgroundTaskRegistration task = builder.Register();
            // task.TaskId; 获取此后台任务的标识，一个 GUID

            // 为此后台任务增加 Progress 和 Completed 事件监听，以便前台 app 接收后台任务的进度汇报和完成汇报
            AttachProgressAndCompletedHandlers(task);

            _taskRegistered = true;

            UpdateUI();
        }

        private void btnUnregister_Click_1(object sender, RoutedEventArgs e)
        {
            // 遍历所有已注册的后台任务
            foreach (KeyValuePair<Guid, IBackgroundTaskRegistration> task in BackgroundTaskRegistration.AllTasks)
            {
                if (task.Value.Name == _taskName) // 注：后台任务的唯一标识是 IBackgroundTaskRegistration.TaskId，此处用 Name 只是为了演示方便
                {
                    // 从系统中注销指定的后台任务。唯一一个参数代表如果当前后台任务正在运行中，是否需要将其取消
                    task.Value.Unregister(true); 
                    break;
                }
            }

            _taskRegistered = false;

            UpdateUI();
        }

        private void AttachProgressAndCompletedHandlers(IBackgroundTaskRegistration task)
        {
            // 为任务增加 Progress 和 Completed 事件监听，以便前台 app 接收后台任务的进度汇报和完成汇报
            task.Progress += new BackgroundTaskProgressEventHandler(OnProgress);
            task.Completed += new BackgroundTaskCompletedEventHandler(OnCompleted);
        }

        private void OnProgress(IBackgroundTaskRegistration task, BackgroundTaskProgressEventArgs args)
        {
            // 获取后台任务的执行进度
            _taskProgress = args.Progress.ToString();

            UpdateUI();
        }

        private void OnCompleted(IBackgroundTaskRegistration task, BackgroundTaskCompletedEventArgs args)
        {
            // 后台任务已经执行完成
            _taskProgress = "完成";

            // 如果此次后台任务的执行出现了错误，则调用 CheckResult() 后会抛出异常
            try
            {
                args.CheckResult();
            }
            catch (Exception ex)
            {
                _taskProgress = ex.ToString();
            }

            UpdateUI();
        }

        private async void UpdateUI()
        {
            await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
            {
                btnRegister.IsEnabled = !_taskRegistered;
                btnUnregister.IsEnabled = _taskRegistered;

                if (_taskProgress != "")
                    lblMsg.Text = "进度：" + _taskProgress;
            });
        }
    }
}