千鋒教育鴻蒙（HarmonyOS）開發(fā)教程：應(yīng)用內(nèi)HSP開發(fā)指導(dǎo)

應(yīng)用內(nèi)HSP指的是專門為某一應(yīng)用開發(fā)的HSP，只能被該應(yīng)用內(nèi)部其他HAP/HSP使用，用于應(yīng)用內(nèi)部代碼、資源的共享。

應(yīng)用內(nèi)HSP跟隨其宿主應(yīng)用的APP包一起發(fā)布，與該宿主應(yīng)用具有相同的包名和生命周期。

開發(fā)應(yīng)用內(nèi)HSP

HSP模塊可以在DevEco Studio中由指定模板創(chuàng)建，我們以創(chuàng)建一個(gè)名為library的HSP模塊為例?；镜墓こ棠夸浗Y(jié)構(gòu)大致如下：

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

 模塊module.json5中的"type"標(biāo)識(shí)模塊類型，HSP的"type"是"shared"。

{
    "type": "shared"
}

 HSP通過在入口文件中導(dǎo)出接口，對(duì)外提供能力。入口文件在模塊oh-package.json5的"main"中配置。例如：

{
    "main": "./src/main/ets/index.ets"
}

 導(dǎo)出ts類和方法

通過export導(dǎo)出ts類和方法，例如：

// library/src/main/ets/utils/test.ts
export class Log {
    static info(msg) {
        console.info(msg);
    }
}

export function add(a: number, b: number) {
  return a + b;
}

export function minus(a: number, b: number) {
  return a - b;
}

 對(duì)外暴露的接口，需要在入口文件index.ets中聲明：

// library/src/main/ets/index.ets
export { Log, add, minus } from './utils/test'

 導(dǎo)出ArkUI組件

ArkUI組件也可以通過export導(dǎo)出，例如：

// library/src/main/ets/components/MyTitleBar.ets
@Component
export struct MyTitleBar {
  build() {
    Row() {
      Text($r('app.string.library_title'))
        .fontColor($r('app.color.white'))
        .fontSize(25)
        .margin({left:15})
    }
    .width('100%')
    .height(50)
    .padding({left:15})
    .backgroundColor('#0D9FFB')
  }
}

 對(duì)外暴露的接口，需要在入口文件index.ets中聲明：

// library/src/main/ets/index.ets
export { MyTitleBar } from './components/MyTitleBar'

 HSP中資源使用說明

注意，在HSP中，通過$r/$rawfile可以使用本模塊resources目錄下的資源。

如果使用相對(duì)路徑的方式，例如：

在HSP模塊中使用Image("common/example.png")，實(shí)際上該Image組件訪問的是HSP調(diào)用方(如entry)下的資源entry/src/main/ets/common/example.png。

導(dǎo)出native方法

在HSP中也可以包含C++編寫的so。對(duì)于so中的native方法，HSP通過間接的方式導(dǎo)出，以導(dǎo)出libnative.so的乘法接口multi為例：

// ibrary/src/main/ets/utils/nativeTest.ts
import native from "libnative.so"

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

 對(duì)外暴露的接口，需要在入口文件index.ets中聲明：

// library/src/main/ets/index.ets
export { nativeMulti } from './utils/nativeTest'

 使用應(yīng)用內(nèi)HSP

要使用HSP中的接口，首先需要在使用方的oh-package.json5中配置對(duì)它的依賴。如果應(yīng)用內(nèi)HSP和使用方在同一工程下，可以直接本地引用，例如：

// entry/oh-package.json5
"dependencies": {
    "library": "file:../library"
}

 然后就可以像使用HAR一樣調(diào)用HSP的對(duì)外接口了。

例如，上面的library已經(jīng)導(dǎo)出了下面這些接口：

// library/src/main/ets/index.ets
export { Log, add, minus } from './utils/test'
export { MyTitleBar } from './components/MyTitleBar'
export { nativeMulti } from './utils/nativeTest'

 在使用方的代碼中，可以這樣使用：

// entry/src/main/ets/pages/index.ets
import { Log, add, MyTitleBar, nativeMulti } from "library"

@Entry
@Component
struct Index {
  @State message: string = 'Hello World'
  build() {
    Row() {
      Column() {
        MyTitleBar()
        Text(this.message)
          .fontSize(30)
          .fontWeight(FontWeight.Bold)
        Button('add(1, 2)')
          .onClick(()=>{
            Log.info("add button click!");
            this.message = "result: " + add(1, 2);
          })
        Button('nativeMulti(3, 4)')
          .onClick(()=>{
            Log.info("nativeMulti button click!");
            this.message = "result: " + nativeMulti(3, 4);
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

 跨包頁面路由跳轉(zhuǎn)

若開發(fā)者想在entry模塊中，添加一個(gè)按鈕跳轉(zhuǎn)至library模塊中的menu頁面(路徑為：library/src/main/ets/pages/menu.ets)，那么可以在使用方的代碼(entry模塊下的Index.ets，路徑為：entry/src/main/ets/MainAbility/Index.ets)里這樣使用：

import router from '@ohos.router';

@Entry
@Component
struct Index {
    @State message: string = 'Hello World'

    build() {
    Row() {
        Column() {
        Text(this.message)
            .fontSize(50)
            .fontWeight(FontWeight.Bold)
        // 添加按鈕，以響應(yīng)用戶點(diǎn)擊
        Button() {
            Text('click to menu')
            .fontSize(30)
            .fontWeight(FontWeight.Bold)
        }
        .type(ButtonType.Capsule)
        .margin({
            top: 20
        })
        .backgroundColor('#0D9FFB')
        .width('40%')
        .height('5%')
        // 綁定點(diǎn)擊事件
        .onClick(() => {
            router.pushUrl({
              url: '@bundle:com.example.hmservice/library/ets/pages/menu'
            }).then(() => {
              console.log("push page success");
            }).catch(err => {
              console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`);
            })
        })
      .width('100%')
    }
    .height('100%')
    }
  }
}

 其中router.pushUrl方法的入?yún)⒅衭rl的內(nèi)容為：

'@bundle:com.example.hmservice/library/ets/pages/menu'

 url內(nèi)容的模板為：

'@bundle:包名（bundleName）/模塊名（moduleName）/路徑/頁面所在的文件名(不加.ets后綴)'