背水一戰 Windows 10 (114) - 後臺任務: 後臺任務的 Demo（與 app 不一樣進程）, 後臺任務的 Demo（與 app 相同進程）

[源碼下載]

背水一戰 Windows 10 (114) - 後臺任務: 後臺任務的 Demo（與 app 不一樣進程）, 後臺任務的 Demo（與 app 相同進程）

做者：webabcd


介紹
背水一戰 Windows 10 之 後臺任務

• 後臺任務的 Demo（與 app 不一樣進程）
• 後臺任務的 Demo（與 app 相同進程）

示例
一、演示後臺任務的應用（後臺任務與 app 不一樣進程）
/BackgroundTaskLib/BackgroundTaskDemo.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 BackgroundTaskDemo : IBackgroundTask
    {
        public async void Run(IBackgroundTaskInstance taskInstance)
        {
            // 後臺任務在執行中被終止執行時所觸發的事件
            taskInstance.Canceled += taskInstance_Canceled;

            // 異步操做
            BackgroundTaskDeferral deferral = taskInstance.GetDeferral();

            try
            {
                // 指定後臺任務的進度
                taskInstance.Progress = 0;
                // taskInstance.InstanceId - 後臺任務實例的惟一標識，由系統生成，與前臺的 IBackgroundTaskRegistration.TaskId 一致
                // taskInstance.SuspendedCount - 由資源管理政策致使後臺任務掛起的次數

                StorageFile file = await ApplicationData.Current.LocalFolder.CreateFileAsync(@"webabcdBackgroundTask\demo.txt", CreationCollisionOption.ReplaceExisting);
                for (uint progress = 10; progress <= 100; progress += 10)
                {
                    await Task.Delay(1000);

                    // 更新後臺任務的進度（會通知給前臺）
                    taskInstance.Progress = progress;

                    // 獲取當先後臺任務的開銷量（Low, Medium, High）
                    // BackgroundWorkCostValue bwcv = Windows.ApplicationModel.Background.BackgroundWorkCost.CurrentBackgroundWorkCost;

                    // 寫入相關數據到指定的文件
                    await FileIO.AppendTextAsync(file, "progress: " + progress.ToString() + ", currentTime: " + DateTime.Now.ToString() + Environment.NewLine);
                }
            }
            finally
            {
                // 完成異步操做
                deferral.Complete();
            }
        }

        void taskInstance_Canceled(IBackgroundTaskInstance sender, BackgroundTaskCancellationReason reason)
        {
            // 若是這裏 5 秒內沒有完成，則系統會終止該應用，並生成錯誤報告上傳至 windows 商店的開發人員帳戶

            /*
             * BackgroundTaskCancellationReason - 後臺任務在執行中被終止執行的緣由
             *     Abort - 前臺 app 調用了 IBackgroundTaskRegistration.Unregister(true)
             *     Terminating - 由於系統策略，而被終止
             *     LoggingOff - 由於用戶註銷系統而被取消
             *     ServicingUpdate - 由於 app 更新而被取消
             *     ... - 還有好多，參見文檔吧
             */
        }
    }
}

BackgroundTask/Demo.xaml

<Page
    x:Class="Windows10.BackgroundTask.Demo"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:Windows10.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="10 0 10 10">

            <TextBlock Name="lblMsg" Margin="5" />

            <Button Name="btnRegister" Content="註冊一個後臺任務" Margin="5" Click="btnRegister_Click" />
            <Button Name="btnUnregister" Content="註銷指定的後臺任務" Margin="5" Click="btnUnregister_Click" />

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

BackgroundTask/Demo.xaml.cs

