OpenHarmony—应用间HSP开发指导

OpenHarmony开发者

发布于 2023-9-11 19:00

浏览

0收藏

应用间HSP用于不同应用间的代码、资源共享。应用间HSP的宿主应用是一种特殊状态的应用，只能由一个HSP组成，不会独立运行在设备上，而是被普通应用模块的依赖项引用。当普通应用运行时，通过动态调用的方式使用应用间HSP提供的能力，从而实现应用自身所需要的功能。

注意事项

1. 应用间HSP的代码会运行在开发者应用的进程中，调用相关代码时，需要做好异常捕获与容错处理，防止由于应用间HSP功能异常导致的稳定性问题。

2. 一个应用可以同时依赖多个应用间HSP。

3. 应用间HSP会影响开发者应用自身的启动时间，依赖过多的应用间HSP可能会导致启动时延发生明显的劣化，建议将依赖的数目控制在16个以内。

4. 应用间HSP安装时需要对特权权限进行校验，如果想要开发应用间HSP，需要配置allowAppShareLibrary应用特权，具体配置方式参考应用特权配置指南。

应用间HSP的使用

应用间HSP会分为两部分对外发布：

一部分为HAR，HAR包中不会包含具体的功能实现代码，而仅仅包含导出的对象与方法，所以体积很小。应用开发者将HAR包集成到自身的工程中，然后就可以通过调用HAR包中提供的对象与方法完成自身的应用功能。

另外一部分为HSP，这部分为应用间HSP的具体实现，里面包含js/ts代码、C++库、资源和配置文件。这部分会上架到应用市场或者集成到系统版本中。

集成应用间HSP的HAR

HAR中的index.ets文件是应用间HSP导出的声明文件的入口，所有需要导出的接口，统一在index.ets文件中定义。index.ets文件路径如下：

liba
├── src
│   └── main
│       ├── ets
│       │   ├── pages
│       │   └── index.ets
│       ├── resources
│       └── module.json5
└── oh-package.json5

对外暴露的接口，需要在入口文件index.ets中声明：

index.ets内容样例如下：

// liba/src/main/ets/index.ets
export { hello, foo1, foo2, nativeMulti, UIComponent } from './ui/MyUIComponent'

其中UIComponent为导出的ArkUI组件，hello()、foo1()与foo2()为应用间HSP导出的ts方法，nativeMulti()方法为应用间HSP导出的native方法。具体实现如下：

ArkUI组件

在HSP中ArkUI组件的具体实现样例：

// liba/src/main/ets/ui/MyUIComponent.ets
@Component
export struct UIComponent {
  @State message: string = 'Hello World'
  build() {
    Column() {
      Text(this.message)
        .fontSize(32)
        .padding(8)
        .fontColor(0xffffff)
        .backgroundColor(0x0000ff)
    }.padding(8).width('100%')
  }
}

ts方法

在HSP中ts方法的具体实现：

// liba/src/main/ets/ui/MyUIComponent.ets
export function hello(name: string): string {
  return "hello + " + name;
}

export function foo1() {
  return "foo1";
}

export function foo2() {
  return "foo2";
}

native方法

在HSP中也可以包含C++编写的so。对于so中的native方法，HSP通过间接的方式导出，以导出libnative.so的乘法接口multi为例：

// liba/src/main/ets/ui/MyUIComponent.ets
import native from "libnative.so"

export function nativeMulti(a: number, b: number) {
    let result: number = native.multi(a, b);
    return result;
}

使用HAR导出的能力

引用HAR前，需要先配置对HAR的依赖，配置方式可参考文档。HAR配置成功后，在配置模块的module.json5中会生成相关依赖项信息，如下所示：

"dependencies": [
      {
        "bundleName": "com.share.liba",
        "moduleName": "liba",
        "versionCode": 10001
      }
]

其中bundleName为应用间HSP的bundle名称，moduleName为应用间HSP的模块名称，versionCode为应用间HSP的版本号。

使用HAR中的ArkUI组件

HAR的依赖配置成功后，可以引用HAR的ArkUI组件。ArkUI组件的导入方式与ts的导入方式一致，通过import引入HAR导出的ArkUI组件，示例如下所示：

import { UIComponent } from 'liba'

@Entry
@Component
struct Index {
  @State message: string = 'Hello World'
  build() {
    Row() {
      // 引用HAR的ArkUI组件
      UIComponent()
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
      }
      .width('100%')
    }
    .height('100%')
  }
}

使用HAR中的ts方法

通过import引用HAR导出的ts类和方法，示例如下所示：

import { foo1 } from 'liba'
import { foo2 } from 'liba'

@Component
struct Index {
  build() {
    Row() {
      Column() {
        Button('Button')
          .onClick(()=>{
            // 引用HAR的ts方法
            foo1();
            foo2();
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

使用HAR中的native方法

通过import引用HAR导出的native方法，示例如下所示：

import { nativeMulti } from 'liba'

@Component
struct Index {
  build() {
    Row() {
      Column() {
        Button('Button')
          .onClick(()=>{
            // 引用HAR的native方法
            nativeMulti();
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}