注册后台任务

项目
07/13/2023

重要的 API

了解如何创建可以重复使用以安全注册大部分后台任务的函数。

本主题适用于进程内后台任务和进程外后台任务。本主题假定你已拥有需要注册的后台任务。（有关如何编写后台任务的信息，请参阅创建和注册进程外运行的后台任务或创建和注册进程内后台任务）。

本主题介绍了注册后台任务的实用工具函数。此实用工具函数在注册任务前首先多次检查现有注册以避免多次注册产生的错误，并且该函数可以将系统条件应用于后台任务。本操作实例包括此实用工具函数的正常运行的完整示例。

注意

通用 Windows 应用必须在注册任何后台触发器类型之前调用 RequestAccessAsync。

若要确保通用 Windows 应用在你发布更新后继续正常运行，必须在启动已经过更新的应用时调用 RemoveAccess，然后调用 RequestAccessAsync。有关详细信息，请参阅后台任务指南。

定义方法签名并返回类型

此方法包含任务入口点、任务名称、预构建的后台任务触发器以及后台任务的 SystemCondition（可选）。此方法返回 BackgroundTaskRegistration 对象。

重要

taskEntryPoint - 对于在进程外运行的后台任务，这必须构建为命名空间名称 '.' 以及包含后台类的类名称。该字符串区分大小写。例如，如果有包含后台类代码的命名空间“MyBackgroundTasks”和类“BackgroundTask1”，taskEntryPoint 的字符串将为“MyBackgroundTasks.BackgroundTask1”。如果后台任务在应用所在的同一进程中运行（即进程内后台任务），不应设置 taskEntryPoint。

public static BackgroundTaskRegistration RegisterBackgroundTask(
                                                string taskEntryPoint,
                                                string name,
                                                IBackgroundTrigger trigger,
                                                IBackgroundCondition condition)
{
    
    // We'll add code to this function in subsequent steps.

}

BackgroundTaskRegistration^ MainPage::RegisterBackgroundTask(
                                             Platform::String ^ taskEntryPoint,
                                             Platform::String ^ taskName,
                                             IBackgroundTrigger ^ trigger,
                                             IBackgroundCondition ^ condition)
{
    
    // We'll add code to this function in subsequent steps.

}

检查现有注册

检查任务是否已注册。请务必检查此项，因为如果任务已多次注册，则将在该任务触发时运行多次，这可占用过多的 CPU 并可能导致意外行为。

你可以通过查询 BackgroundTaskRegistration.AllTasks 属性并在结果上迭代来检查现有注册。检查每个实例的名称 - 如果该名称与正注册的任务的名称匹配，则跳出循环并设置标志变量，以便你的代码可以在下一步中选择不同的路径。

注意使用应用唯一的后台任务名称。确保每个后台任务都具有唯一的名称。

以下代码使用我们在上一步中创建的 SystemTrigger 注册后台任务：

public static BackgroundTaskRegistration RegisterBackgroundTask(
                                                string taskEntryPoint,
                                                string name,
                                                IBackgroundTrigger trigger,
                                                IBackgroundCondition condition)
{
    //
    // Check for existing registrations of this background task.
    //

    foreach (var cur in BackgroundTaskRegistration.AllTasks)
    {

        if (cur.Value.Name == name)
        {
            //
            // The task is already registered.
            //

            return (BackgroundTaskRegistration)(cur.Value);
        }
    }
    
    // We'll register the task in the next step.
}

BackgroundTaskRegistration^ MainPage::RegisterBackgroundTask(
                                             Platform::String ^ taskEntryPoint,
                                             Platform::String ^ taskName,
                                             IBackgroundTrigger ^ trigger,
                                             IBackgroundCondition ^ condition)
{
    //
    // Check for existing registrations of this background task.
    //
    
    auto iter   = BackgroundTaskRegistration::AllTasks->First();
    auto hascur = iter->HasCurrent;
    
    while (hascur)
    {
        auto cur = iter->Current->Value;
        
        if(cur->Name == name)
        {
            //
            // The task is registered.
            //
            
            return (BackgroundTaskRegistration ^)(cur);
        }
        
        hascur = iter->MoveNext();
    }
    
    // We'll register the task in the next step.
}