/*
 * 演示後臺任務的應用（後臺任務與 app 不一樣進程）
 * 
 * 注：
 * 一、須要引用後臺任務項目，相關代碼參見 BackgroundTaskLib/BackgroundTaskDemo.cs
 * 二、須要在 Package.appxmanifest 添加「後臺任務」聲明，支持的任務類型選擇「系統事件」，並指定 EntryPoint（後臺任務的類全名），相似以下：
 * <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTaskLib.BackgroundTaskDemo">
 *   <BackgroundTasks>
 *     <Task Type="systemEvent" />
 *   </BackgroundTasks>
 * </Extension>
 */

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

namespace Windows10.BackgroundTask
{
    public sealed partial class Demo : Page
    {
        // 所註冊的後臺任務的名稱
        private string _taskName = "Demo";

        // 所註冊的後臺任務的 EntryPoint，即後臺任務的類全名
        // 對應 Package.appxmanifest 中的「後臺任務」聲明，相似以下：<Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTaskLib.BackgroundTaskDemo" />
        private string _taskEntryPoint = "BackgroundTaskLib.BackgroundTaskDemo";

        // 後臺任務是否已在系統中註冊
        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)
                {
                    // 若是找到了指定的後臺任務，則爲其增長 Progress 和 Completed 事件監聽，以便前臺 app 接收後臺任務的進度彙報和完成彙報
                    AttachProgressAndCompletedHandlers(task.Value);
                    _taskRegistered = true;
                    break;
                }
            }

            UpdateUI();
        }

        private async void btnRegister_Click(object sender, RoutedEventArgs e)
        {
            // 在註冊後臺任務以前，須要調用 BackgroundExecutionManager.RequestAccessAsync()，若是是更新過的 app 則在以前還須要調用 BackgroundExecutionManager.RemoveAccess()
            string appVersion = $"{Package.Current.Id.Version.Major}.{Package.Current.Id.Version.Minor}.{Package.Current.Id.Version.Build}.{Package.Current.Id.Version.Revision}";
            if ((string)ApplicationData.Current.LocalSettings.Values["AppVersion"] != appVersion)
            {
                // 對於更新的 app 來講先要調用這個方法
                BackgroundExecutionManager.RemoveAccess();
                // 註冊後臺任務以前先要調用這個方法，並獲取 BackgroundAccessStatus 狀態
                BackgroundAccessStatus status = await BackgroundExecutionManager.RequestAccessAsync();
                if (status == BackgroundAccessStatus.Unspecified || status == BackgroundAccessStatus.DeniedBySystemPolicy || status == BackgroundAccessStatus.DeniedByUser)
                {
                    // 無權限註冊後臺任務

                    await new MessageDialog("沒有權限註冊後臺任務").ShowAsync();
                }
                else
                {
                    // 有權限註冊後臺任務

                    ApplicationData.Current.LocalSettings.Values["AppVersion"] = appVersion;
                }
            }


            // 用於構造一個後臺任務
            BackgroundTaskBuilder builder = new BackgroundTaskBuilder();

            builder.Name = _taskName; // 後臺任務的名稱
            builder.TaskEntryPoint = _taskEntryPoint; // 後臺任務入口點，即後臺任務的類全名

            /*
             * 後臺任務觸發器 IBackgroundTrigger
             *     TimeTrigger - 循環觸發器，須要 app 在鎖屏上，最小週期 15 分鐘
             *     MaintenanceTrigger - 循環觸發器，與 TimeTrigger 相似，可是不要求 app 在鎖屏上，最小週期 15 分鐘
             *     SystemTrigger - 通常不要求 app 在鎖屏上（實例化時的第二個參數是 oneShot，其表明是否只觸發一次）
             *         SmsReceived - 接收到新的 sms 消息時
             *         LockScreenApplicationAdded - app 添加到鎖屏時
             *         LockScreenApplicationRemoved - app 從鎖屏移除時
             *         OnlineIdConnectedStateChange - 當前鏈接的 Microsoft 賬戶更改時
             *         TimeZoneChange - 時區發生更改時
             *         ServicingComplete - 系統完成了 app 的更新時
             *         ControlChannelReset - 重置 ControlChannel 時，須要 app 在鎖屏上
             *         NetworkStateChange - 網絡狀態發生改變時
             *         InternetAvailable - Internet 變爲可用時
             *         SessionConnected - 會話狀態鏈接時，須要 app 在鎖屏上
             *             這裏的 Session 指的是，用戶與本機之間的 Session，也就是說當切換用戶時 Session 會發生改變
             *         UserPresent - 用戶變爲活動狀態時，須要 app 在鎖屏上
             *         UserAway - 用戶變爲非活動狀態時，須要 app 在鎖屏上
             *         PowerStateChange - 當 Windows.System.Power.PowerManager.BatteryStatus 發生變化時
             *     ToastNotificationHistoryChangedTrigger - 當 toast 通知從 ToastNotificationHistory 中添加或刪除時
             *     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
             *     FreeNetworkAvailable - 免費網絡（好比 wifi）
             *     BackgroundWorkCostNotHigh - 後臺任務開銷較低
             */
            // builder.AddCondition(new SystemCondition(SystemConditionType.InternetAvailable));

            // 在後臺任務運行過程當中，若是發現後臺任務執行條件至少有一條不符合要求時，是否取消此後臺任務的執行（默認值爲 false）
            // builder.CancelOnConditionLoss = false;

            // 設置後臺任務的所屬組，以便組操做（關於 BackgroundTaskRegistrationGroup 和 BackgroundTaskRegistration 的組相關的操做請參見文檔）
            // builder.TaskGroup = new BackgroundTaskRegistrationGroup("myGroup");


            /*
             * 再說明一下
             * SetTrigger() 用於指定何時觸發後臺任務
             * AddCondition() 用於指定在後臺任務被觸發時，其必須知足什麼條件才能被執行
             * CancelOnConditionLoss 用於指定在後臺任務的執行過程當中，若是發現 AddCondition() 中的條件不知足了，是否要取消此後臺任務的執行
             */


            // 向系統註冊此後臺任務
            BackgroundTaskRegistration task = builder.Register();
            // task.TaskId; 獲取此後臺任務的標識，一個 GUID（其與後臺任務類中的 taskInstance.InstanceId 一致）

            // 爲此後臺任務增長 Progress 和 Completed 事件監聽，以便前臺 app 接收後臺任務的進度彙報和完成彙報
            AttachProgressAndCompletedHandlers(task);

            _taskRegistered = true;

            UpdateUI();
        }

        private void btnUnregister_Click(object sender, RoutedEventArgs e)
        {
            // 遍歷全部已註冊的後臺任務
            foreach (KeyValuePair<Guid, IBackgroundTaskRegistration> task in BackgroundTaskRegistration.AllTasks)
            {
                if (task.Value.Name == _taskName)
                {
                    // 從系統中註銷指定的後臺任務。惟一一個參數表明若是當先後臺任務正在運行中，是否須要將其取消
                    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;
            });
        }
    }
}

