重新想象 Windows 8 Store Apps (64) - 后台任務: 開發一個簡單的后台任務

[源碼下載]

重新想象 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;
            });
        }
    }
}

OK
[源碼下載]