uts-plugin.md 64.0 KB
Newer Older
D
DCloud_LXH 已提交
1 2 3 4
# UTS插件介绍

## 介绍

W
x  
wanganxp 已提交
5 6
> HBuilderX 3.6+ 支持uni-app中使用uts插件
> HBuilderX 3.9+ 支持uni-app x中使用uts插件
D
DCloud_LXH 已提交
7

DCloud_JSON's avatar
DCloud_JSON 已提交
8
UTS插件开发官方uni-im交流群[点此加入](https://im.dcloud.net.cn/#/?joinGroup=668cac1f8185e1e6e7c1bb87)
D
DCloud_LXH 已提交
9 10 11 12 13 14 15 16 17 18

### 什么是uts语言

uts,全称 uni type script,统一、强类型、脚本语言。

它可以被编译为不同平台的编程语言,如:

- web平台,编译为JavaScript
- Android平台,编译为Kotlin
- iOS平台,编译为Swift(HX 3.6.7+ 版本支持)
雪洛's avatar
雪洛 已提交
19
- harmonyOS平台,编译为ArkTs(HX 4.22+ 版本支持)在现有架构下,ArkTs和JS在同一环境下执行,不涉及通讯等问题。
D
DCloud_LXH 已提交
20 21 22 23 24 25 26 27 28 29 30 31 32 33

uts 采用了与 ts 基本一致的语法规范,支持绝大部分 ES6 API。

如需详细了解uts语法,另见[uts语法介绍](/uts/)

uts语言,
- 可以用来开发独立App,即[uni-app x](https://doc.dcloud.net.cn/uni-app-x/)
- 也可以用来开发插件,即uts插件。

### 什么是uts插件

uts插件,指利用uts语法,操作原生的API(包括手机os的api或三方sdk),并封装成一个[uni_modules](https://uniapp.dcloud.net.cn/plugin/uni_modules.html)插件,供前端调用。

- uni-app中,是js来调用uts插件。(HBuilderX 3.6支持vue3编译器,3.6.8支持vue2编译器)
W
wanganxp 已提交
34 35
![uts插件结构](https://native-res.dcloud.net.cn/images/uts/UTS%E7%BB%93%E6%9E%84%E7%A4%BA%E6%84%8F%E5%9B%BE1.png)

D
DCloud_LXH 已提交
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
- uni-app x中,是uts来调用uts插件。(HBuilderX 3.9支持)

也就是一个uts插件,可以同时支持uni-app和uni-app x。

为了兼容全端,uts插件可以分目录写所有平台代码,也就是一个uts插件除了支持App的扩展,还可以支持web、小程序。

比如这个uts插件,[电量](https://ext.dcloud.net.cn/plugin?id=9295),其源码在[https://gitcode.net/dcloud/uni-api/-/tree/master/uni_modules/uni-getbatteryinfo](https://gitcode.net/dcloud/uni-api/-/tree/master/uni_modules/uni-getbatteryinfo),内部有多个目录(app-android、app-ios、web、mp-weixin、mp-alipay...),在非App目录也可以写js。

这个电量插件在uni-app和uni-app x中均可以使用。

uts插件分api和组件。这和uni-app的组件、api的概念是一样的。
- api插件:uts插件扩展了api能力,在script里调用
- 组件插件:uts插件扩展了界面组件,在template里调用。它是要内嵌在页面中。

api插件也可以操作界面,但更多是独立的全屏窗口或弹出窗口。而不能嵌入在template中。

比如lottie动画的uts插件,就是一个组件插件。[https://ext.dcloud.net.cn/plugin?id=10674](https://ext.dcloud.net.cn/plugin?id=10674),其源码在[https://gitcode.net/dcloud/uni-component/-/tree/master/uni_modules/uni-animation-view](https://gitcode.net/dcloud/uni-component/-/tree/master/uni_modules/uni-animation-view)

### uts插件与uni原生语言插件的区别

uts 插件编译到 app 平台时,在功能上相当于 uni-app 之前的 app 原生插件。都是给app扩展原生能力。

开发 uts 插件不需要熟悉 Kotlin 和 Swift 的语法,因为使用的是 uts语法。但需要熟悉 Android 和 iOS 的系统 API,至少需要知道什么原生能力在哪个API里。

在 HBuilderX 3.6 以前,uni-app 在 App 侧只有一种原生插件,即用 java 或 Objective-C 开发的插件。

在 uts 推出后,原来的 “App原生插件”,更名为 “App原生语言插件”。

不同的名字,代表它们需要开发者编写语言不同。但殊途同归,最后都编译为原生的二进制代码。

|				|原生语言插件				|uts插件|
|:------		|:-------					|:--------|
|开发语言		|java/oc					|uts|
|开发环境		|Android Studio/XCode		|HBuilderX|
|打包方式		|外挂aar 等产出物			|编译时生成原生代码|
|js层调用方式	|uni.requireNativePlugin()	|普通的js函数/对象,可以直接 import,支持摇树优化|
|支持项目类型	|uni-app					|uni-app和uni-app x|

相对原生语言插件,uts插件的优势:

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
76
1. 统一了编程语言(uts),一种语言开发所有平台,真正大前端。而且uts插件还支持鸿蒙next。而App原生只支持Android和iOS。
D
DCloud_LXH 已提交
77 78
2. 统一了开发工具(HBuilderX),免除搭建复杂的原生开发环境。
3. 插件封装中要理解的概念更少。 传统原生语言插件需要在js和原生层处理通信,使用各种特殊转换,使用特殊语法导入,注意事项很多。**uts统一为纯前端概念,简单清晰。**
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
79
4. uts 下前端和原生可以统一在 HBuilderX 中联调,可以一起联编运行,可以把原生层信息打log到hx的控制台。而传统原生语言插件需要在多个开发工具间切换,联调复杂。
D
DCloud_LXH 已提交
80 81 82 83
5. 插件市场的uts插件支持下载后自己固定版本。而付费的原生语言插件只能使用最新版。
6. 插件市场的uts付费插件支持源码版销售和源码版权保护机制。而付费的原生语言插件不支持源码版销售。
7. uts插件可同时支持uni-app和uni-app x。

杜庆泉's avatar
杜庆泉 已提交
84 85
如果您是插件作者,可以了解更多uts插件和uni原生语言插件对插件作者的区别。[详见](https://uniapp.dcloud.net.cn/plugin/publish.html#utsdiff)

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
86
更新:**“App原生语言插件”已停止维护**,插件市场不再受理新增App原生插件。请插件开发者都使用uts插件。
D
DCloud_LXH 已提交
87 88 89

### uts插件和Native.js的区别

D
DCloud_LXH 已提交
90
- [Native.js](https://uniapp.dcloud.net.cn/tutorial/native-js.html) 运行在js上,通过反射调用os api。功能和性能都不及原生
D
DCloud_LXH 已提交
91 92 93 94 95
- uts 在 app 上不运行在 js 引擎里,是真正的原生。


## 创建uts插件

杜庆泉's avatar
杜庆泉 已提交
96 97
>> 注意: 目前仅支持通过HBuilder X 创建和使用UTS插件,不支持通过cli的方式使用UTS插件

DCloud-yyl's avatar
DCloud-yyl 已提交
98
### HBuilderX项目中uts插件目录结构
D
DCloud_LXH 已提交
99

DCloud-yyl's avatar
DCloud-yyl 已提交
100
在 uni-app / uni-app x 的项目工程下,提供了独立的目录 `utssdk`,来存放 uts 插件。
D
DCloud_LXH 已提交
101

D
DCloud_LXH 已提交
102
当然官方更推荐使用 [uni_modules](https://uniapp.dcloud.net.cn/plugin/uni_modules.html) 方式,这是更好的包管理方案。
D
DCloud_LXH 已提交
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

首先确保项目根目录存在 uni_modules 文件夹,如果不存在,需要手动创建一个。

![插件目录](https://native-res.dcloud.net.cn/images/uts/uni_modules.jpg)

### 新建步骤拆解

右键点击`uni_modules`目录 -> 新建插件

![新建插件1](https://native-res.dcloud.net.cn/images/uts/new_uts_plugin.jpg)

选择类型 **uts插件**

![新建插件2](https://native-res.dcloud.net.cn/images/uts/new_uts_plugin2_1.jpg)

**为了避免和插件市场的其他插件冲突,建议起一个自己的插件前缀名称。**

uts插件目录结构

![新建插件3](https://native-res.dcloud.net.cn/images/uts/new_uts_plugin3_1.jpg)


### package.json

package.json 为 uni_modules 插件配置清单文件,负责描述插件的基本配置。


```json
{
  "id": "uts-helloworld",
  "displayName": "uts插件示例",
  "version": "0.1",
  "description": "uts插件示例",
  "uni_modules": {
D
DCloud_LXH 已提交
137

D
DCloud_LXH 已提交
138 139 140 141
  }
}
```

D
DCloud_LXH 已提交
142
上面是一个默认的清单文件示例,关于 package.json 更多描述[详见](https://uniapp.dcloud.net.cn/plugin/uni_modules.html#package-json)
D
DCloud_LXH 已提交
143 144 145 146 147 148 149 150 151 152 153 154 155 156

### 插件的目录结构

<pre v-pre="" data-lang="">
	<code class="lang-" style="padding:0">
┌─common                          // 可跨端公用的uts代码。推荐,不强制
├─static                          // 静态资源
├─utssdk
│	├─app-android                 //Android平台目录
│	│	├─assets                  //Android原生assets资源目录,可选
│	│	├─libs                    //Android原生库目录,可选
│	│	├─res                     //Android原生res资源目录,可选
│	│	├─AndroidManifest.xml     //Android原生应用清单文件,可选
│	│	├─config.json             //Android原生配置文件
W
wanganxp 已提交
157
│	│	├─hybrid.kt               //Android混编的kt文件
D
DCloud_LXH 已提交
158 159 160 161 162 163 164 165
│	│	└─index.uts               //Android原生插件能力实现
│	├─app-ios                     //iOS平台目录
│	│	├─Frameworks              //iOS原生依赖的第三方 framework 依赖库存放目录,可选
│	│	├─Libs              	  //iOS原生依赖的第三方 .a 依赖库存放目录,可选
│	│	├─Resources               //iOS原生所依赖的资源文件存放目录,可选
│	│	├─info.plist              //iOS原生所需要添加到主 info.plist 文件中的配置文件,可选
│	│	├─UTS.entitlements        //iOS原生所需要添加到主工程 .entitlements 文件中的配置文件,可选
│	│	├─config.json             //iOS原生配置文件
W
wanganxp 已提交
166
│	│	├─hybrid.swift            //ios混编的swift文件
D
DCloud_LXH 已提交
167 168 169 170 171 172 173 174 175 176 177 178
│	│	└─index.uts               //iOS原生插件能力实现
│	├─web                         //web平台目录
│	│	└─index.uts
│	├─mp-alipay                   // 支付宝小程序平台,可选
│	├─mp-baidu                    // 百度小程序平台,可选
│	├─mp-jd                       // 京东小程序平台(仅限vue2),可选
│	├─mp-kuaishou                 // 快手小程序平台,可选
│	├─mp-lark                     // 飞书小程序平台,可选
│	├─mp-qq                       // QQ小程序平台,可选
│	├─mp-toutiao                  // 抖音小程序平台,可选
│	├─mp-weixin                   // 微信小程序平台,可选
│	├─mp-xhs                      // 小红书小程序平台(仅限vue2),可选
杜庆泉's avatar
杜庆泉 已提交
179
│	├─interface.uts               // 声明插件对外暴露的API,必需
lizhongyi_'s avatar
lizhongyi_ 已提交
180
│	├─unierror.uts                // 定义插件对外暴露的错误信息,可选
D
DCloud_LXH 已提交
181
│	└─index.uts                   // 跨平台插件能力实现,可选
杜庆泉's avatar
杜庆泉 已提交
182
└─package.json                    // 插件清单文件,必需
D
DCloud_LXH 已提交
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
</code>
</pre>


根目录 index.uts 文件是程序主入口。如果插件根目录下没有 index.uts,则会在编译到不同平台时,寻找分平台的目录下的 index.uts 文件。

比如编译到 app-android 平台时,如果 uts 插件根目录没有 index.uts,会寻找 utssdk/app-android/index.uts。如果也没有找到,会报错。

当同时存在分平台目录的 index.uts 和根目录 index.uts 时,会优先获取具体的分平台目录。

开发者有多种组织自己代码的方式:

1. 在插件根目录的 index.uts 中写条件编译代码。简单的业务一个文件搞定
2. 在插件根目录 index.uts 中写条件编译,import 分平台的文件
3. 不写根目录的 index.uts,直接在分平台目录写 index.uts。不跨端时,比如只做一个 Android 插件,这样写比较简单

杜庆泉's avatar
杜庆泉 已提交
199
插件对外暴露能力的总入口在 `interface.uts` ,他与 `index.uts`的关系是声明和实现的关系。
D
DCloud_LXH 已提交
200

杜庆泉's avatar
杜庆泉 已提交
201
在这里声明的类型,HBuilderX 可以自动识别 并进行语法提示。
D
DCloud_LXH 已提交
202 203


DCloud-yyl's avatar
DCloud-yyl 已提交
204
### App原生配置@utsAppDir
D
DCloud_LXH 已提交
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

#### Android平台原生配置

app-android 文件夹下存在Android平台原生配置,包括以下目录或文件

|目录名/文件名			|用途									|
|---					|---									|
|assets					|Android平台原生assets资源目录			|
|libs					|Android平台原生引用的三方jar/aar目录		|
|res					|Android平台原生res资源目录				|
|AndroidManifest.xml	|Android平台原生应用清单文件				|
|config.json			|Android平台下的配置文件					|
|index.uts				|主入口,interface.uts/index.d.ts声明的能力在Android平台下的实现	|


D
DCloud_LXH 已提交
220
##### assets
D
DCloud_LXH 已提交
221 222 223 224 225
Android平台原生assets资源目录,建议只保存UTS插件内置的资源文件。

除了插件下有assets目录,项目下也有。注意2者的区别。
如果需要插件使用者配置(如三方SDK的授权文件),则插件作者应该在插件文档中告诉插件使用者,配置到项目的Android原生应用资源目录,而不是配置在插件目录下。[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android)

D
DCloud_LXH 已提交
226
##### libs
D
DCloud_LXH 已提交
227
Android平台原生三方库目录,支持以下类型文件:
D
DCloud_LXH 已提交
228
- jar
D
DCloud_LXH 已提交
229
- aar
杜庆泉's avatar
杜庆泉 已提交
230 231 232 233
- so库

注意:UTS插件本地调试不支持直接使用so文件,需要将so文件和调用代码封装为AAR 或者分别集成 so和jar文件

D
DCloud_LXH 已提交
234 235 236

如果封装三方原生sdk为uni-app插件,可以将sdk的jar/aar文件放到此目录,但因为多个uts插件引用相同三方原生sdk时可能会产生冲突,所以如果sdk支持仓储,建议优先使用仓储配置,而不是直接把jar等文件放在libs目录。

杜庆泉's avatar
杜庆泉 已提交
237
仓储配置参考config.json的[dependencies](#androidconfigjson)
D
DCloud_LXH 已提交
238 239 240 241

关于libs目录的使用,可以参考 [Hello UTS](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules)


杜庆泉's avatar
杜庆泉 已提交
242 243 244



D
DCloud_LXH 已提交
245
##### res
D
DCloud_LXH 已提交
246 247 248 249 250
Android平台原生res资源目录,建议只保存UTS插件内置的资源文件。

除了插件下有res目录,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android)


D
DCloud_LXH 已提交
251
##### AndroidManifest.xml
D
DCloud_LXH 已提交
252 253 254 255
Android原生应用清单文件,建议只保存UTS插件内置的清单文件配置。

除了插件下有AndroidManifest.xml,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android)

W
wanganxp 已提交
256
##### config.json@androidconfigjson
D
DCloud_LXH 已提交
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
uts插件在Android平台的原生层配置文件,可以在其中配置依赖仓储等gradle相关内容。

```json
{
	// 使用NDK时支持的CPU类型,可选(打包时不要复制注释)
	"abis": [
	    "使用NDK时支持的cpu类型, 可取值armeabi-v7a|arm64-v8a|x86|x86_64"
	],
    // 依赖的仓储配置,可选,打包时会合并到原生工程的build.gradle中(打包时不要复制注释)
	"dependencies": [
		"androidx.core:core-ktx:1.6.0",
		{
			"id": "com.xxx.richtext:richtext",
			"source": "implementation 'com.xxx.richtext:richtext:3.0.7'"
		}
	],
    // Android系统版本要求,最低Android 5.0(打包时不要复制注释)
	"minSdkVersion": 21,
	"project": {
		"plugins": [
			"com.huawei.agconnect"
		],
		"dependencies": [
			"com.huawei.agconnect:agcp:1.6.0.300"
		]
	}
}
```

D
DCloud_LXH 已提交
286 287
- abis
当插件使用了NDK开发的so库时配置,描述插件支持CPU类型。
D
DCloud_LXH 已提交
288 289 290 291
可取值:armeabi-v7a、arm64-v8a、x86、x86_64

<a id="dependencies"/>

D
DCloud_LXH 已提交
292 293 294 295
- dependencies
配置插件依赖的仓储,云端打包时会合并到Android原生工程的build.gradle的
数组类型,数组中的项可以是字符串类型或JSON对象
对于字符串类型项,将会作为`implementation`方式依赖添加到build.gradle中,上面示例中"androidx.core:core-ktx:1.6.0"将会添加以下配置
D
DCloud_LXH 已提交
296 297 298 299 300
```
dependencies {
  implementation 'androidx.core:core-ktx:1.6.0'
}
```
D
DCloud_LXH 已提交
301
对于JSON类型项,将会把source字段值作为gradle源码添加到build.gradle中,上面示例中"id": "com.xxx.richtext:richtext"项将会添加以下配置
D
DCloud_LXH 已提交
302 303 304 305 306 307
```
dependencies {
  implementation 'com.xxx.richtext:richtext:3.0.7'
}
```

D
DCloud_LXH 已提交
308
- minSdkVersion
D
DCloud_LXH 已提交
309 310
插件支持的Android最低版本,整数类型,取值范围为Android API Level

DCloud-yyl's avatar
DCloud-yyl 已提交
311 312 313
  + uni-app 项目支持最低版本为19,即Android 4.4.2  
  + uni-app x 项目支持最低版本为21,即Android 5.0  

D
DCloud_LXH 已提交
314

D
DCloud_LXH 已提交
315 316
- project
	云端打包项目相关配置,当使用的三方SDK需要配置gradle插件时可配置此项:
杜庆泉's avatar
杜庆泉 已提交
317
	
D
DCloud_LXH 已提交
318 319
	+ plugins
		此配置将会添加到云端打包工程app及build.gradle文件的“plugins”中:
杜庆泉's avatar
杜庆泉 已提交
320

杜庆泉's avatar
杜庆泉 已提交
321
		```gradle
杜庆泉's avatar
杜庆泉 已提交
322 323 324 325 326 327 328
		plugins {
			id 'com.android.application'
			// 前面config.json示例配置将会添加如下配置
			id 'com.huawei.agconnect'
		}
		```

D
DCloud_LXH 已提交
329
	+ dependencies
杜庆泉's avatar
杜庆泉 已提交
330

杜庆泉's avatar
杜庆泉 已提交
331 332
		此配置将会添加到云端打包工程项目级build.gradle文件的“buildscript > dependencies”中:

杜庆泉's avatar
杜庆泉 已提交
333
		```gradle
杜庆泉's avatar
杜庆泉 已提交
334 335 336 337 338 339 340 341
		buildscript {
			dependencies {
				classpath 'com.android.tools.build:gradle:7.2.0'
				// 前面config.json示例配置将会添加如下配置
				classpath "com.huawei.agconnect:agcp:1.6.0.300"
			}
		}
		```
D
DCloud_LXH 已提交
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359


**注意:**

- Android平台原生配置(包括引入、变更三方sdk)均需提交云端打包才能生效,真机运行时需使用[自定义基座](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground)

- HBuilderX 内置了android常见的依赖:内置依赖清单 ,开发者需要注意两点:

    1 内置清单中涉及的依赖,无需手动添加,即可直接使用

    2 请勿通过 手动添加jar/aar 等方式引入相同的依赖,否则会因依赖冲突导致云打包失败。

#### iOS 平台原生配置

app-ios 文件夹下存在iOS平台原生配置,包括以下目录或文件

|目录名/文件名		|用途													|
|:---				|:---													|
DCloud-yyl's avatar
DCloud-yyl 已提交
360
|Frameworks			|iOS平台插件需要引用的三方 framework/xcframework 依赖库存放目录			|
D
DCloud_LXH 已提交
361 362 363 364 365 366 367
|Libs				|iOS平台插件需要引用的三方 .a 依赖库存放目录			    |
|Resources			|iOS平台插件需要引用的资源文件存放目录						|
|Info.plist			|iOS平台插件需要添加到原生工程Info.plist中的配置文件			|
|UTS.entitlements	|iOS平台插件需要添加到原生工程 entitlements 文件中的配置文件		|
|config.json		|iOS平台原生工程的配置文件									|
|index.uts			|主入口,interface.uts/index.d.ts声明的能力在iOS平台下的实现				|

D
DCloud_LXH 已提交
368
##### Frameworks
D
DCloud_LXH 已提交
369 370
iOS平台插件依赖的三方framework存放目录,支持以下类型文件:

D
DCloud_LXH 已提交
371
- framework
D
DCloud_LXH 已提交
372 373 374 375
- xcframework

注意:目前支持静态库和动态库

D
DCloud_LXH 已提交
376
##### Libs@ios-libs
D
DCloud_LXH 已提交
377 378 379 380
> HBuilder X 3.7.2+ 版本支持

iOS平台插件依赖的三方.a库存放目录,支持以下类型的.a库:

D
DCloud_LXH 已提交
381
- 使用OC语言创建的.a库
D
DCloud_LXH 已提交
382 383 384 385 386
- 使用Swift语言创建的.a库

备注:有关OC及Swift创建的.a库的区别、.a库的使用方法和注意事项[详见](https://uniapp.dcloud.net.cn/plugin/uts-for-ios)

##### Resources
D
DCloud_LXH 已提交
387
iOS平台原生资源目录,建议只保存uts插件内置的资源文件。云端打包时会将此目录下的所有文件添加到应用 main bundle 中。
D
DCloud_LXH 已提交
388

D
DCloud_LXH 已提交
389
除了插件下有Resources目录,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html#%E8%B5%84%E6%BA%90%E6%96%87%E4%BB%B6-bundle-resources)
D
DCloud_LXH 已提交
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430

##### Info.plist
iOS平台原生 Info.plist 文件配置,云端打包时会将配置信息合并到原生工程的 Info.plist 中。

除了插件下有Info.plist,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6-info-plist)

示例: 添加自定义字段 TencentLBSAPIKey 和 开启后台定位

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
	<key>TencentLBSAPIKey</key>
	<string>填写您申请的APIKey</string>
	<key>UIBackgroundModes</key>
	<array>
		<string>location</string>
	</array>
  </dict>
</plist>
```

##### UTS.entitlements
iOS平台原生 entitlements 文件配置,云端打包时会将配置信息合并到原生工程的 entitlements 配置文件中

插件需要开启 capabilities 中的相关服务时需要配置 UTS.entitlements 文件

示例:在 capabilities 中勾选 Access WiFi Information 项后对应的 UTS.entitlements 的配置

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>com.apple.developer.networking.wifi-info</key>
	<true/>
</dict>
</plist>
```

W
wanganxp 已提交
431
##### config.json@iosconfigjson
D
DCloud_LXH 已提交
432
uts插件在iOS平台的其它原生配置文件,可以在其中配置依赖的系统库等信息
D
DCloud_LXH 已提交
433 434 435 436

```json
{
	"frameworks": [
D
DCloud_LXH 已提交
437
		"可选,依赖的系统库(系统库有.framework和.tbd和.dylib类型)"
D
DCloud_LXH 已提交
438 439 440
	],
	"deploymentTarget": "9.0",   // 可选,插件支持的最低 iOS 版本  默认:9.0"
	"validArchitectures": [    // 可选,支持的 CPU 架构类型 默认:arm64
D
DCloud_LXH 已提交
441 442
		"arm64"
	],
D
DCloud_LXH 已提交
443 444
	"dependencies-pods": [ // 可选, 需要依赖的pod库, HBuilderX 3.8.5+ 版本支持
	{
D
DCloud_LXH 已提交
445 446
		"name": "WechatOpenSDK",
		"version": "2.0.2"
D
DCloud_LXH 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459
	}]
}
```

**配置说明:**
- frameworks:插件需要依赖的系统库(系统库有 .framework 和 .tbd 和 .dylib 类型),此节点为可选项。
- deploymentTarget:插件支持的最低 iOS 版本号,此节点为可选项,默认设置为 9.0.
	+ 插件支持的最低版本号应该设置为所有依赖的三方库(包含 framework .a pod )中最低支持版本号中的最高的一个。
	+ pod 库的最低支持系统版本号可在 pod 库的 spec 文件或者 readme 中查看。
- validArchitectures:插件支持的 CPU 架构类型,此节点为可选项,默认值为:arm64。
- dependencies-pods:插件需要依赖的 pod 库,  HBuilderX3.8.5+ 版本新增支持
	+ 有关 dependencies-pods 配置和 CocoaPods 使用的更多细节[详见](https://uniapp.dcloud.net.cn/plugin/uts-ios-cocoapods.html)

460 461 462 463 464 465
#### 鸿蒙原生配置

app-harmony文件夹存放uts插件编译到鸿蒙时的代码逻辑,目前仅支持uts文件。

|目录名/文件名	|用途																				|
|:---					|:---																				|
W
wanganxp 已提交
466
|index.uts		|主入口,interface.uts声明的能力在harmony平台下的实现	|
D
DCloud_LXH 已提交
467 468 469

## 开发uts插件

lizhongyi_'s avatar
lizhongyi_ 已提交
470 471 472 473
### 简单插件示例

#### 创建插件

W
wanganxp 已提交
474
在HBuilder X 中选中你的项目下`uni_modules`目录,右键选择新建uni_modules插件, 例如 `uts-api`
lizhongyi_'s avatar
lizhongyi_ 已提交
475 476


lizhongyi_'s avatar
lizhongyi_ 已提交
477
#### 编写interface.uts
lizhongyi_'s avatar
lizhongyi_ 已提交
478

杜庆泉's avatar
杜庆泉 已提交
479 480
插件 `uts-api` 创建完成后,我们需要确定插件对外暴露的 API。

W
wanganxp 已提交
481
为了多端统一规范的定义对外暴露的接口,获得更好的语法提示和多端一致性约束,标准做法是在 `interface.uts` 文件中统一定义插件要暴露的 API 类型、 API 的参数类型、返回值类型、错误码类型、错误接口等信息,然后在各端的 `index.uts` 中做具体的业务实现。
lizhongyi_'s avatar
lizhongyi_ 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

打开 `interface.uts` 文件,键入下面的源码, 为了方便说明,源码的每个部分的作用都用注释来说明。

```ts
// 定义 API的参数类型,基本数据类型的参数无需定义,复杂类型参数建议使用自定义type
/**
 * myApi 异步函数的参数,在type里定义函数需要的参数以及api成功、失败的相关回调函数。
 */
export type MyApiOptions = {
  paramA : boolean
  success ?: (res : MyApiResult) => void
  fail ?: (res : MyApiFail) => void
  complete ?: (res : any) => void
}

// 定义 API 的返回值类型, 基本数据类型的返回值无需特殊定义,复杂类型的参数建议使用自定义type
/**
 * 函数返回结果
 * 可以是void, 基本数据类型,自定义type, 或者其他类型。
 * [可选实现]
 */
export type MyApiResult = {
  fieldA : number,
  fieldB : boolean,
  fieldC : string
}

// 定义 API 对外暴露的错误码,为了更好语法提示和校验效果,建议将错误码用type 定义成联合类型。定义后,使用未指定的错误码将会被警告提示。
// 建议定义的错误码遵循uni错误规范 [详见](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)。
/**
 * 错误码
 * 根据uni错误码规范要求,建议错误码以90开头,以下是错误码示例:
 * - 9010001 错误信息1
 * - 9010002 错误信息2
 */
export type MyApiErrorCode = 9010001 | 9010002;


// 定义 API 的错误回调参数类型,这里定义成 interface 并继承 IUniError 是为了遵循统一的 Uni错误码规范。
// 这里开发者只需要指定 errCode 的类型,以便获得更好的语法提和校验效果。
/**
 * myApi 的错误回调参数
 */
export interface MyApiFail extends IUniError {
  errCode : MyApiErrorCode
};

// 定义对外暴露的 API 类型,这里是个异步函数
/* 异步函数定义 */
export type MyApi = (options : MyApiOptions) => void


// 定义对外暴露的 API 类型,这里是个同步函数
/* 同步函数定义 */
export type MyApiSync = (paramA : boolean) => MyApiResult

```

> 特别注意
W
wanganxp 已提交
541
> `interface.uts` 是官方推荐的多端一致性的最佳实践,不做强制要求,可以根据自己的实际情况决定是否实现。比如某个插件只有一个平台,不写interface也可以。
lizhongyi_'s avatar
lizhongyi_ 已提交
542 543
> `interface.uts` 文件中定义并 `export` 的 `interface` 接口例如 `MyApiFail` 只能在插件内部的 `uts` 文件代码中使用,不能在 `.uvue` 文件中使用插件时导入使用。

lizhongyi_'s avatar
lizhongyi_ 已提交
544
至此,我们就完成了 `interface` 的定义,如果你遵循规范,定义了错误码的类型和错误码的 `interface``MyApiFail`, 那么你还需要在 `unierror.uts` 文件中对 `MyApiFail` 这个接口做具体实现。
lizhongyi_'s avatar
lizhongyi_ 已提交
545 546


lizhongyi_'s avatar
lizhongyi_ 已提交
547
#### 编写unierror.uts
lizhongyi_'s avatar
lizhongyi_ 已提交
548

lizhongyi_'s avatar
lizhongyi_ 已提交
549 550
为了获得更好语法提示和校验效果,我们在 `interface.uts` 文件中已经定义了错误的类型和错误的接口。但是错误码对应的具体错误信息,以及错误对象的具体实现,都还没有完成。
`unierror.uts` 文件就是专门用来实现这些的。
lizhongyi_'s avatar
lizhongyi_ 已提交
551

lizhongyi_'s avatar
lizhongyi_ 已提交
552
打开 `unierror.uts` 文件, 键入下面的源码。同样为了说明,源码的每个部分的作用都用注释来说明。
lizhongyi_'s avatar
lizhongyi_ 已提交
553 554

``` ts
lizhongyi_'s avatar
lizhongyi_ 已提交
555
// 首先导入在 interface.uts 文件中定义的错误码类型,和错误的类型
lizhongyi_'s avatar
lizhongyi_ 已提交
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
import { MyApiErrorCode, MyApiFail } from "./interface.uts"

/**
 * 定义错误主题,错误主题是Uni错误码的一个标准字段。
 * 注意:错误主题一般为插件名称,每个组件不同,需要使用时请更改。
 * [可选实现]
 */
export const UniErrorSubject = 'uts-api';


/**
 * 错误信息,定义和错误码对应的语义化的提示信息,为了更好的获取,建议定义成Map类型。
 * @UniError
 * [可选实现]
 */
export const UTSApiUniErrors : Map<MyApiErrorCode, string> = new Map([
  /**
   * 错误码及对应的错误信息
   */
  [9010001, 'custom error mseeage1'],
  [9010002, 'custom error mseeage2'],
]);


/**
 * 错误对象的具体使用实现,该实现会在 index.uts代码中创建使用。
 * 使用时只需要传入特定的错误码即可完成创建。
 */
export class MyApiFailImpl extends UniError implements MyApiFail {
585
  override errCode: MyApiErrorCode
lizhongyi_'s avatar
lizhongyi_ 已提交
586 587 588 589 590 591 592
  /**
   * 错误对象构造函数
   */
  constructor(errCode : MyApiErrorCode) {
    super();
    this.errSubject = UniErrorSubject;
    this.errCode = errCode;
593
    this.errMsg = UTSApiUniErrors.get(errCode) ?? "";
lizhongyi_'s avatar
lizhongyi_ 已提交
594 595 596 597 598 599 600 601
  }
}

```

至此我们完成了符合 uni 错误规范的错误码的定义和实现,后面我们就可以去实现插件的具体逻辑了。
Uni错误规范的更多信息[详见](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)

lizhongyi_'s avatar
lizhongyi_ 已提交
602
#### 实现接口定义和业务逻辑
lizhongyi_'s avatar
lizhongyi_ 已提交
603

W
wanganxp 已提交
604
分别在插件的 `app-android``app-ios` 等目录下打开 `index.uts` 文件,键入下面的插件源码:
lizhongyi_'s avatar
lizhongyi_ 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792

::: preview

> Android

```ts

/**
 * 引用 Android 系统库,示例如下:
 * import { Context } from "android.content.Context";
 * [可选实现,按需引入]
 */

/* 引入 interface.uts 文件中定义的变量 */
import { MyApiOptions, MyApiResult, MyApi, MyApiSync } from '../interface.uts';

/* 引入 unierror.uts 文件中定义的变量 */
import { MyApiFailImpl } from '../unierror';

/**
 * 引入三方库
 * [可选实现,按需引入]
 *
 * 在 Android 平台引入三方库有以下两种方式:
 * 1、[推荐] 通过 仓储 方式引入,将 三方库的依赖信息 配置到 config.json 文件下的 dependencies 字段下。详细配置方式[详见](https://uniapp.dcloud.net.cn/plugin/uts-plugin.html#dependencies)
 * 2、直接引入,将 三方库的aar或jar文件 放到libs目录下。更多信息[详见](https://uniapp.dcloud.net.cn/plugin/uts-plugin.html#android%E5%B9%B3%E5%8F%B0%E5%8E%9F%E7%94%9F%E9%85%8D%E7%BD%AE)
 *
 * 在通过上述任意方式依赖三方库后,使用时需要在文件中 import,如下示例:
 * import { LottieAnimationView } from 'com.airbnb.lottie.LottieAnimationView'
 */

/**
 * UTSAndroid 为平台内置对象,不需要 import 可直接调用其API,[详见](https://uniapp.dcloud.net.cn/uts/utsandroid.html#utsandroid)
 */


/**
 * 异步方法
 *
 * uni-app项目中(vue/nvue)调用示例:
 * 1、引入方法声明 import { myApi } from "@/uni_modules/uts-api"
 * 2、方法调用
 * myApi({
 *   paramA: false,
 *   complete: (res) => {
 *      console.log(res)
 *   }
 * });
 * uni-app x项目(uvue)中调用示例:
 * 1、引入方法及参数声明 import { myApi, MyApiOptions } from "@/uni_modules/uts-api";
 * 2、方法调用
 * let options = {
 *   paramA: false,
 *   complete: (res : any) => {
 *     console.log(res)
 *   }
 * } as MyApiOptions;
 * myApi(options);
 *
 */
export const myApi : MyApi = function (options : MyApiOptions) {
  if (options.paramA == true) {
    // 返回数据
    const res : MyApiResult = {
      fieldA: 85,
      fieldB: true,
      fieldC: 'some message'
    };
    options.success?.(res);
    options.complete?.(res);
  } else {
    // 返回错误
    const err = new MyApiFailImpl(9010001);
    options.fail?.(err)
    options.complete?.(err)
  }
}

/**
 * 同步方法
 *
 * uni-app项目中(vue/nvue)调用示例:
 * 1、引入方法声明 import { myApiSync } from "@/uni_modules/uts-api"
 * 2、方法调用 myApiSync(true)
 *
 * uni-app x项目(uvue)中调用示例:
 * 1、引入方法及参数声明 import { myApiSync } from "@/uni_modules/uts-api";
 * 2、方法调用 myApiSync(true)
 */
export const myApiSync : MyApiSync = function (paramA : boolean) : MyApiResult {
  // 返回数据,根据插件功能获取实际的返回值
  const res : MyApiResult = {
    fieldA: 85,
    fieldB: paramA,
    fieldC: 'some message'
  };
  return res;
}


```

> iOS

```ts
/**
 * 引用 iOS 系统库,示例如下:
 * import { UIDevice } from "UIKit";
 * [可选实现,按需引入]
 */

/* 引入 interface.uts 文件中定义的变量 */
import { MyApiOptions, MyApiResult, MyApi, MyApiSync } from '../interface.uts';

/* 引入 unierror.uts 文件中定义的变量 */
import { MyApiFailImpl } from '../unierror';

/**
 * 引入三方库
 * [可选实现,按需引入]
 *
 * 在 iOS 平台引入三方库有以下两种方式:
 * 1、通过引入三方库framework 或者.a 等方式,需要将 .framework 放到 ./Frameworks 目录下,将.a 放到 ./Libs 目录下。更多信息[详见](https://uniapp.dcloud.net.cn/plugin/uts-plugin.html#ios-平台原生配置)
 * 2、通过 cocoaPods 方式引入,将要引入的 pod 信息配置到 config.json 文件下的 dependencies-pods 字段下。详细配置方式[详见](https://uniapp.dcloud.net.cn/plugin/uts-ios-cocoapods.html)
 *
 * 在通过上述任意方式依赖三方库后,使用时需要在文件中 import:
 * 示例:import { LottieLoopMode } from 'Lottie'
 */

/**
 * UTSiOS 为平台内置对象,不需要 import 可直接调用其API,[详见](https://uniapp.dcloud.net.cn/uts/utsios.html)
 */

/**
 * 异步方法
 *
 * uni-app项目中(vue/nvue)调用示例:
 * 1、引入方法声明 import { myApi } from "@/uni_modules/uts-api"
 * 2、方法调用
 * myApi({
 *   paramA: false,
 *   complete: (res) => {
 *      console.log(res)
 *   }
 * });
 *
 */
export const myApi : MyApi = function (options : MyApiOptions) {

  if (options.paramA == true) {
    // 返回数据
    const res : MyApiResult = {
      fieldA: 85,
      fieldB: true,
      fieldC: 'some message'
    };
    options.success?.(res);
    options.complete?.(res);

  } else {
    // 返回错误
    let failResult = new MyApiFailImpl(9010001);
    options.fail?.(failResult)
    options.complete?.(failResult)
  }

}

/**
 * 同步方法
 *
 * uni-app项目中(vue/nvue)调用示例:
 * 1、引入方法声明 import { myApiSync } from "@/uni_modules/uts-api"
 * 2、方法调用
 * myApiSync(true);
 *
 */
export const myApiSync : MyApiSync = function (paramA : boolean) : MyApiResult {
  // 返回数据,根据插件功能获取实际的返回值
  const res : MyApiResult = {
    fieldA: 85,
    fieldB: paramA,
    fieldC: 'some message'
  };
  return res;
}
```

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
> harmonyOS

```ts

/**
 * 引用鸿蒙系统库,示例如下:
 * import deviceInfo from "@ohos.deviceInfo";
 * [可选实现,按需引入]
 */

/* 引入 interface.uts 文件中定义的变量 */
import { MyApiOptions, MyApiResult, MyApi, MyApiSync } from '../interface.uts';

/* 引入 unierror.uts 文件中定义的变量 */
import { MyApiFailImpl } from '../unierror';

雪洛's avatar
雪洛 已提交
809 810 811 812
export {
  MyApiOptions
}

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/**
 * 引入三方库
 * 暂不支持,请留意后续更新
 */

/**
 * 异步方法
 *
 * uni-app项目中(vue/nvue)调用示例:
 * 1、引入方法声明 import { myApi } from "@/uni_modules/uts-api"
 * 2、方法调用
 * myApi({
 *   paramA: false,
 *   complete: (res) => {
 *      console.log(res)
 *   }
 * });
 *
 */
export const myApi : MyApi = function (options : MyApiOptions) {

  if (options.paramA == true) {
    // 返回数据
    const res : MyApiResult = {
      fieldA: 85,
      fieldB: true,
      fieldC: 'some message'
    };
    options.success?.(res);
    options.complete?.(res);

  } else {
    // 返回错误
    let failResult = new MyApiFailImpl(9010001);
    options.fail?.(failResult)
    options.complete?.(failResult)
  }

}

/**
 * 同步方法
 *
 * uni-app项目中(vue/nvue)调用示例:
 * 1、引入方法声明 import { myApiSync } from "@/uni_modules/uts-api"
 * 2、方法调用
 * myApiSync(true);
 *
 */
export const myApiSync : MyApiSync = function (paramA : boolean) : MyApiResult {
  // 返回数据,根据插件功能获取实际的返回值
  const res : MyApiResult = {
    fieldA: 85,
    fieldB: paramA,
    fieldC: 'some message'
  };
  return res;
}
```

lizhongyi_'s avatar
lizhongyi_ 已提交
873 874
:::

lizhongyi_'s avatar
lizhongyi_ 已提交
875 876 877

#### 使用插件

雪洛's avatar
雪洛 已提交
878
> 下面的示例代码为uni-app-x代码
雪洛's avatar
雪洛 已提交
879

lizhongyi_'s avatar
lizhongyi_ 已提交
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
上面的代码,我们完成了一个名为 "uts-api" 的UTS 插件,在 `uvue` 文件中使用该插件的代码示例如下:

```ts
// 导入要使用的插件  
import { myApi, myApiSync, MyApiOptions } from "@/uni_modules/uts-api";	

methods: {
	
	testMyApi() {
		// 调用异步方法示例
		let options = {
			paramA: false,
			complete: (res : any) => {
			console.log(res)
			}
		} as MyApiOptions;
		myApi(options);
	},
		
	testMyApiSync() {
		// 调用同步方法示例
		console.log(myApiSync(true))
	},
}

```


W
wanganxp 已提交
908 909 910 911 912 913 914 915
运行和编译uts插件,需要在HBuilderX的设置中配置Android和iOS的环境,见如下文档:
* [uts插件Android运行配置](https://uniapp.dcloud.net.cn/tutorial/run/uts-development-android.html)
* [uts插件iOS运行配置](https://uniapp.dcloud.net.cn/tutorial/run/uts-development-ios.html)

开发uts插件,调试、打断点是重要帮手,参考如下文档
* [uts插件Android Debug](https://uniapp.dcloud.net.cn/tutorial/debug/uni-uts-debug.html)
* [uts插件iOS Debug](https://uniapp.dcloud.net.cn/tutorial/debug/uni-uts-debug-ios.html)

D
DCloud_LXH 已提交
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
### 获取电量插件示例

以获取电量为例,介绍`uts`插件开发步骤

**首先在 `uni_modules` 目录下新建名为 uts-getbatteryinfo 的 uts 插件**

#### Android平台

![OSAPI示例](https://native-res.dcloud.net.cn/images/uts/uts_osapi_demo_1.jpg)

在Android平台目录下,编辑index.uts,键入以下内容。


```ts
// index.uts

// 引用android api
import Context from "android.content.Context";
import BatteryManager from "android.os.BatteryManager";
import { UTSAndroid } from "io.dcloud.uts";

export function getBatteryCapacity(): string {
	// 获取android系统 application上下文
    const context = UTSAndroid.getAppContext();
    if (context != null) {
        const manager = context.getSystemService(
            Context.BATTERY_SERVICE
        ) as BatteryManager;
        const currentLevel: number = manager.getIntProperty(
            BatteryManager.BATTERY_PROPERTY_CAPACITY
        );
        return '' + currentLevel + '%';
    }
    return "0%";
}

```


至此,我们已经完成一个Android平台上获取电量的原生能力封装。

我们可以在vue页面中这样使用它:

```ts

import { getBatteryCapacity } from "@/uni_modules/uts-getbatteryinfo";

console.log(getBatteryCapacity())

```


有些场景下,我们期望 将获取电量的能力封装为 异步的接口,我们可以使用下面的代码

```ts
import Context from "android.content.Context";
import BatteryManager from "android.os.BatteryManager";
import { UTSAndroid } from "io.dcloud.uts";


type GetBatteryInfoOptions = {
    success?: (res: object) => void
    fail?: (res: object) => void
    complete?: (res: object) => void
}

export function getBatteryInfo(options: GetBatteryInfoOptions) {
    const context = UTSAndroid.getAppContext();
    if (context != null) {
        const manager = context.getSystemService(
            Context.BATTERY_SERVICE
        ) as BatteryManager;
        const level = manager.getIntProperty(
            BatteryManager.BATTERY_PROPERTY_CAPACITY
        );
        const res = {
            errCode: 0,
            errSubject: "uts-getbatteryinfo",
            errMsg: "getBatteryInfo:ok",
            level,
            isCharging: manager.isCharging()
        }
        options.success?.(res)
        options.complete?.(res)
    } else {
        const res = {
			errCode: 1001,
			errSubject: "uts-getbatteryinfo",
            errMsg: 'getBatteryInfo:fail getAppContext is null'
        }
        options.fail?.(res)
        options.complete?.(res)
    }
}
```


对应的使用代码需要调整为:

```ts
import {getBatteryInfo} from "@/uni_modules/uts-getbatteryinfo";

getBatteryInfo({
	success(res) {
		uni.showToast({
			title: "当前电量:" + res.level + '%',
			icon: 'none'
		});
	}
})

```


在下一节,我们将更加详细地介绍 前端如何使用这个插件。

注1:HBuilderX的代码提示系统,支持在uts文件中对Android的原生API进行提示

杜庆泉's avatar
杜庆泉 已提交
1034
注2:`io.dcloud.uts.android`库介绍[文档](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-for-android.html#iodcloudutsandroid)
D
DCloud_LXH 已提交
1035 1036 1037

特别提示:

杜庆泉's avatar
杜庆泉 已提交
1038
**有android开发经验的开发者可以参考:[Android平台uts开发指南](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-for-android.html)**
D
DCloud_LXH 已提交
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062


#### iOS 平台

![](https://native-res.dcloud.net.cn/images/uts/iOS/getbatteryinfo1.png)

在 iOS 平台目录下,编辑 index.uts,键入以下内容

```ts
// index.uts

// 引用 iOS 原生平台 api
import { UIDevice } from "UIKit";

/**
 * 定义 接口参数
 */
type GetBatteryInfoOptions = {
    success?: (res: UTSJSONObject) => void;
    fail?: (res: UTSJSONObject) => void;
    complete?: (res: UTSJSONObject) => void;
};

/**
D
DCloud_LXH 已提交
1063
 * 导出 获取电量方法
D
DCloud_LXH 已提交
1064 1065
 */
export default function getBatteryInfo(options: GetBatteryInfoOptions) {
D
DCloud_LXH 已提交
1066

D
DCloud_LXH 已提交
1067 1068
	// 开启电量检测
	UIDevice.current.isBatteryMonitoringEnabled = true
D
DCloud_LXH 已提交
1069

D
DCloud_LXH 已提交
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
	// 返回数据
    const res = {
        errMsg: "getBatteryInfo:ok",
        level: Number(UIDevice.current.batteryLevel * 100),
        isCharging: UIDevice.current.batteryState == UIDevice.BatteryState.charging,
    };
    options.success?.(res);
    options.complete?.(res);
}
```

如果你想以同步接口的方式提供电量信息,代码可调整如下:

```ts
// index.uts

// 引用 iOS 原生平台 api
import { UIDevice } from "UIKit";

/**
D
DCloud_LXH 已提交
1090
 * 导出 获取电量方法
D
DCloud_LXH 已提交
1091 1092 1093 1094
 */
export default function getBatteryLevel():number {
	// 开启电量检测
	UIDevice.current.isBatteryMonitoringEnabled = true
D
DCloud_LXH 已提交
1095

D
DCloud_LXH 已提交
1096 1097 1098 1099 1100 1101 1102
	let level = Number(UIDevice.current.batteryLevel * 100)
	return level
}
```

至此,我们已经完成一个 iOS 平台上获取电量的原生能力封装。

1103 1104 1105 1106 1107 1108 1109
#### harmonyOS平台

在utssdk目录下创建harmonyOS平台目录app-harmony

在harmonyOS平台目录下,编辑index.uts,键入以下内容,即可完成harmonyOS平台获取电量能力。

```ts
杜庆泉's avatar
杜庆泉 已提交
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
import batteryInfo from '@ohos.batteryInfo';
import { GetBatteryInfo, GetBatteryInfoOptions, GetBatteryInfoSuccess, GetBatteryInfoResult, GetBatteryInfoSync } from '../interface.uts';

export const getBatteryInfoSync : GetBatteryInfoSync = function () : GetBatteryInfoResult {
  return {
    level: batteryInfo.batterySOC,
    isCharging: batteryInfo.chargingStatus === batteryInfo.BatteryChargeState.ENABLE || batteryInfo.chargingStatus === batteryInfo.BatteryChargeState.FULL,
  };
}

export const getBatteryInfo : GetBatteryInfo = function (options : GetBatteryInfoOptions) {
  const batteryInfoResult : GetBatteryInfoSuccess = {
    errMsg: "getBatteryInfo:ok",
    level: batteryInfo.batterySOC,
    isCharging: batteryInfo.chargingStatus === batteryInfo.BatteryChargeState.ENABLE || batteryInfo.chargingStatus === batteryInfo.BatteryChargeState.FULL,
  }
  try {
    options.success && options.success(batteryInfoResult)
  } catch (e) {
    console.error(e)
  }
  try {
    options.complete && options.complete(batteryInfoResult)
  } catch (e) {
    console.error(e)
  }
1136 1137 1138
}
```

D
DCloud_LXH 已提交
1139 1140

### 应用程序生命周期函数监听@hooksClass
D
DCloud_LXH 已提交
1141 1142


D
DCloud_LXH 已提交
1143 1144 1145 1146 1147 1148 1149 1150
> 特别注意:
> 此功能在 HBuilderX 3.97+ 版本支持,HBuilderX 3.97 之前的版本不支持。

#### iOS 平台

在插件开发过程中,有时我们需要监听 APP 的生命周期函数来完成一些业务逻辑,比如在应用启动时初始化三方 SDK, 在收到推送消息时做消息的处理,在被 url scheme 唤醒时调用指定功能等等。

在 iOS 平台可以通过自定义 class 遵循 `UTSiOSHookProxy` 协议的方式来实现对应用程序生命周期函数的监听。
D
DCloud_LXH 已提交
1151

D
DCloud_LXH 已提交
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177

> 注意:
> 该自定义 class 需要 export, 否则不会参与编译。
> 该自定义 class 会自动完成注册, 无需开发者进行额外注册。
> `UTSiOSHookProxy` 协议中所有的 api 均是可选实现的,可以选择自己关心的 api 进行实现。
> `UTSiOSHookProxy` 协议的定义[详见](https://uniapp.dcloud.net.cn/uts/UTSiOSHookProxy.html)

> 监听推送相关回调特别注意:
> 监听推送和本地通知相关的回调需要证书具备推送功能,正确配置 `aps-environment`,在打自定义基座时需要在 `manifest` 中勾选 `push` 模块,否则相关功能不会被打进基座内,对应回调也就不会触发(可以只勾选 push,而不选择具体 push 版本)。
> 勾选 `push` 模块后,系统会自动进行推送的注册,如果不需要自动注册,请在 `manifest` 中将 `pushRegisterMode` 字段设置为 `manual`。详细配置[详见](https://uniapp.dcloud.net.cn/collocation/manifest-app.html)


示例代码:

```ts
export class MyPluginClass implements UTSiOSHookProxy {
	// uts 插件创建时的回调。
	onCreate() {
	}
	// 应用正常启动时 (不包括已在后台转到前台的情况)的回调函数。
	applicationDidFinishLaunchingWithOptions(application: UIApplication | null, launchOptions: Map<UIApplication.LaunchOptionsKey, any> | null = null): boolean {
	    console.log("applicationDidFinishLaunchingWithOptions")
	    return false
	}
	// 远程通知注册成功时的回调函数。(打自定义基座时需要勾选 push 模块)
	didRegisterForRemoteNotifications(deviceToken: Data | null) {
D
DCloud_LXH 已提交
1178

D
DCloud_LXH 已提交
1179 1180
	}
	// 远程通知注册失败时的回调函数。(打自定义基座时需要勾选 push 模块)
D
DCloud_LXH 已提交
1181 1182
	didFailToRegisterForRemoteNotifications(error: NSError | null) {

D
DCloud_LXH 已提交
1183 1184 1185
	}
	// 应用收到远程通知时的回调函数。(打自定义基座时需要勾选 push 模块)
	didReceiveRemoteNotification(userInfo: Map<AnyHashable, any> | null) {
D
DCloud_LXH 已提交
1186

D
DCloud_LXH 已提交
1187 1188 1189
	}
	// 应用收到本地通知时的回调函数。(打自定义基座时需要勾选 push 模块)
	didReceiveLocalNotification(notification: UILocalNotification | null) {
D
DCloud_LXH 已提交
1190

D
DCloud_LXH 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
	}
	// 通过 url scheme 方式唤起 app 时的回调函数。(iOS9 之前的系统回调此方法,iOS9 之后的系统请使用 applicationOpenURLOptions)
	applicationHandleOpenURL(application: UIApplication | null, url: URL | null) : boolean {
	    return true
	}
	// 通过 url scheme 方式唤起 app 时的回调函数。
	applicationOpenURLOptions(app: UIApplication | null, url: URL, options: Map<UIApplication.OpenURLOptionsKey, any> | null = null) : boolean {
	    return true
	}
	// 当应用从活动状态主动变为非活动状态的时的回调函数。
	applicationWillResignActive(application: UIApplication | null) {
	    console.log("applicationWillResignActive")
	}
	// 应用完全激活时的回调函数。
	applicationDidBecomeActive(application: UIApplication | null) {

D
DCloud_LXH 已提交
1207
	}
D
DCloud_LXH 已提交
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
	// 应用程序进入后台时的回调函数。
	applicationDidEnterBackground(application: UIApplication | null) {
		console.log("did enter background")

	}
	// 当应用在后台状态,将要进入到前台运行时的回调函数。
	applicationWillEnterForeground(application: UIApplication | null) {
	    console.log("applicationWillEnterForeground")

	}
	// 应用程序的 main 函数。
	applicationMain(argc: Int32, argv: UnsafeMutablePointer<UnsafeMutablePointer<CChar> | null>) {
	    console.log("applicationMain")
	}
	// 当应用程序接收到与用户活动相关的数据时调用此方法,例如,当用户使用 Universal Link 唤起应用时。
	applicationContinueUserActivityRestorationHandler(application: UIApplication | null, userActivity: NSUserActivity | null, restorationHandler: ((res: [any] | null) => void) | null = null) : boolean {
D
DCloud_LXH 已提交
1224

D
DCloud_LXH 已提交
1225 1226 1227 1228
	    return true
	}
}
```
D
DCloud_LXH 已提交
1229

D
DCloud_LXH 已提交
1230 1231 1232 1233 1234 1235 1236

#### Android 平台

Android平台部分三方SDK的初始化依赖Application的onCreate生命周期回调。所以UTS提供了UTSAndroidHookProxy接口。用于支持三方SDK初始化的代码实现。

UTSAndroidHookProxy代码如下:

杜庆泉's avatar
杜庆泉 已提交
1237
```ts
D
DCloud_LXH 已提交
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
/**
 * 安卓原应用初始化回调代理
 * 注意:不支持调用uni api
 */
interface UTSAndroidHookProxy {
    /**
     * 安卓原生应用初始化
     * @param application
     */
    fun onCreate(application: Application)
}
```

开发者需要在插件代码中实现UTSAndroidHookProxy接口 示例如下:

杜庆泉's avatar
杜庆泉 已提交
1253
```ts
D
DCloud_LXH 已提交
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
export class AppHookProxy implements UTSAndroidHookProxy {
  override onCreate(application: Application) {
	//当前应用是否 取得用户同意隐私协议
	android.util.Log.d("AppHookProxy", "AppHookProxy--onCreate---")
	if(UTSAndroid.isPrivacyAgree()) {
		//onCreate 初始化三方SDK
		android.util.Log.d("AppHookProxy", "AppHookProxy--onCreate---isPrivacyAgree")
	}
  }
}
```

以上代码,将会在`Application``OnCreate`函数中被调用

HelloUTS nativepage 插件增加了UTSAndroidHookProxy [源码示例](https://gitcode.net/dcloud/hello-uts/-/blob/dev/uni_modules/uts-nativepage/utssdk/app-android/index.uts)

开发者使用HBuilder X 3.96 之后版本,提交云端打包自定义基座后,观察日志即可体验

注意:

+ 由于UTSAndroidHookProxy初始化要早于uni所以不支持调用uni api
+ 一个插件只允许实现一个UTSAndroidHookProxy接口class!
+ onCreate回调后应尽可能的判断隐私合规是否同意再初始化,否则影响app上架
+ Android平台添加或修改UTSAndroidHookProxy实现代码需要重新提交云端打包才能生效

1279
#### harmonyOS平台
D
DCloud_LXH 已提交
1280

1281
暂不支持此能力
D
DCloud_LXH 已提交
1282 1283 1284 1285


### `uts`与`uni-app`环境数据交互说明

1286 1287
> harmonyOS目前的架构为ets和js在同一环境下运行,不涉及此章节内容

D
DCloud_LXH 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

UTS向uni-app传值,支持下列类型:


1. TS基本数据类型: number,string,boolean 等
```ts
// 基础类型-Number
export function getPluginVersionNum(): number{
	return 120
}
// 基础类型-string
export function getPluginVersion(): string{
	return "1.2.0"
}
```

D
DCloud_LXH 已提交
1304
2. UTSJSONObjct
D
DCloud_LXH 已提交
1305 1306 1307 1308

```ts
// UTSJSONObjct 示例
export function getPluginVersion(): UTSJSONObject{
D
DCloud_LXH 已提交
1309

D
DCloud_LXH 已提交
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
	var ret = {
		version: "1.2.0",
		versionNum: 120,
		pluginArray:["core","debug","network"]
	}
	return ret
}
```



uni-app向UTS环境传值,支持下列类型:

1 TS基本数据类型: number,string,boolean 等
```ts
// 基础数据类型示例
export function postUserInfo(name:string,age:number){
	console.log("name == " + name);
	console.log("age == " + age);
}
```

```js
// uni-app 调用代码
postUserInfo("zhangsan",12);
```

2 type数据类型

```ts
// type 数据类型示例
export function postUserInfo(name:string,age:number){
	console.log("name == " + name);
	console.log("age == " + age);
}
```

```js
// uni-app 调用代码
postUserInfo({
	name:"zhangsan",
	age:12
});
```


3 UTSJSONObjct

```ts
// UTSJSONObjct 数据类型示例
export function postUserInfo(user:UTSJSONObject){
	console.log(user);
}
```

D
DCloud_LXH 已提交
1365
需要注意的是,在声明为`any`类型的前提下, `uni-app` 环境中的 `Object` 在UTS环境中也会被转换为 `UTSJSONObjct`.
D
DCloud_LXH 已提交
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390

也就是说上面的代码同样可以写作

```ts
// UTSJSONObjct 数据类型示例-2
export function postUserInfo(user:any){
	console.log(user);
}
```


```js
// uni-app 调用代码
postUserInfo({
	name:"zhangsan",
	age:12,
	scoreInfo:{
		"语文":100,
		"数学":80,
	}
});

```


D
DCloud_LXH 已提交
1391
更多UTSJSONObject的用法,[详见](../uts/data-type.md#utsjsonobject)
D
DCloud_LXH 已提交
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409

遗留问题:

有些场景,我们需要参数对象包含对象数组,比如
```json
{
	"name": "zhangsan",
	"teacher": [{
			"id": "1",
			"name": "kongzi"
		},
		{
			"id": "2",
			"name": "mengzi"
		}
	]
}
```
杜庆泉's avatar
杜庆泉 已提交
1410
目前在uni-app 环境下,复杂参数的传递是存在一定的缺陷。我们不能将teacher 声明为具体的类型数组,需要声明为any数组:
D
DCloud_LXH 已提交
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429


```ts
type Param{
	name:string,
	// 不能声明为 Teacher[]
	teacher: any[];
}
```
访问数组元素时,通过 UTSJSONObjct 包装访问
```ts
// 循环遍历
list1.forEach((item : any) => {
    const utsItem = new UTSJSONObject(item)
})
```

这个问题,我们稍后会改进。

lizhongyi_'s avatar
lizhongyi_ 已提交
1430
> 特别注意:
杜庆泉's avatar
杜庆泉 已提交
1431
> 在uni-app 环境下,在 index.uts 文件中 `export` 的 `class` 默认会对 `js`暴露,因此要建立起原生 `class` 和 `js`类型的映射关系,只有能正常建立起这种映射关系的类才能导出。除一些基本数据类型外的系统类例如 `Activity`、`UIViewController`等是无法 `export` 的。
lizhongyi_'s avatar
lizhongyi_ 已提交
1432

D
DCloud_LXH 已提交
1433

杜庆泉's avatar
杜庆泉 已提交
1434

W
wanganxp 已提交
1435
## UTS原生混编@utshybrid
W
wanganxp 已提交
1436

W
wanganxp 已提交
1437
`HBuilder X 4.25`起,UTS插件可以直接使用原生的kt、java、swift代码,即 `UTS原生混编`
杜庆泉's avatar
杜庆泉 已提交
1438

W
wanganxp 已提交
1439
该部分内容较多,另见文档[UTS原生混编](./uts-plugin-hybrid.md)
杜庆泉's avatar
杜庆泉 已提交
1440

D
DCloud_LXH 已提交
1441 1442
## 前端使用插件

W
wanganxp 已提交
1443
虽然uts插件由uts语法开发,但前端引用插件并不要求一定需要uts,普通js亦可引用uts插件。这也是uts插件同时支持uni-app和uni-app x的重要原因。
D
DCloud_LXH 已提交
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490

下面介绍两种常见的引入方式

 **泛型引用**

> 在uni-app x上需3.91+

作为一个对象全部import进来,然后通过点运算符调用这个对象的方法或属性。

```js
// 先引用,全部导入,对象起名为UTSHello
import * as UTSHello from "../../../uni_modules/uts-osapi";

// 然后使用UTSHello的方法
UTSHello.getBatteryCapacity()
```

**特别注意**

需要特别注意的是,import UTS插件时,只能到插件的根目录,不能直接引入到最终的文件

```ts
// 正确的写法
import * as UTSHello from "../../../uni_modules/uts-osapi";
```

```ts
// 错误的写法
import * as UTSHello from "../../../uni_modules/uts-osapi/index.uts";
```


**显性引用**

从可导出的选项里import 1个或多个(逗号分隔),然后直接使用导出的方法或属性。

```js
//先引用,导入指定方法或属性
import {
  getBatteryCapacity
} from "../../../uni_modules/uts-osapi";

// 然后使用导入的方法
getBatteryCapacity()
```


W
wanganxp 已提交
1491
关于电量这个插件,插件市场已提供现成的插件,除了Android、iOS、鸿蒙,还同时支持了web和小程序,可以去下载体验。[详见](https://ext.dcloud.net.cn/plugin?id=9295)
D
DCloud_LXH 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511

更多开发示例,可以参考 [HelloUTS](https://gitcode.net/dcloud/hello-uts)

## 真机运行

### UTS支持真机运行

**uts虽然是原生代码,但同样具有真机运行功能**

若HBuilderX中没有`uts编译运行插件`,在第一次运行时会自动下载。

#### Android平台

- Android上,运行体验与uni-app基本无差异。一样可以热刷新,打印console.log。

#### iOS平台

- HBuilderX 3.6.9以下版本,uts插件不支持热刷新,真机需提交云端打包生成[自定义基座](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground)
- HBuilderX 3.6.9+,uts插件,支持本地编译和真机运行 [详情](https://uniapp.dcloud.net.cn/tutorial/run/uts-development-ios.html)

1512 1513 1514 1515 1516
#### harmonyOS平台

- uni-app-x项目暂不支持运行到harmonyOS平台
- 目前运行到真机或者模拟的需要在鸿蒙DevEco-studio内手动操作

D
DCloud_LXH 已提交
1517 1518 1519 1520
### 自定义基座

自定义基座支持uts插件。

D
DCloud_LXH 已提交
1521
#### Android平台
D
DCloud_LXH 已提交
1522 1523 1524 1525 1526 1527 1528
普通uts代码可以直接使用标准基座真机运行。但与原生插件一样,涉及以下场景,需要自定义基座后方能生效:

- 1 集成三方sdk
- 2 新增资源(包括res/asset 等)

总结来说,就是所有 涉及新增依赖/gralde配置/androidManifest.xml/资源 等标准基座不具备的能力时,需要自定义基座

D
DCloud_LXH 已提交
1529
#### iOS平台
D
DCloud_LXH 已提交
1530 1531 1532 1533
uts插件编译需要XCode环境,因此在mac电脑安装了XCode工具时支持直接使用标准基座真机运行。

在windows电脑或者mac电脑没有安装XCode工具时,需要提交云端打包生成自定义基座后才能调用uts插件。

1534 1535
### Debug断点调试
uts插件支持debug断点调试。可以在uts插件代码中打断点、查看上下文,与前端代码联调。
D
DCloud_LXH 已提交
1536

W
wanganxp 已提交
1537 1538
- [Android debug教程](https://uniapp.dcloud.net.cn/tutorial/debug/uni-uts-debug.html)
- [iOS debug教程](https://uniapp.dcloud.net.cn/tutorial/debug/uni-uts-debug-ios.html)
1539
- [ArkTs debug教程](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-debug-arkts-breakpoint-0000001807387305-V5)
D
DCloud_LXH 已提交
1540

W
wanganxp 已提交
1541
#### Bug&Tips
D
DCloud_LXH 已提交
1542 1543 1544
- Android平台不支持跨进程调试/日志打印,即 console.log 目前只能在当前进程生效,开发多进程应用时,暂时无法打印日志到控制台


1545
## 打包
D
DCloud_LXH 已提交
1546

D
DCloud_LXH 已提交
1547
正常支持云端打包。但打包后uts编译为了纯原生二进制代码,不支持wgt热更新。
D
DCloud_LXH 已提交
1548

1549
本地打包:[另见文档](../native/README.md)
D
DCloud_LXH 已提交
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562

## 常见问题

### 常见报错

- [plugin:vite:resolve] Failed toresolve entry for package "插件路径"

	HBuilderX 的最低要求为3.6.0,低于此版本无法import uts插件,编译时将报错。

- 文件查找失败:'uts插件路径'

    vue2项目使用 uts 插件的最低版本要求是HBuilderX 3.6.8,低于此版本,编译时将报错。

D
DCloud_LXH 已提交
1563
- UTSCallback
D
DCloud_LXH 已提交
1564 1565 1566 1567

	HBuilderX 3.7.7开始,不推荐使用 UTSCallback 定义函数类型,当需要定义函数类型时,应定义为更具体的类型,如:`const callback:UTSCallback` 应调整为`const callback:()=>void`
	如果您使用的是插件市场三方uts插件,可以检查更新插件最新版本

lizhongyi_'s avatar
lizhongyi_ 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576
- iOS 平台异步 Api 的回调函数不支持返回值
	
```uts
// iOS 平台不支持带返回值的回调
export type TestCallback = {
	success : (res : any) => any
	fail : (err : any) => any
}

杜庆泉's avatar
杜庆泉 已提交
1577 1578 1579
export class Test {
	static getAll(callbacks : TestCallback) : void {
		try {
lizhongyi_'s avatar
lizhongyi_ 已提交
1580
		 let res = callbacks.success("1");
杜庆泉's avatar
杜庆泉 已提交
1581 1582
		 console.log(res);
		} catch (e) {
lizhongyi_'s avatar
lizhongyi_ 已提交
1583
		  let res =	callbacks.fail("2");
杜庆泉's avatar
杜庆泉 已提交
1584 1585 1586
		  console.log(res);
		}
	}
lizhongyi_'s avatar
lizhongyi_ 已提交
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
}
```

需要将上面的写法改成:

```uts
export type TestCallback = {
	success : (res : any) => void
	fail : (err : any) => void
}

杜庆泉's avatar
杜庆泉 已提交
1598 1599 1600 1601 1602 1603 1604 1605
export class Test {
	static getAll(callbacks : TestCallback) : void {
		try {
		 callbacks.success("1");
		} catch (e) {
		  callbacks.fail("2");
		}
	}
lizhongyi_'s avatar
lizhongyi_ 已提交
1606 1607 1608 1609
}
```


D
DCloud_LXH 已提交
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
### Float类型传参

android很多布局参数强制要求Float,但是ts中没有内置这种类型。可以使用下面的代码实现转换

```ts
let textSize =  30.0.toFloat();
```
### Long类型传参


```ts
let longVal =  1000.0.toLong()
```

### 异步任务

目前 UTS 仅Android支持promise执行异步任务,iOS还不支持。类似场景可以使用setTimeOut。


### 匿名内部类
```js
taohebin@dcloud.io's avatar
taohebin@dcloud.io 已提交
1631 1632 1633 1634 1635 1636
const runnable = new (class implements Runnable {
	override run() {
		
	}
})
getUniActivity()!.runOnUiThread(runnable)
D
DCloud_LXH 已提交
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
```

### 泛型参数

android中UI相关的api,很多会要求泛型,目前uts中可以使用下面的代码实现

```ts
let frameContent = decorView.findViewById<FrameLayout>(android.R.id.content)
let layoutParam = new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,ViewGroup.LayoutParams.WRAP_CONTENT);
```
lizhongyi_'s avatar
lizhongyi_ 已提交
1647 1648
> 特别注意:
> iOS 环境目前不支持在 uts 插件中导出带泛型的类型。
D
DCloud_LXH 已提交
1649 1650 1651 1652 1653 1654

### 函数参数默认值

函数参数支持设置默认值,比如下面testName

```ts
D
DCloud_LXH 已提交
1655
function connectWifi(option: WifiConnectOption,testName :string = "zhangsan")
D
DCloud_LXH 已提交
1656 1657
```

杜庆泉's avatar
杜庆泉 已提交
1658
### 在uni-app 上的导出限制
D
DCloud_LXH 已提交
1659 1660 1661

UTS插件环境会被编译为原生语言环境,在android平台是kotlin.

DCloud-yyl's avatar
DCloud-yyl 已提交
1662
uni-app x 运行到Android平台时,本身也是原生语言环境,即kotlin。同语言直接的调用是没有限制的,可以任意导出和使用 自定义对象/原生对象/类/方法。
D
DCloud_LXH 已提交
1663

lizhongyi_'s avatar
lizhongyi_ 已提交
1664
但是在uni-app 环境和 uni-app x 的iOS 环境,**只能导出UTS中声明的自定义对象/类/方法,不能包含原生对象、平台专有类型**
D
DCloud_LXH 已提交
1665

lizhongyi_'s avatar
lizhongyi_ 已提交
1666
这是因为 uni-app 和 uni-app x 的iOS 本质上是类浏览器的js环境中,UTS中声明的对象是经过特殊处理的,每一个对象都有一个在Js中对应的实例,这样才能正常使用。
D
DCloud_LXH 已提交
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684

其他的原生对象没有经过特殊处理,并不能在js环境中使用。


### 访问JSON对象属性

`uts`环境中访问`JSON`对象的属性,不能用`user.age` 而要用下标 `user['age']`

```ts

let jsonContent = "{'username':'zhangsan','age':12}"
let jsonObj = JSON.parse(jsonContent);
console.log("jsonObj['age']  == " + jsonObj['age'] );

```

如果想使用`.操作符`,需要参考uts的[type](../uts/data-type.md#type)

D
DCloud_LXH 已提交
1685
更多UTSJSONObject的用法,[详见](../uts/data-type.md#utsjsonobject)
D
DCloud_LXH 已提交
1686

杜庆泉's avatar
杜庆泉 已提交
1687 1688 1689 1690 1691 1692 1693 1694 1695


### UTSCallback 和 UTSJSONObject 是什么?

UTSCallback 和 UTSJSONObject 是UTS内置专门用于UTS环境和前端交互的特定类型。

为了同时兼容 uni-app 和 uni-app x 环境,在uni环境与UTS环境交互时 : 除了基本数据类型之外,涉及function的需要使用UTSCallback替代,涉及复杂对象object需要用UTSJSONObject 替代


杜庆泉's avatar
杜庆泉 已提交
1696 1697 1698 1699 1700 1701 1702 1703
### 如何生成android平台Array对象?

UTS环境中,默认的数组写法[] / Array()  对应到 android平台的数据结构是 `UTSArray`

理论上来说 `UTSArray`确实更加灵活强大,但是部分android 平台api 明确要求了 Array格式的数据(比如请求权限)

类似场景下,我们就要使用 toTypedArray() 函数进行转换,以便将`MutableList` 转换为对应的`Array`

杜庆泉's avatar
杜庆泉 已提交
1704
```ts
杜庆泉's avatar
杜庆泉 已提交
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722

// 得到一个UTSArray
let permissionArray :String[] = []
// 得到一个Array
console.log(permissionArray.toArray())
// 得到一个MutableList
console.log(permissionArray.toMutableList())
```

另外还存在一种特殊情况,即开发者 在UTS中使用了 `kotlin`编写的依赖,这个时候情况稍微复杂些

`UTS`中只有一种 数组结构相比,`kotlin`中的数组结构要多很多,比如 `IntArray`,`Array`,`MutableList`等,

对于情况,开发者需要注意两点:


1  UTS具备类型推导功能,调用第三方依赖是不需要声明类型

杜庆泉's avatar
杜庆泉 已提交
1723
```ts
杜庆泉's avatar
杜庆泉 已提交
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
// 建议的写法
let a = xxx.getInfo()

// 这样是没必要的,如果一定要这样写,必须要明确了解到kotlin依赖返回的数据结构,否能可能会因为类型错误,导致编译报错
let a:IntArray = xxx.getInfo()


```

2  各种数组类型的转换说明

杜庆泉's avatar
杜庆泉 已提交
1735
```ts
杜庆泉's avatar
杜庆泉 已提交
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
// IntArray 转 MutableList
val a = intArrayOf(1,2,3)
val b = a.toMutableList()


// MutableList 转 Array<Int>
val c = b.toTypedArray()

// Array<Int> 转 IntArray
val d = c.toIntArray()

```

杜庆泉's avatar
杜庆泉 已提交
1749

杜庆泉's avatar
杜庆泉 已提交
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
### 如果我要实现一个官方已有的三方SDK功能,比如微信支付,如何处理?

因为android中,每个UTS插件都对应一个gradle 子项目,所以类似的情况不能简单复用 自定义基座中的官方依赖。

需要:  **不要勾选官方的依赖,然后在uts插件中,按照文档配置依赖**



### uni-app 中如何向UTS环境中传递数组参数

在 uni-app 平台,js环境与原生环境的交互都是经过js引擎桥接

js引擎除了 string,number,boolean 等基本数据结构外,仅支持JSONObject,JSONArray两种。

+ JSONObject 比较常见,基本所有的接口参数都会 对应一个uts中定义的 type 类
+ JSONArray 一般在uts中采用Array数组来承接

下面是一个Array的使用示例:

杜庆泉's avatar
杜庆泉 已提交
1769
```ts
杜庆泉's avatar
杜庆泉 已提交
1770 1771 1772 1773 1774 1775 1776 1777 1778
// UTS插件,声明数组参数
export function callWithoutParam(filterArray : Array<string>,success: () => void) {
	console.log(filterArray)
	success();
	return { name: "doSthWithCallback" };
}

```

杜庆泉's avatar
杜庆泉 已提交
1779
```ts
杜庆泉's avatar
杜庆泉 已提交
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
// 前端传递数组参数
UTSHello.callWithoutParam(
	["system","optionB"]
	,
	()=>{
		uni.showToast({
			title:'成功调用',
			icon:'none'
		});
	}
);
```



### android中 synchronized / Lock 等线程同步概念,在UTS里怎么写?

前端领域里线程安全的解决思路 与java的不同。 他们提供了 async/await 等关键字来实现异步任务处理

+ 如果业务代码中有需要多线程、异步任务,建议切换到 async/await 等 uts 语法

+ 如果是要翻译原有的java代码到 UTS,可以选择打成AAR来处理。


杜庆泉's avatar
杜庆泉 已提交
1804 1805 1806 1807
### UTS 如何进行遍历操作


遍历数组:
杜庆泉's avatar
杜庆泉 已提交
1808
```ts
杜庆泉's avatar
杜庆泉 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
let arrayObj = utsArrayOf("111","222","333")
arrayObj.forEach(function(e:any){
	console.log(e)
})
let arrayObj2 = [10,20,30]
arrayObj2.forEach(function(e:any){
	console.log(e)
})
```

遍历Map:

杜庆泉's avatar
杜庆泉 已提交
1821
```ts
杜庆泉's avatar
杜庆泉 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
let mapObj = new Map<string,any>()
mapObj.put("name","zhangsan")
mapObj.put("age",12)
mapObj.forEach(function(value:any,key:string){
	console.log(key)
	console.log(value)
})
```

遍历UTSJSONObject:

杜庆泉's avatar
杜庆泉 已提交
1833
```ts
杜庆泉's avatar
杜庆泉 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
let utsJsonObj = {
	name:"zhangsan",
	age:"22",
}
utsJsonObj['classInfo'] = "三年二班"
utsJsonObj.forEach(function(perField:any){
	console.log(perField)
})
```


lizhongyi_'s avatar
lizhongyi_ 已提交
1845 1846
### HX 4.25 版本及以后 UTS 插件如何定义一个可以持续回调的函数@keepalive

lizhongyi_'s avatar
lizhongyi_ 已提交
1847 1848
HBuilderX 4.25版本以前向 js 暴露的 callback 是一直保存在内存中的,所有带 callback 回调的函数 都可以持续回调。但这也带来了一个致命的问题, 当频繁长时间调用带 callback 回调的函数时,由于 callback 一直保存在内存中,会创建大量 callback 对象,造成内存暴增甚至闪退。
为了处理这个问题,从 HBuilderX 4.25 版本开始我们做了调整,只有以 on 开头,且仅有一个 callback 类型的参数的函数才能持续回调,其他函数一律只能回调一次。这种做法处理了内存问题,但带来了向下兼容的问题,需要插件作者修改函数名(影响范围: HX 4.25 和 4.26 版本 iOS 端 uni-app 和 uni-app x, 安卓端 uni-app,单个函数或者自定义 class 中的静态或者实例函数)
lizhongyi_'s avatar
lizhongyi_ 已提交
1849

lizhongyi_'s avatar
lizhongyi_ 已提交
1850
为了更彻底的解决这个问题,从 HBuilderX 4.27 版本开始,我们新增了通过装饰器(注解)的方式定义回调函数是否一直存活,同时符合 `以 on 开头,且仅有一个 callback 类型的参数的函数` 这个规则的函数依然可以持续回调。
lizhongyi_'s avatar
lizhongyi_ 已提交
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860

下面的方式均可以使回调函数一直存活。

```ts

export type Options = {
	a: string
	success: (res: string) => void
}

lizhongyi_'s avatar
lizhongyi_ 已提交
1861
// 以 on 开头,且仅有一个 callback 类型的参数的函数
lizhongyi_'s avatar
lizhongyi_ 已提交
1862 1863 1864 1865 1866
export function onTest(callback : (msg : string) => void) {
    callback("a")
    callback("b")
}

lizhongyi_'s avatar
lizhongyi_ 已提交
1867
// 使用 @UTSJS.keepAlive 注解方式,不限制参数个数
lizhongyi_'s avatar
lizhongyi_ 已提交
1868 1869 1870 1871 1872 1873
@UTSJS.keepAlive
export function test(callback : (msg : string) => void) {
    callback("a")
    callback("b")
}

lizhongyi_'s avatar
lizhongyi_ 已提交
1874
// 使用 @UTSJS.keepAlive 注解方式,callback 可以包含在自定义type中
lizhongyi_'s avatar
lizhongyi_ 已提交
1875 1876 1877 1878 1879 1880
@UTSJS.keepAlive
export function testOption(option : Options) {
    option.success("a")
    option.success("b")
}

lizhongyi_'s avatar
lizhongyi_ 已提交
1881
// 以上规则在自定义class中同样适用
lizhongyi_'s avatar
lizhongyi_ 已提交
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
export class Test {
	onTest(callback : (msg : string) => void) {
	    callback("a")
	    callback("b")
	}
	
	@UTSJS.keepAlive
	testOption(option : Options) {
	    option.success("a")
	    option.success("b")
	}
	
	
    @UTSJS.keepAlive
    test(callback : (msg : string) => void) {
        callback("a")
        callback("b")
    }
	
	@UTSJS.keepAlive
	static testStatic(callback : (msg : string) => void) {
        callback("a")
        callback("b")
    }
	
	@UTSJS.keepAlive
	static testOptionStatic(option : Options) {
	    option.success("a")
	    option.success("b")
	}
}
```
杜庆泉's avatar
杜庆泉 已提交
1914

lizhongyi_'s avatar
lizhongyi_ 已提交
1915 1916 1917 1918 1919
> 特别注意:

> 1. 如果带了该装饰器,则该方法参数里的所有回调都会在内存中持续存在

> 2. 目前装饰器不支持 export const test:Test = ()=>{} // 这种导出方式,需要使用export function test(){}
杜庆泉's avatar
杜庆泉 已提交
1920

fxy060608's avatar
fxy060608 已提交
1921 1922
## Bug & Tips@tips

杜庆泉's avatar
杜庆泉 已提交
1923
### uniapp项目安卓环境 不支持函数重载
DCloud-yyl's avatar
DCloud-yyl 已提交
1924

杜庆泉's avatar
杜庆泉 已提交
1925
如果同时存在两个同名函数,仅参数个数/类型不同,在Uni-app 项目 android环境中会无法正确区分两个函数
DCloud-yyl's avatar
DCloud-yyl 已提交
1926

杜庆泉's avatar
杜庆泉 已提交
1927
临时解决办法:以不同的函数名称来区分函数
fxy060608's avatar
fxy060608 已提交
1928

fxy060608's avatar
fxy060608 已提交
1929

D
DCloud_LXH 已提交
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
## 示例项目

DCloud提供了 Hello UTS示例,[详见](https://gitcode.net/dcloud/hello-uts)

插件市场提供了很多uts项目:
- API示例,调用os api,电量插件,[详见](https://ext.dcloud.net.cn/plugin?id=9295)
- API示例,调用三方sdk,腾讯定位插件,[详见](https://ext.dcloud.net.cn/plugin?id=14569)
- 组件示例,调用三方sdk,lottie插件,[详见](https://ext.dcloud.net.cn/plugin?id=10674)

更多uts插件见:[https://ext.dcloud.net.cn/?cat1=8&type=UpdatedDate](https://ext.dcloud.net.cn/?cat1=8&type=UpdatedDate)