二、演示後臺任務的應用（後臺任務與 app 相同進程）
App.xaml.cs

        // 後臺任務與 app 相同進程時，後臺任務的實現邏輯
        // 這部分與「後臺任務與 app 不一樣進程」中的後臺任務的編寫基本一致，詳細可參見 /BackgroundTaskLib/BackgroundTaskDemo.cs
        // 後臺任務與前臺的通訊也能夠參見「後臺任務與 app 不一樣進程」示例，不過因爲本後臺任務示例是和 app 同進程的，因此經過內存通訊會更簡單
        protected async override void OnBackgroundActivated(BackgroundActivatedEventArgs args)
        {
            // 獲取 IBackgroundTaskInstance 對象
            IBackgroundTaskInstance taskInstance = args.TaskInstance;

            // 異步操做
            BackgroundTaskDeferral deferral = taskInstance.GetDeferral();

            try
            {
                // 寫入相關數據到文件
                StorageFile file = await ApplicationData.Current.LocalFolder.CreateFileAsync(@"webabcdBackgroundTask\demoInProcess.txt", CreationCollisionOption.ReplaceExisting);
                await FileIO.AppendTextAsync(file, "background task in process: " + DateTime.Now.ToString() + Environment.NewLine);

            }
            finally
            {
                // 完成異步操做
                deferral.Complete();
            }
        }

