uts-plugin.md 40.1 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 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 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 76 77 78 79 80 81 82 83 84 85 86

UTS插件开发官方QQ交流群:527828934 [点此加入](https://qm.qq.com/cgi-bin/qm/qr?k=3Z-cQCXGiTyThkrqufUNNw7TaJd2xEPb&jump_from=webapi&authKey=4UQdplol3kPLwlDfuSdYleE8JUHnJChC2+8HcuBavZq2q51iAkLdzT4Bupt4ZJZu)

### 什么是uts语言

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

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

- web平台,编译为JavaScript
- Android平台,编译为Kotlin
- iOS平台,编译为Swift(HX 3.6.7+ 版本支持)

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编译器)
- 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插件结构](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)

### 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插件的优势:

1. 统一了编程语言(uts),一种语言开发所有平台,真正大前端。
2. 统一了开发工具(HBuilderX),免除搭建复杂的原生开发环境。
3. 插件封装中要理解的概念更少。 传统原生语言插件需要在js和原生层处理通信,使用各种特殊转换,使用特殊语法导入,注意事项很多。**uts统一为纯前端概念,简单清晰。**
4. uts 下前端和原生可以统一在 HBuilderX 中联调。而传统原生语言插件需要在多个开发工具间切换,联调复杂。
5. 插件市场的uts插件支持下载后自己固定版本。而付费的原生语言插件只能使用最新版。
6. 插件市场的uts付费插件支持源码版销售和源码版权保护机制。而付费的原生语言插件不支持源码版销售。
7. uts插件可同时支持uni-app和uni-app x。

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

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

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


## 创建uts插件

### uts 插件目录结构

在 uni-app 的项目工程下,提供了独立的目录 `utssdk`,来存放 uts 插件。

D
DCloud_LXH 已提交
97
当然官方更推荐使用 [uni_modules](https://uniapp.dcloud.net.cn/plugin/uni_modules.html) 方式,这是更好的包管理方案。
D
DCloud_LXH 已提交
98 99 100 101 102 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

首先确保项目根目录存在 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 已提交
132

D
DCloud_LXH 已提交
133 134 135 136
  }
}
```

D
DCloud_LXH 已提交
137
上面是一个默认的清单文件示例,关于 package.json 更多描述[详见](https://uniapp.dcloud.net.cn/plugin/uni_modules.html#package-json)
D
DCloud_LXH 已提交
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

### 插件的目录结构

<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原生配置文件
│	│	└─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原生配置文件
│	│	└─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),可选
│	├─index.d.ts                  // 插件能力声明,可选,将废弃,推荐使用interface.uts
│	├─interface.uts               // 声明插件对外暴露的API
│	└─index.uts                   // 跨平台插件能力实现,可选
└─package.json                    // 插件清单文件
</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 插件,这样写比较简单

index.d.ts 文件是对当前插件能力的**声明**,用于语法提示。已不推荐使用,请使用interface.uts。

因为 uts 写好后,HBuilderX 可以自动识别 uts api 并进行语法提示。它更多的用于后续 uts 插件加密时给予语法提示。

如果不熟悉 d.ts,可以自行网上搜索,它属于 ts 标准技术。

### App原生配置

#### 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 已提交
214
##### assets
D
DCloud_LXH 已提交
215 216 217 218 219
Android平台原生assets资源目录,建议只保存UTS插件内置的资源文件。

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

D
DCloud_LXH 已提交
220
##### libs
D
DCloud_LXH 已提交
221
Android平台原生三方库目录,支持以下类型文件:
D
DCloud_LXH 已提交
222
- jar
D
DCloud_LXH 已提交
223 224 225 226 227
- aar
- so库

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

D
DCloud_LXH 已提交
228
仓储配置参考config.json的[dependencies](#dependencies)
D
DCloud_LXH 已提交
229 230 231 232 233 234

如果使用的三方sdk包含了so库,保存到此目录时,需按Android的abi类型分目录保存。

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


D
DCloud_LXH 已提交
235
##### res
D
DCloud_LXH 已提交
236 237 238 239 240
Android平台原生res资源目录,建议只保存UTS插件内置的资源文件。

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


D
DCloud_LXH 已提交
241
##### AndroidManifest.xml
D
DCloud_LXH 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
Android原生应用清单文件,建议只保存UTS插件内置的清单文件配置。

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

##### config.json
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 已提交
276 277
- abis
当插件使用了NDK开发的so库时配置,描述插件支持CPU类型。
D
DCloud_LXH 已提交
278 279 280 281
可取值:armeabi-v7a、arm64-v8a、x86、x86_64

<a id="dependencies"/>

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

D
DCloud_LXH 已提交
298
- minSdkVersion
D
DCloud_LXH 已提交
299 300 301 302
插件支持的Android最低版本,整数类型,取值范围为Android API Level

默认uni-app最低支持版本为19,即Android4.4.2

D
DCloud_LXH 已提交
303 304
- project
	云端打包项目相关配置,当使用的三方SDK需要配置gradle插件时可配置此项:
杜庆泉's avatar
杜庆泉 已提交
305
	
D
DCloud_LXH 已提交
306 307
	+ plugins
		此配置将会添加到云端打包工程app及build.gradle文件的“plugins”中:
杜庆泉's avatar
杜庆泉 已提交
308 309 310 311 312 313 314 315 316

		```
		plugins {
			id 'com.android.application'
			// 前面config.json示例配置将会添加如下配置
			id 'com.huawei.agconnect'
		}
		```

D
DCloud_LXH 已提交
317
	+ dependencies
杜庆泉's avatar
杜庆泉 已提交
318 319 320 321 322 323 324 325 326 327 328
		此配置将会添加到云端打包工程项目级build.gradle文件的“buildscript > dependencies”中:

		```
		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 已提交
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354


