harmony 鸿蒙Timer (定时器)

2025-06-16
浏览 (2)

Timer (定时器)

本模块提供基础的定时器能力，支持按照指定的时间执行对应函数。

说明：

本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

在UI界面中使用定时器时，定时器的触发机制会受UI底层原理管控。如果UI界面退到后台，定时器会被冻结。

setTimeout

setTimeout(handler: Function|string, delay?: number, …arguments: any[]): number

设置一个定时器，该定时器在定时器到期后执行一个函数。
该定时器在回调被执行后自动删除，或使用clearTimeout接口手动删除。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
handler	Function \|string	是	类型为Function表示定时器到期后执行函数；类型为string则通过Error方式打印string中内容，不进行其他处理。
delay	number	否	延迟的毫秒数，函数的调用会在该延迟之后发生。建议传入整数，若传入小数，会被向下取整。如果省略该参数，delay取默认值0。注意： 1. 无论是哪种情况，实际延迟可能会比预期长一些。 2. 如果值小于1，会被默认取0。 3. delay值受系统限制，超出2^32 - 1时会溢出，delay值为0。
…arguments	any[]	否	附加参数，仅当handler类型为Function时生效，作为参数传递给handler。 arguments参数数量少于handler函数参数数量时，未被arguments覆盖的参数会被设为undefined。 arguments参数数量多于handler函数参数数量时，多余的arguments参数会被忽略，但可通过handler函数内部的arguments对象访问。

返回值：

类型	说明
number	该定时器的ID，定时器ID为进程共享，是从0开始顺序增加的整数，无重复值。

示例1：不带参数。

  setTimeout(() => {
    console.info('delay 1s');
  }, 1000);

示例2：带参数传递给函数(handle为function时参数与arguments参数个数一致)。

  function myFunction(param1: string, param2: string) {
    console.info(param1, param2);
  }
  setTimeout(myFunction, 1000, 'Hello', 'World');

示例3：带参数传递给函数(handle为function时参数比arguments参数个数少)。

  function myFunction(a: string, b: string) {
    console.info(a);
    // Output: hello
    console.info(b);
    // Output: world
    console.info(JSON.stringify(arguments));
    // Output: {"0":"hello","1":"world","2":"c++","3":"js"}
  }
  setTimeout(myFunction, 1000, 'hello', 'world', 'C++', 'js');

示例4：带参数传递给函数(handle为function时参数比arguments参数个数多)。

  function myFunction(a: string, b: string) {
    console.info(a);
    // Output: hello
    console.info(b);
    // Output: undefined
    console.info(JSON.stringify(arguments));
    // Output: {"0":"hello"}
  }
  setTimeout(myFunction, 1000, 'hello');

clearTimeout

clearTimeout(timeoutID?: number): void

可取消通过调用setTimeout()建立的定时器。

定时器对象保存在创建它的线程内，删除定时器时需要在该线程中进行。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
timeoutID	number	否	要取消定时器的ID，需要与调用setTimeout设置定时器的返回值一致。如果省略该参数或指定的定时器ID不存在时，不会取消任何定时任务。

示例：

  let timeoutID = setTimeout(() => {
    console.log('do after 1s delay.');
  }, 1000);
  clearTimeout(timeoutID);

setInterval

setInterval(handler: Function|string, delay: number, …arguments: any[]): number

重复调用一个函数，在每次调用之间具有固定的时间延迟。删除该定时器需手动调用clearInterval接口。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
handler	Function \|string	是	类型为Function表示定时器到期后执行函数；类型为string则通过Error方式打印string中内容，不进行其他处理。
delay	number	否	延迟的毫秒数，函数的调用会在该延迟之后发生。建议传入整数，若传入小数，会被向下取整。如果省略该参数，delay取默认值0。注意： 1. 无论是哪种情况，实际延迟可能会比预期长一些。 2. 如果值小于1，将被默认设置为0。 3. delay值受系统限制，超出2^32 - 1时会溢出，delay值为0。
…arguments	any[]	否	附加参数，仅当handler类型为Function时生效，作为参数传递给handler。 arguments参数数量少于handler函数参数数量时，未被arguments覆盖的参数会被设为undefined。 arguments参数数量多于handler函数参数数量时，多余的arguments参数会被忽略，但可通过handler函数内部的arguments对象访问。

返回值：

类型	说明
number	该定时器的ID，定时器ID为进程共享，是从0开始顺序增加的整数，无重复值。

示例：

  setInterval(() => {
    console.log('do every 1s.');
  }, 1000);

clearInterval

clearInterval(intervalID?: number): void

可取消通过setInterval()设置的重复定时任务。

定时器对象保存在创建它的线程内，删除定时器时需要在该线程中进行。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
intervalID	number	否	要取消的重复定时器的ID，需要与调用setInterval设置重复定时器的返回值一致。如果省略该参数或指定的重复定时器ID不存在时，不会取消任何定时任务。

示例：

  let intervalID = setInterval(() => {
    console.log('do every 1s.');
  }, 1000);
  clearInterval(intervalID);

其他说明

超时延迟

如果页面正忙于其他任务，超时可能比预期晚。setTimeout的函数或代码片段在下一个时间周期执行。例如：

  function foo() {
    console.info('OH test foo is called')
  }
  setTimeout(foo, 0);
  console.info('After OH test setTimeout')

  // output
  After OH test setTimeout
  OH test foo is called

这是因为，虽然setTimeout设置了0ms的延迟，但任务不会立即执行，而是被放入队列中，等待下一次事件循环。当前代码执行完毕后，队列中的函数才会被执行，因此最终的执行顺序可能与预期不一致。