• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 应用内HSP开发指导
2
3应用内`HSP`指的是专门为某一应用开发的`HSP`，只能被该应用内部其他`HAP`/`HSP`使用，用于应用内部代码、资源的共享。
4应用内`HSP`跟随其宿主应用的APP包一起发布，与该宿主应用具有相同的包名和生命周期。
5
6## 开发应用内HSP
7
8`HSP`模块可以在`DevEco Studio`中由指定模板创建，我们以创建一个名为`library`的`HSP`模块为例。基本的工程目录结构大致如下：
9```
10library
11├── src
12│   └── main
13│       ├── ets
14│       │   ├── pages
15│       │   └── index.ets
16│       ├── resources
17│       └── module.json5
18└── oh-package.json5
19```
20模块`module.json5`中的`"type"`标识模块类型，`HSP`的`"type"`是`"shared"`。
21```json
22{
23    "type": "shared"
24}
25```
26
27`HSP`通过在入口文件中导出接口，对外提供能力。入口文件在模块`oh-package.json5`的`"main"`中配置。例如：
28```json
29{
30    "main": "./src/main/ets/index.ets"
31}
32```
33
34### 导出ts类和方法
35通过`export`导出ts类和方法，例如：
36```ts
37// library/src/main/ets/utils/test.ts
38export class Log {
39    static info(msg) {
40        console.info(msg);
41    }
42}
43
44export function add(a: number, b: number) {
45  return a + b;
46}
47
48export function minus(a: number, b: number) {
49  return a - b;
50}
51```
52对外暴露的接口，需要在入口文件`index.ets`中声明：
53```ts
54// library/src/main/ets/index.ets
55export { Log, add, minus } from './utils/test'
56```
57
58### 导出ArkUI组件
59ArkUI组件也可以通过`export`导出，例如：
60```ts
61// library/src/main/ets/components/MyTitleBar.ets
62@Component
63export struct MyTitleBar {
64  build() {
65    Row() {
66      Text($r('app.string.library_title'))
67        .fontColor($r('app.color.white'))
68        .fontSize(25)
69        .margin({left:15})
70    }
71    .width('100%')
72    .height(50)
73    .padding({left:15})
74    .backgroundColor('#0D9FFB')
75  }
76}
77```
78对外暴露的接口，需要在入口文件`index.ets`中声明：
79```ts
80// library/src/main/ets/index.ets
81export { MyTitleBar } from './components/MyTitleBar'
82```
83#### HSP中资源使用说明
84注意，在`HSP`中，通过`$r`/`$rawfile`可以使用本模块`resources`目录下的资源。
85如果使用相对路径的方式，例如：
86在`HSP`模块中使用`Image("common/example.png")`，实际上该`Image`组件访问的是`HSP调用方`（如`entry`）下的资源`entry/src/main/ets/common/example.png`。
87
88### 导出native方法
89在`HSP`中也可以包含`C++`编写的`so`。对于`so`中的`native`方法，`HSP`通过间接的方式导出，以导出`libnative.so`的乘法接口`multi`为例：
90```ts
91// ibrary/src/main/ets/utils/nativeTest.ts
92import native from "libnative.so"
93
94export function nativeMulti(a: number, b: number) {
95    return native.multi(a, b);
96}
97```
98
99对外暴露的接口，需要在入口文件`index.ets`中声明：
100```ts
101// library/src/main/ets/index.ets
102export { nativeMulti } from './utils/nativeTest'
103```
104
105## 使用应用内HSP
106要使用`HSP`中的接口，首先需要在使用方的`oh-package.json5`中配置对它的依赖。如果应用内`HSP`和使用方在同一工程下，可以直接本地引用，例如：
107```json
108// entry/oh-package.json5
109"dependencies": {
110    "library": "file:../library"
111}
112```
113然后就可以像使用`HAR`一样调用`HSP`的对外接口了。
114例如，上面的`library`已经导出了下面这些接口：
115```ts
116// library/src/main/ets/index.ets
117export { Log, add, minus } from './utils/test'
118export { MyTitleBar } from './components/MyTitleBar'
119export { nativeMulti } from './utils/nativeTest'
120```
121在使用方的代码中，可以这样使用：
122```ts
123// entry/src/main/ets/pages/index.ets
124import { Log, add, MyTitleBar, nativeMulti } from "library"
125
126@Entry
127@Component
128struct Index {
129  @State message: string = 'Hello World'
130  build() {
131    Row() {
132      Column() {
133        MyTitleBar()
134        Text(this.message)
135          .fontSize(30)
136          .fontWeight(FontWeight.Bold)
137        Button('add(1, 2)')
138          .onClick(()=>{
139            Log.info("add button click!");
140            this.message = "result: " + add(1, 2);
141          })
142        Button('nativeMulti(3, 4)')
143          .onClick(()=>{
144            Log.info("nativeMulti button click!");
145            this.message = "result: " + nativeMulti(3, 4);
146          })
147      }
148      .width('100%')
149    }
150    .height('100%')
151  }
152}
153```