**注意:**

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

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

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

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

#### iOS 平台原生配置

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

|目录名/文件名		|用途													|
|:---				|:---													|
|Frameworks			|iOS平台插件需要引用的三方 framework 依赖库存放目录			|
|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 已提交
355
##### Frameworks
D
DCloud_LXH 已提交
356 357
iOS平台插件依赖的三方framework存放目录,支持以下类型文件:

D
DCloud_LXH 已提交
358
- framework
D
DCloud_LXH 已提交
359 360 361 362
- xcframework

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

D
DCloud_LXH 已提交
363
##### Libs@ios-libs
D
DCloud_LXH 已提交
364 365 366 367
> HBuilder X 3.7.2+ 版本支持

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

D
DCloud_LXH 已提交
368
- 使用OC语言创建的.a库
D
DCloud_LXH 已提交
369 370 371 372 373
- 使用Swift语言创建的.a库

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

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

D
DCloud_LXH 已提交
376
除了插件下有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 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389 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

##### 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>
```

##### config.json
D
DCloud_LXH 已提交
419
uts插件在iOS平台的其它原生配置文件,可以在其中配置依赖的系统库等信息
D
DCloud_LXH 已提交
420 421 422 423

```json
{
	"frameworks": [
D
DCloud_LXH 已提交
424
		"可选,依赖的系统库(系统库有.framework和.tbd和.dylib类型)"
D
DCloud_LXH 已提交
425 426 427
	],
	"deploymentTarget": "9.0",   // 可选,插件支持的最低 iOS 版本  默认:9.0"
	"validArchitectures": [    // 可选,支持的 CPU 架构类型 默认:arm64
D
DCloud_LXH 已提交
428 429
		"arm64"
	],
D
DCloud_LXH 已提交
430 431
	"dependencies-pods": [ // 可选, 需要依赖的pod库, HBuilderX 3.8.5+ 版本支持
	{
D
DCloud_LXH 已提交
432 433
		"name": "WechatOpenSDK",
		"version": "2.0.2"
D
DCloud_LXH 已提交
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
	}]
}
```

**配置说明:**
- 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)


## 开发uts插件

### 获取电量插件示例

以获取电量为例,介绍`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
杜庆泉 已提交
568
注2:`io.dcloud.uts.android`库介绍[文档](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-for-android.html#iodcloudutsandroid)
D
DCloud_LXH 已提交
569 570 571

特别提示:

杜庆泉's avatar
杜庆泉 已提交
572
**有android开发经验的开发者可以参考:[Android平台uts开发指南](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-for-android.html)**
D
DCloud_LXH 已提交
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596


#### 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 已提交
597
 * 导出 获取电量方法
D
DCloud_LXH 已提交
598 599
 */
export default function getBatteryInfo(options: GetBatteryInfoOptions) {
D
DCloud_LXH 已提交
600

D
DCloud_LXH 已提交
601 602
	// 开启电量检测
	UIDevice.current.isBatteryMonitoringEnabled = true
D
DCloud_LXH 已提交
603

D
DCloud_LXH 已提交
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
	// 返回数据
    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 已提交
624
 * 导出 获取电量方法
D
DCloud_LXH 已提交
625 626 627 628
 */
export default function getBatteryLevel():number {
	// 开启电量检测
	UIDevice.current.isBatteryMonitoringEnabled = true
D
DCloud_LXH 已提交
629

D
DCloud_LXH 已提交
630 631 632 633 634 635 636 637 638
	let level = Number(UIDevice.current.batteryLevel * 100)
	return level
}
```

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


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


D
DCloud_LXH 已提交
641 642 643 644 645 646 647 648
> 特别注意:
> 此功能在 HBuilderX 3.97+ 版本支持,HBuilderX 3.97 之前的版本不支持。

#### iOS 平台

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

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

D
DCloud_LXH 已提交
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

> 注意:
> 该自定义 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 已提交
676

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

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

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

D
DCloud_LXH 已提交
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
	}
	// 通过 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 已提交
705
	}
D
DCloud_LXH 已提交
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
	// 应用程序进入后台时的回调函数。
	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 已提交
722

D
DCloud_LXH 已提交
723 724 725 726
	    return true
	}
}
```
D
DCloud_LXH 已提交
727

D
DCloud_LXH 已提交
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 793 794 795 796 797

#### Android 平台

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

UTSAndroidHookProxy代码如下:

```uts
/**
 * 安卓原应用初始化回调代理
 * 注意:不支持调用uni api
 */
interface UTSAndroidHookProxy {
    /**
     * 安卓原生应用初始化
     * @param application
     */
    fun onCreate(application: Application)
}
```

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

```uts
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实现代码需要重新提交云端打包才能生效




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


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 已提交
798
2. UTSJSONObjct
D
DCloud_LXH 已提交
799 800 801 802

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

D
DCloud_LXH 已提交
804 805 806 807 808 809 810 811 812 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
	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 已提交
859
需要注意的是,在声明为`any`类型的前提下, `uni-app` 环境中的 `Object` 在UTS环境中也会被转换为 `UTSJSONObjct`.
D
DCloud_LXH 已提交
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884

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

```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 已提交
885
更多UTSJSONObject的用法,[详见](../uts/data-type.md#utsjsonobject)
D
DCloud_LXH 已提交
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 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

遗留问题:

有些场景,我们需要参数对象包含对象数组,比如
```json
{
	"name": "zhangsan",
	"teacher": [{
			"id": "1",
			"name": "kongzi"
		},
		{
			"id": "2",
			"name": "mengzi"
		}
	]
}
```
目前在uni-app 1.0 环境下,复杂参数的传递是存在一定的缺陷。我们不能将teacher 声明为具体的类型数组,需要声明为any数组:


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

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


## 前端使用插件

虽然uts插件由uts语法开发,但前端引用插件并不要求一定需要ts,普通js即可引用uts插件。

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

 **泛型引用**

> 在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()
```


关于电量这个插件,插件市场已提供现成的插件,除了Android,还同时支持了web和小程序,可以去下载体验。[详见](https://ext.dcloud.net.cn/plugin?id=9295)

更多开发示例,可以参考 [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)

### 自定义基座

自定义基座支持uts插件。

D
DCloud_LXH 已提交
1000
#### Android平台
D
DCloud_LXH 已提交
1001 1002 1003 1004 1005 1006 1007
普通uts代码可以直接使用标准基座真机运行。但与原生插件一样,涉及以下场景,需要自定义基座后方能生效:

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

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

D
DCloud_LXH 已提交
1008
#### iOS平台
D
DCloud_LXH 已提交
1009 1010 1011 1012 1013 1014 1015
uts插件编译需要XCode环境,因此在mac电脑安装了XCode工具时支持直接使用标准基座真机运行。

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

### debug断点调试
uts插件支持debug断点调试。

W
wanganxp 已提交
1016 1017
- [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)
D
DCloud_LXH 已提交
1018

W
wanganxp 已提交
1019 1020
#### Bug&Tips
- 目前仅支持uni-app js项目使用uts插件时的调试;uni-app x预计在HBuilderX4.0起支持debug uts插件。
D
DCloud_LXH 已提交
1021 1022 1023 1024 1025
- Android平台不支持跨进程调试/日志打印,即 console.log 目前只能在当前进程生效,开发多进程应用时,暂时无法打印日志到控制台


## 云端打包

D
DCloud_LXH 已提交
1026
正常支持云端打包。但打包后uts编译为了纯原生二进制代码,不支持wgt热更新。
D
DCloud_LXH 已提交
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040


## 常见问题

### 常见报错

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

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

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

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

D
DCloud_LXH 已提交
1041
- UTSCallback
D
DCloud_LXH 已提交
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100

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

### Float类型传参

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

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


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

### 异步任务

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


### 匿名内部类

UTS目前还不支持匿名内部类的写法,在android中类似这样的场景

```kotlin
getUniActivity()!!.runOnUiThread(Runnable(){
    // do something
});
```

需要声明一个实现类,再新建实例的方式实现,代码如下

```js
class AddUIRunnable extends Runnable {
    override run():void {
		// do something
    }
};
let uiRunable = new AddUIRunnable();
getUniActivity()!.runOnUiThread(uiRunable)
```

### 泛型参数

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);
```

### 函数参数默认值

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

```ts
D
DCloud_LXH 已提交
1101
function connectWifi(option: WifiConnectOption,testName :string = "zhangsan")
D
DCloud_LXH 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
```

### 在uni-app 1.0 上的导出限制

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

uni-app x 运行时,本身也是原生语言环境,即kotlin。同语言直接的调用是没有限制的,可以任意导出和使用 自定义对象/原生对象/类/方法。

但是在uni-app 1.0 环境,**只能导出UTS中声明的自定义对象/类/方法,不能包含原生对象**

这是因为 uni-app 1.0 本质上是类浏览器的js环境中,UTS中声明的对象是经过特殊处理的,每一个对象都有一个在Js中对应的实例,这样才能正常使用。

其他的原生对象没有经过特殊处理,并不能在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 已提交
1131
更多UTSJSONObject的用法,[详见](../uts/data-type.md#utsjsonobject)
D
DCloud_LXH 已提交
1132

fxy060608's avatar
fxy060608 已提交
1133 1134
## Bug & Tips@tips

fxy060608's avatar
fxy060608 已提交
1135

fxy060608's avatar
fxy060608 已提交
1136

D
DCloud_LXH 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
## 示例项目

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)