1# 短时任务 2 3## 场景说明 4 5当应用退到后台默认有6到12秒的运行时长，超过该时间后，系统会将应用置为挂起状态。对于绝大多数应用，6到12秒的时间，足够执行一些重要的任务，但如果应用需要更多的时间，可以通过短时任务接口，扩展应用的执行时间。 6建议不要等到应用退后台后，才调用requestSuspendDelay方法申请延迟挂起，而是应该在执行任何的耗时操作前，都应该调用该接口，向系统申明扩展应用的执行时间。 7当应用在前台时，使用requestSuspendDelay方法，不会影响应用的短时任务配额。 8 9由于每个应用每天的短时任务配额时间有限，当执行完耗时任务后，应当及时取消延迟挂起的申请。 10 11一些典型的耗时任务有，需要保存一些状态数据到本地数据库，需要打开和处理一个大型文件，需要同步一些数据到应用的云端服务器等。 12 13 14## 接口说明 15 16 17**表1** 短时任务主要接口 18 19| 接口名 | 描述 | 20| ---------------------------------------- | ---------------------------------------- | 21| requestSuspendDelay(reason: string, callback: Callback<void>): [DelaySuspendInfo](../reference/apis/js-apis-backgroundTaskManager.md#delaysuspendinfo) | 后台应用申请延迟挂起。<br/>延迟挂起时间一般情况下默认值为3分钟，低电量时默认值为1分钟。 | 22| getRemainingDelayTime(requestId: number): Promise<number> | 获取应用程序进入挂起状态前的剩余时间。<br/>使用Promise形式返回。 | 23| cancelSuspendDelay(requestId: number): void | 取消延迟挂起。 | 24 25 26## 开发步骤 27 281、当应用需要开始执行一个耗时的任务时。调用短时任务申请接口，并且在任务执行完后，调用短时任务取消接口。 29 30```js 31import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; 32 33let id; // 申请延迟挂起任务ID 34let delayTime; // 本次申请延迟挂起任务的剩余时间 35 36// 申请延迟挂起 37function requestSuspendDelay() { 38 let myReason = 'test requestSuspendDelay'; // 申请原因 39 40 try { 41 let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => { 42 // 此回调函数执行，表示应用的延迟挂起申请即将超时，应用需要执行一些清理和标注工作，并取消延时挂起 43 console.info("[backgroundTaskManager] Request suspension delay will time out."); 44 backgroundTaskManager.cancelSuspendDelay(id); 45 }) 46 id = delayInfo.requestId; 47 delayTime = delayInfo.actualDelayTime; 48 console.info("[backgroundTaskManager] The requestId is: " + id); 49 console.info("[backgroundTaskManager]The actualDelayTime is: " + delayTime); 50 } catch (error) { 51 console.error(`[backgroundTaskManager] requestSuspendDelay failed. code is ${error.code} message is ${error.message}`); 52 } 53} 54 55// 获取进入挂起前的剩余时间 56async function getRemainingDelayTime() { 57 try { 58 await backgroundTaskManager.getRemainingDelayTime(id).then(res => { 59 console.log('[backgroundTaskManager] promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res)); 60 }).catch(error => { 61 console.error(`[backgroundTaskManager] promise => Operation getRemainingDelayTime failed. code is ${error.code} message is ${error.message}`); 62 }) 63 } catch (error) { 64 console.error(`[backgroundTaskManager] promise => Operation getRemainingDelayTime failed. code is ${error.code} message is ${error.message}`); 65 } 66} 67 68// 取消延迟挂起 69function cancelSuspendDelay() { 70 backgroundTaskManager.cancelSuspendDelay(id); 71} 72 73async function performingLongRunningTask() { 74 // 在执行具体的耗时任务前，调用短时任务申请接口。向系统申请延迟挂起，延长应用的后台执行时间。 75 requestSuspendDelay(); 76 77 // 根据需要，通过剩余时间查询接口，获取可用时间配额。 78 await getRemainingDelayTime(); 79 80 if (delayTime < 0) { // 如果时间配置少于一定的大小，考虑取消此次耗时操作。 81 // 处理短时任务配额时间不够的场景 82 cancelSuspendDelay(); 83 return; 84 } 85 86 // 此处执行具体的耗时任务 87 88 // 耗时任务执行完，调用短时任务取消接口，避免配额浪费 89 cancelSuspendDelay(); 90} 91``` 92