從新想象 Windows 8 Store Apps (64) - 後臺任務: 開發一個簡單的後臺任務

時間  2019-11-09
標籤 從新 想象 windows store apps 後臺 任務 開發 一個 簡單 欄目 Windows 简体版
原文   原文鏈接

[源碼下載]


html

從新想象 Windows 8 Store Apps (64) - 後臺任務: 開發一個簡單的後臺任務



做者：webabcd


介紹
從新想象 Windows 8 Store Apps 之 後臺任務html5

  • 開發一個簡單的後臺任務



示例
一、經過「Windows 運行時組件」新建一個後臺任務
BackgroundTaskLib/Demo.csweb

/*
 * 後臺任務
 * 
 * 注：
 * 後臺任務項目的輸出類型須要設置爲「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 更新而被取消
             */
        }
    }
}


二、演示後臺任務的應用
BackgroundTask/Demo.xamlexpress

<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.cswindows

/*
 * 演示後臺任務的應用
 * 
 * 注：
 * 一、須要引用後臺任務項目，後臺任務的示例代碼在 BackgroundTaskLib/Demo.cs
 * 二、須要在 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
[源碼下載]網絡

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程