BackgroundTask/DemoInProcess.xaml

<Page
    x:Class="Windows10.BackgroundTask.DemoInProcess"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:Windows10.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="10 0 10 10">

            <Button Name="btnRegister" Content="註冊一個後臺任務" Margin="5" Click="btnRegister_Click" />

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

BackgroundTask/DemoInProcess.xaml.cs

/*
 * 演示後臺任務的應用（後臺任務與 app 相同進程）
 * 
 * 注：
 * 一、後臺任務與 app 不一樣進程，詳見 /BackgroundTask/Demo.xaml.cs
 * 二、此示例不須要在 Package.appxmanifest 添加「後臺任務」聲明
 * 三、此示例不須要引用後臺任務項目，而是在 App.xaml.cs 中經過 override void OnBackgroundActivated(BackgroundActivatedEventArgs args) 來編寫後臺任務的邏輯
 */

using System;
using System.Collections.Generic;
using Windows.ApplicationModel;
using Windows.ApplicationModel.Background;
using Windows.Storage;
using Windows.UI.Popups;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;

namespace Windows10.BackgroundTask
{
    public sealed partial class DemoInProcess : Page
    {
        // 所註冊的後臺任務的名稱
        private string _taskName = "DemoInProcess";

        public DemoInProcess()
        {
            this.InitializeComponent();
        }

        private async void btnRegister_Click(object sender, RoutedEventArgs e)
        {
            // 在註冊後臺任務以前，須要調用 BackgroundExecutionManager.RequestAccessAsync()，若是是更新過的 app 則在以前還須要調用 BackgroundExecutionManager.RemoveAccess()
            string appVersion = $"{Package.Current.Id.Version.Major}.{Package.Current.Id.Version.Minor}.{Package.Current.Id.Version.Build}.{Package.Current.Id.Version.Revision}";
            if ((string)ApplicationData.Current.LocalSettings.Values["AppVersion"] != appVersion)
            {
                // 對於更新的 app 來講先要調用這個方法
                BackgroundExecutionManager.RemoveAccess();
                // 註冊後臺任務以前先要調用這個方法，並獲取 BackgroundAccessStatus 狀態
                BackgroundAccessStatus status = await BackgroundExecutionManager.RequestAccessAsync();
                if (status == BackgroundAccessStatus.Unspecified || status == BackgroundAccessStatus.DeniedBySystemPolicy || status == BackgroundAccessStatus.DeniedByUser)
                {
                    // 無權限註冊後臺任務

                    await new MessageDialog("沒有權限註冊後臺任務").ShowAsync();
                }
                else
                {
                    // 有權限註冊後臺任務

                    ApplicationData.Current.LocalSettings.Values["AppVersion"] = appVersion;
                }
            }


            // 若是任務已註冊，則註銷
            foreach (KeyValuePair<Guid, IBackgroundTaskRegistration> t in BackgroundTaskRegistration.AllTasks)
            {
                if (t.Value.Name == _taskName)
                {
                    t.Value.Unregister(true);
                }
            }

            // 註冊後臺任務，後臺任務的代碼參見 App.xaml.cs 中的 OnBackgroundActivated(BackgroundActivatedEventArgs args) 方法
            BackgroundTaskBuilder builder = new BackgroundTaskBuilder
            {
                Name = _taskName,
            };
            builder.SetTrigger(new SystemTrigger(SystemTriggerType.TimeZoneChange, false));
            BackgroundTaskRegistration task = builder.Register();
        }
    }
}

OK
[源碼下載]