在鸿蒙的 ArkTS 开发中,declare 关键字不生成任何实际的代码,它的核心作用是为编译器提供类型声明。简单来说,就是告诉 TypeScript/ArkTS 编译器:“某个变量、函数或模块是存在的,它的类型是这样,你放心吧,它的具体实现在别处(比如 Native 层或第三方库)”。

核心作用:类型声明与占位

declare 主要用于处理那些不在当前 ArkTS 代码中定义,但需要在当前代码中安全使用的场景。

  • 声明全局变量或类型:用于定义项目中全局可用的类型或变量。

// 声明一个全局类型
declare type UserID = string;

// 声明一个全局常量,它的值可能在编译时注入
declare const APP_VERSION: string;
  • 描述外部模块(如 C++ Native 接口):当 ArkTS 通过 N-API 调用 C++ 代码时,用 declare 来描述 Native 层的接口,保证类型安全。
// 声明一个 Native 模块
declare namespace MathNative {
  function add(a: number, b: number): number;
}

// 在 ArkTS 中调用,编译器知道 add 的存在和类型
let result = MathNative.add(5, 3);
  • 为第三方 JavaScript 库提供类型定义:在引入一个未提供类型声明(.d.ts 文件)的 JS 库时,可以自己用 declare 来描述它的 API,以便获得代码提示和静态检查。
// third-party.d.ts
declare module "some-js-library" {
  export function init(config: object): void;
  export class Manager {
    start(): void;
  }
}
  • 扩展已有模块或全局对象:可以为已有的对象(如 ConsoleglobalThis)添加编译器原本不知道的属性或方法。
// 扩展全局 Console
declare global {
  interface Console {
    customLog(msg: string): void;
  }
}
// 现在可以使用 console.customLog()

用法

  • 通常放在声明文件中declare 语句通常放在以 .d.ts 为扩展名的类型声明文件中,这些文件只负责类型定义,不包含可执行逻辑。

  • 不生成代码:使用 declare 声明的代码在编译后会被完全移除,不会影响最终的程序体积。

  • 与 namespace 结合declare namespace 是一种常见用法,用于声明一个包含多个类型、接口或函数的命名空间,方便组织和避免命名冲突。

declare 就是给 ArkTS 编译器的一份“担保书”,告诉你:“这个东西肯定存在,可以按这个类型去用它”。在调用 Native 接口或第三方库时,能享受到类型安全和代码提示的好处。

Logo

作为“人工智能6S店”的官方数字引擎,为AI开发者与企业提供一个覆盖软硬件全栈、一站式门户。

更多推荐