开发鸿蒙 HarmonyOS 插件

安装 DevEco Studio

下载安装华为 DevEco Studio 集成开发环境（IDE）。

添加 ymx 仓库

ohpm 是鸿蒙的三方库依赖管理工具，其中央仓库地址为 https://ohpm.openharmony.cn/ohpm，网站为 https://ohpm.openharmony.cn

ymx 自建了 ohpm 私有仓库，地址为 https://zsite.cc/repos/ohpm/，ymx 插件及相关依赖包会发布到此仓库中。

在命令行或者 DevEco Studio 的 终端 窗口执行以下命令添加 ymx 私仓地址。

# 添加 ymx 的 https://zsite.cc/repos/ohpm/ 仓库
# 用逗号分割多个仓库地址，请确保 https://ohpm.openharmony.cn/ohpm/ 也在 registry 中，以便安装其他依赖包
ohpm config set registry https://zsite.cc/repos/ohpm/,https://ohpm.openharmony.cn/ohpm/

# 查看 ohpm 配置，确保 registry 中包含了 https://zsite.cc/repos/ohpm/
ohpm config get

repos

新建插件模块(module)

DevEco Studio → 文件 → 新建 → 模块

支持 HAR 静态共享包 Static Library 和 HSP 动态共享包 Shared Library 两种类型的插件模块，任选一种即可。

编辑模块的 oh-package.json5 文件，重点在于包名 name 和依赖 dependencies 字段。包名是平台全局唯一的，建议使用 @scope/name 的命名方式，scope 可以是公司或者组织的名字，name 是模块的名字。

{
  "name": "your-package-name",
  "version": "1.0.0",
  "description": "Please describe the basic information.",
  "main": "Index.ets",
  "author": "",
  "license": "Apache-2.0",
  "dependencies": {
    "@ymx/core": "..version"
  }
}

也可以在终端命令行控制台添加 @ymx/core 依赖：

# cd 到模块 oh-package.json5 所在目录
ohpm install @ymx/core

⚠️HSP 类型模块特别注意，需要编辑模块 build-profile.json5 文件为集成态 HSP 模式，添加 "hspIntegration": true 字段，否则您发布的插件包将无法编译打包进 App；HAR 类型模块无特别要求。

{
  "apiType": "stageMode",
  // ...
  "buildOptionSet": [
    {
      // ...
      "arkOptions": {
        "integratedHsp": true,
        // ...
      },
    },
  ],
  // ...
}

编写插件代码

简单示例代码，模块目录 src/main/ets/Index.ets

import * as ymx from "@ymx/core";

/**
 * 插件类需要继承自 ymx.Plugin 或 ymx.PluginWithConfig<TConfig>，并添加 @ymx.PluginClass() 注解。
 * 插件方法接收一个 ymx.PluginCall<TData> 参数，并添加 @ymx.PluginMethod() 注解。
 */
@ymx.PluginClass()
export class Index extends ymx.Plugin {

  /**
   * 返回当前时间
   * @param call void 类型表示不接收参数
   */
  @ymx.PluginMethod()
  now(call: ymx.PluginCall<void>) {
    const now = new Date().toLocaleString();
    call.resolve({
      now
    });
  }

  /**
   * echo 回显调用参数
   * @param call string 类型表示接收一个字符串参数
   */
  @ymx.PluginMethod()
  echo(call: ymx.PluginCall<string>) {
    call.resolve({
      hello: `hi ${call.data}`
    });
  }
}

编辑模块根目录下的 Index.ets 文件，导出插件类。注意 Index.ets 的文件名需要和 oh-package.json5 中 main 字段一致（默认就是 Index.ets）。

export { Index } from './src/main/ets/Index';

测试插件接口

现有或新建一个 Ability 应用，添加 @ymx/core 依赖 ohpm install @ymx/core
将您的插件模块依赖到 Ability 应用中

# cd 到 Ability 应用 oh-package.json5 所在目录，安装本地依赖 file:插件所在目录，注意路径需要根据实际情况修改
ohpm install file:../your-plugin-module-directory

构建和发布插件包

将 DevEco Studio 构建模式改为 release（调试的时候请改回 debug 模式）

构建模式

选中插件模块，点击顶部菜单构建模块，构建成功即可在模块 build 目录找到 .har 或 .hsp 包。

构建模块

将构建好的 .har 或 .hsp 包发布到 ymx 或者 openharmony 仓库。⚠️ openharmony 中央仓库不支持上传 .hsp 包，如果您的插件是 .hsp 包只能发布到 ymx 仓库。
在 ymx 后台新建插件并依赖上述插件包，插件可设置为 私有（仅自己可用）或 公开（发布到插件市场）。

使用插件

在 ymx 后台新建应用，添加插件，生成 App 安装到设备上，编写 js 调用插件接口

// your-plugin-id 为你新建插件时设置的插件 ID
const myPlugin = ymx.requirePlugin('your-plugin-id');
myPlugin.echo('张三')
  .then(res => {
    alert(res.hello);
  })
  .catch(err => {
    alert(`${err.errCode}: ${err.errMsg}`);
  });

指南

API 接口

签名证书和应用商店

开发插件

辅助工具 XBuilder