uts-for-android.md 31.7 KB
Newer Older
D
DCloud_LXH 已提交
1 2
## uts for Android

杜庆泉's avatar
杜庆泉 已提交
3
本文旨在帮助Android开发者快速上手UTS。
D
DCloud_LXH 已提交
4 5 6 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

需要阅读者具备Android原生应用开发经验。


## 1 了解UTS插件是什么

`UTS插件``uni-app`新型插件形式,拥有跨平台,高效率,易调试等优点。[详情](/plugin/uts-plugin)

对于Android开发者来说,我们需要了解的是:

1. 编译时:当我们在保存`UTS`源码文件时,IDE会同步将其编译为对应的Kotlin代码。
2. 运行时:在真机运行/云打包时,这些编译后的kotlin源码也会成为apk的一部分

## 2 掌握UTS语法

### 2.1  对于掌握kotlin语言者

因为UTS语法与kotlin很类似,建议快速阅读后,在实践中掌握这UTS语法。[uts语法介绍](/uts/)

### 2.2  对于仅掌握java语言者

与js相比,uts的语法和java更加类似。但是依然存在较大的差异,需要详细阅读2.3语法部分。

尽管开发UTS插件,并不要求一定掌握kotlin,但是鉴于`UTS`目前在android平台上,会编译为kotlin源码。学会kotlin语言,方便排查问题和复杂功能实现。

因此建议学习一下kotlin语法。

+ kotlin [https://kotlinlang.org/](https://kotlinlang.org/)

+ kotlin for android [https://developer.android.com/kotlin](https://developer.android.com/kotlin)

### 2.3 数据类型差异

虽然 UTS 和 koltin 在数据类型上基本保持了一致,但是在部分场景下,还是会有差异,在此特别说明

D
DCloud_LXH 已提交
39
原则上:
D
DCloud_LXH 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53

**数据类型以UTS 内置的类型为准, 各原生平台都会对其自动适配。**

**但是 UTS本身是跨平台语言,当具体平台的api 有明确要求时,需要以对方明确要求的数据类型为准。**

-------------------------


#### 举例一: Int 和Number

默认情况下`UTS` 开发者可以使用 `Number` 覆盖`android` 平台上使用 `Int`的场景。

但是当开发者重写  `Service` 组件`onStartCommand` 方法时,`Android` API要求 明确要求后两个参数 必须为Int

D
DCloud_LXH 已提交
54

D
DCloud_LXH 已提交
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
原生开发环境中,应该这样写:

 ```kotlin
 override fun onStartCommand(intent: Intent, flags: Int, startId: Int): Int {
	return super.onStartCommand(intent, flags, startId);
 }
 ```


 标准的TS环境中,只有`Number`类型而没有`Int`类型

 为了适应这种情况,UTS 允许开发者使用原生平台的数据类型Int,来满足原生API对数据类型的要求:

```ts
 override onStartCommand(intent:Intent ,flags:Int ,startId:Int):Int {
	return super.onStartCommand(intent, flags, startId);
 }
```




#### 举例二:`MutableList`
D
DCloud_LXH 已提交
78

D
DCloud_LXH 已提交
79 80 81 82 83 84 85 86 87
`MutableList``android`平台 特有的数据类型,一般场景下,可以使用UTS中内置类型 `Array` 替代

但是在 调用`onAppActivityRequestPermissionsResult` 函数监听权限申请结果时,明确要求使用此类型的参数

在原生环境中,应该这样写:

```kotlin

onAppActivityRequestPermissionsResult(fun(requestCode: Number, permissions: MutableList<String>, grantResults: MutableList<Number>){
D
DCloud_LXH 已提交
88

D
DCloud_LXH 已提交
89 90 91 92 93 94 95 96 97 98
});
```


标准的TS环境中,没有`MutableList`类型,与之相近的数据类型是 `Array`

为了适应这种情况,UTS 允许开发者使用原生平台的数据类型`MutableList`,来满足原生平台API对数据类型的要求:

```ts
onAppActivityRequestPermissionsResult((requestCode: number,permissions: MutableList<string>,grantResults: MutableList<number>) => {
D
DCloud_LXH 已提交
99

D
DCloud_LXH 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
});

```

#### 举例三:`String[]`

部分三方sdk 使用java开发,要求继承/实现的方法参数为 string[]类型,这种情况比较特殊,需要将kotlin.Array先进行别名声明,再继续使用

```ts
import KotlinArray from 'kotlin.Array';


class XXX{
 	override onCaptureFinish(p0: KotlinArray<string>){
		// do sth
	};
}

```


### 2.4 线程环境差异

D
DCloud_LXH 已提交
123
UTS环境中,默认是没有线程概念的。
杜庆泉's avatar
杜庆泉 已提交
124

D
DCloud_LXH 已提交
125
如果需要执行异步任务,建议通过内置函数`UTSAndroid.getDispatcher("io")`执行
杜庆泉's avatar
杜庆泉 已提交
126 127 128

[文档地址](https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html#getdispatcher)

D
DCloud_LXH 已提交
129 130 131


```ts
杜庆泉's avatar
杜庆泉 已提交
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
UTSAndroid.getDispatcher("main").async(function(_){
	if(Thread.currentThread().name != 'main'){
		callback(false,"main thread error")
		return
	}
	UTSAndroid.getDispatcher("dom").async(function(_){
		/**
		 * dom 参数,只在2.0生效,1.0会自动切换到main线程
		 */
		if(Thread.currentThread().name != 'main' && Thread.currentThread().name != 'io_dcloud_uniapp_dom'){
			callback(false,"dom thread error")
			return
		}
		UTSAndroid.getDispatcher("io").async(function(_){
			/**
			 * dom 参数,只在2.0生效,1.0会自动切换到main线程
			 */
			if(!Thread.currentThread().name.contains("DefaultDispatcher")){
				callback(false,"io thread error")
				return
			}
			callback(true,"pass")
		},null)
D
DCloud_LXH 已提交
155

杜庆泉's avatar
杜庆泉 已提交
156 157
	},null)
},null)
D
DCloud_LXH 已提交
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
```


## 3 Android原生环境配置

对于Android项目来说,除了源码之外,还会涉及依赖,资源,配置等常见问题

本章节将会介绍,UTS插件开发环境中如何配置这些属性

**注意**

+ 1 本章节内的实例代码均取自Hello UTS [项目地址](https://gitcode.net/dcloud/hello-uts)
+ 2 本章节涉及的配置,均需自定义基座后才能生效

### 3.1 配置AndroidManifest.xml

以hello UTS中的native-page插件中的配置文件为例:

杜庆泉's avatar
杜庆泉 已提交
176
文件位置: ~\uni_modules\uts-nativepage\utssdk\app-android\AndroidManifest.xml
D
DCloud_LXH 已提交
177 178 179 180 181

AndroidManifest.xml示例:

```xml
<?xml version="1.0" encoding="utf-8"?>
D
DCloud_LXH 已提交
182
<manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools"
D
DCloud_LXH 已提交
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
  // 注意:这里是插件的包名而不是应用的包名
  package="io.dcloud.uni_modules.utsNativepage">
   // 配置权限
   <!--创建前台服务权限-->
   <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />

    <application>
	   // 配置service / activity
	   <service android:name="uts.sdk.modules.utsNativepage.ForeService"  />
       <activity android:name="uts.sdk.modules.utsNativepage.DemoActivity"></activity>
    </application>
</manifest>

```


杜庆泉's avatar
杜庆泉 已提交
199
UTS插件中的 `AndroidManifest.xml``android` 中的 `AndroidManifest.xml` 规则完全一致。
D
DCloud_LXH 已提交
200 201


杜庆泉's avatar
杜庆泉 已提交
202
**特别提示**
D
DCloud_LXH 已提交
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227

每一个UTS插件对应android项目中的一个 lib module.

与你在android studio中手动输入包名不同的是,如果你没有手动包名,HX会按照下面的规则默认生成一个:

```
uts插件默认包名规则:

如果是根目录utssdk下的uts插件
	包名:uts.sdk.(插件ID转驼峰)
如果是uni_modules目录下的uts插件
	包名:uts.sdk.modules.(插件ID转驼峰)


举例:
uni-getbatteryinfo -> uts.sdk.modules.uniGetbatteryinfo;
uts-nativepage  ->  uts.sdk.modules.utsNativepage
```

### 3.2 配置res资源

![](https://native-res.dcloud.net.cn/images/uts/forAndroid/uts_android_res_folder.jpg)

示例文件在hello uts中的位置:

D
DCloud_LXH 已提交
228
~\uni_modules\uts-nativepage\utssdk\app-android\res
D
DCloud_LXH 已提交
229 230 231 232 233 234 235 236 237 238 239 240 241 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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

除了这里列出的layout、values目录外,还支持anim等所有android标准资源目录


**需要注意的是:如果res资源中使用了 android appcompat库内置的资源,需要在config.json中添加下面的配置:**

```json
{
	"dependencies": [
		"androidx.appcompat:appcompat:1.0.0"
	]
}


```



### 3.3 配置asset资源

以hello UTS中的uts-advance插件为例。

![目录结构](https://native-res.dcloud.net.cn/images/uts/forAndroid/uts_android_assets_folder.jpg)

关键代码:

```ts
// 获取asset管理器
let assetManager = getAppContext()!.getAssets();
// 加载free.mp3 资源
let afd = assetManager.openFd("free.mp3");
// 使用android 自带的媒体组件进行播放
let mediaPlayer = new MediaPlayer();
mediaPlayer.setDataSource(afd.getFileDescriptor(),afd.getStartOffset(), afd.getLength());
mediaPlayer.prepare();
mediaPlayer.start();
```

完整的代码在hello uts中的位置:

~\uni_modules\uts-advance\utssdk\app-android\assets

### 3.4 增加libs依赖资源

下面是一个`config.json`示例

```json
{
	"dependencies": [
		"androidx.recyclerview:recyclerview:1.0.0"
	]
}


```


------

截止 HBuilder 3.8.2 版本内置了以下依赖

开发者在使用列表中的依赖时,需要注意两点:

+  真机运行时,不需要添加列表中的依赖,即可直接引用相关类
+  请勿通过 手动添加jar/aar 等方式引入相同的依赖,否则会因依赖冲突导致云打包失败。

```gradle
+--- my-imageloader.jar
+--- my-nineoldandroids-2.4.0.jar
+--- zip4j-2.8.0.jar
+--- com.github.getActivity:XXPermissions:18.0@jar
+--- android-gif-drawable-release@1.2.23.aar
+--- msa_mdid_1.0.13.aar
+--- breakpad-build-release.aar
+--- androidx.multidex:multidex:2.0.0@aar
+--- androidx.recyclerview:recyclerview:1.0.0@aar
+--- androidx.legacy:legacy-support-v4:1.0.0@aar
+--- androidx.appcompat:appcompat:1.0.0@aar
+--- com.github.bumptech.glide:glide:4.9.0@aar
+--- com.alibaba:fastjson:1.1.46.android@jar
+--- androidx.fragment:fragment:1.0.0@aar
+--- androidx.vectordrawable:vectordrawable-animated:1.0.0@aar
+--- androidx.legacy:legacy-support-core-ui:1.0.0@aar
+--- androidx.media:media:1.0.0@aar
+--- androidx.legacy:legacy-support-core-utils:1.0.0@aar
+--- androidx.vectordrawable:vectordrawable:1.0.0@aar
+--- androidx.viewpager:viewpager:1.0.0@aar
+--- androidx.coordinatorlayout:coordinatorlayout:1.0.0@aar
+--- androidx.drawerlayout:drawerlayout:1.0.0@aar
+--- androidx.slidingpanelayout:slidingpanelayout:1.0.0@aar
+--- androidx.customview:customview:1.0.0@aar
+--- androidx.swiperefreshlayout:swiperefreshlayout:1.0.0@aar
+--- androidx.asynclayoutinflater:asynclayoutinflater:1.0.0@aar
+--- androidx.loader:loader:1.0.0@aar
+--- androidx.core:core:1.0.0@aar
+--- androidx.versionedparcelable:versionedparcelable:1.0.0@aar
+--- androidx.collection:collection:1.0.0@jar
+--- androidx.cursoradapter:cursoradapter:1.0.0@aar
+--- com.github.bumptech.glide:gifdecoder:4.9.0@aar
+--- androidx.lifecycle:lifecycle-runtime:2.0.0@aar
+--- androidx.interpolator:interpolator:1.0.0@aar
+--- androidx.documentfile:documentfile:1.0.0@aar
+--- androidx.localbroadcastmanager:localbroadcastmanager:1.0.0@aar
+--- androidx.print:print:1.0.0@aar
+--- androidx.lifecycle:lifecycle-viewmodel:2.0.0@aar
+--- androidx.lifecycle:lifecycle-livedata:2.0.0@aar
+--- androidx.lifecycle:lifecycle-livedata-core:2.0.0@aar
+--- androidx.lifecycle:lifecycle-common:2.0.0@jar
+--- androidx.arch.core:core-runtime:2.0.0@aar
+--- androidx.arch.core:core-common:2.0.0@jar
+--- androidx.annotation:annotation:1.0.0@jar
+--- com.github.bumptech.glide:disklrucache:4.9.0@jar
\--- com.github.bumptech.glide:annotations:4.9.0@jar


```



### 3.5 远程依赖仓库说明

目前云打包机支持下面的仓库:

杜庆泉's avatar
杜庆泉 已提交
352
```gradle
D
DCloud_LXH 已提交
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

jcenter()
google()
// huawei
maven {url 'https://developer.huawei.com/repo/'}
// jitpack 远程仓库:https://jitpack.io
maven { url 'https://jitpack.io' }

```

部分场景下,开发者可能需要将本地依赖,上传到远程仓库,避免wgt提交资源过大超出打包限制。

这种情况,推荐开发者上传到 jitpack.io  这也是目前android 原生开发主流的远程仓库。 [使用文档](https://docs.jitpack.io/)





## 4 Android内置库@iodcloudutsandroid

在uts里,Android的所有api都可以访问。

杜庆泉's avatar
杜庆泉 已提交
375
但是对于Android开发中高频使用`application``activity`等,UTS通过内置对象`UTSAndroid` 进行了包裹和封装。具体见下:
D
DCloud_LXH 已提交
376 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 419 420 421 422 423 424 425 426 427

### 4.1 application 上下文相关

#### 4.1.1 getAppContext

> HBuilderX 3.6.3+


```ts
import { UTSAndroid } from "io.dcloud.uts";
```

用法说明:获取当前应用Application上下文,对应android平台 Context.getApplicationContext 函数实现

Android开发场景中,调用应用级别的资源/能力,需要使用此上下文。更多用法,参考[Android官方文档](https://developer.android.google.cn/docs)


```ts
// [示例]获取asset下的音频,并且播放
let assetManager = UTSAndroid.getAppContext()!.getAssets();
let afd = assetManager.openFd("free.mp3");
let mediaPlayer = new MediaPlayer();
mediaPlayer.setDataSource(afd.getFileDescriptor(),afd.getStartOffset(), afd.getLength());
mediaPlayer.prepare();
mediaPlayer.start();
```

** 与Application的转换 **

UTSAndroid.getAppContext() 默认返回的是 实现了 `Context`抽象类的`Application` 对象

部分场景,明确需要 `Application` 对象,那么直接强制类型转换即可

```ts
import Application from 'android.app.Application'


let app = UTSAndroid.getAppContext() as Application
console.log(app)
```


#### 4.1.2 getResourcePath(resourceName:String)

> HBuilderX 3.6.3+


```ts
import { UTSAndroid } from "io.dcloud.uts";
```

获取指定插件资源的运行期绝对路径
D
DCloud_LXH 已提交
428

D
DCloud_LXH 已提交
429 430 431 432 433 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
```ts
// [示例]获取指定资源路径
// 得到文件运行时路径: `/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/__UNI__3732623/www/uni_modules/test-uts-static/static/logo.png`
UTSAndroid.getResourcePath("uni_modules/test-uts-static/static/logo.png")

```

#### 4.1.3 onAppTrimMemory / offAppTrimMemory

##### onAppTrimMemory

> HBuilderX 3.6.11+


App 内存不足时,系统回调函数 对应原生的API: onTrimMemory

```ts
UTSAndroid.onAppTrimMemory((level:Number) => {
	let eventName = "onAppTrimMemory - " + level;
	console.log(eventName);
});
```

##### offAppTrimMemory

> HBuilderX 3.6.11+


onAppTrimMemory 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听

```ts
// 移除所有监听
UTSAndroid.offAppTrimMemory()
// 移除指定监听
UTSAndroid.offAppTrimMemory((level:Number) => {
D
DCloud_LXH 已提交
466

D
DCloud_LXH 已提交
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
});
```


#### 4.1.4 onAppConfigChange / offAppConfigChange

##### onAppConfigChange

> HBuilderX 3.6.1+


App 配置发生变化时触发,比如横竖屏切换 对应原生的API: onConfigurationChanged

```ts
UTSAndroid.onAppConfigChange((ret:UTSJSONObject) => {
	let eventName = "onAppConfigChange - " + JSON.stringify(ret);
	console.log(eventName);
});
```

##### offAppConfigChange


与onAppConfigChange 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听

```ts
// 移除所有监听
UTSAndroid.offAppConfigChange();
// 移除指定监听
UTSAndroid.offAppConfigChange(function(ret){

});
```


--------------------------------


特别说明:除了本章节列出的函数外,android环境下 application 其他上下文方法都可以通过 getAppContext()!.xxx()的方式实现

比如获取app缓存目录:

杜庆泉's avatar
杜庆泉 已提交
511
```ts
D
DCloud_LXH 已提交
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 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 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
UTSAndroid.getAppContext()!.getExternalCacheDir()!.getPath()
```


### 4.2 Activity 上下文 @activity

#### 4.2.1 getUniActivity

> HBuilderX 3.6.11+


获取当前插件所属的activity实例,对应android平台 getActivity 函数实现

Android开发场景中,调用活动的级别的资源/能力,需要使用此上下文。更多用法,参考[Android官方文档](https://developer.android.google.cn/docs)

```ts
// [示例]获取当前activity顶层容器
let decorView = UTSAndroid.getUniActivity()!.window.decorView;
let frameContent = decorView.findViewById<FrameLayout>(android.R.id.content)
```

#### 4.2.2 onAppActivityPause / offAppActivityPause

##### onAppActivityPause

> HBuilderX 3.6.3+


App的activity onPause时触发

```ts
UTSAndroid.onAppActivityPause(() => {
    let eventName = "onAppActivityPause - " + Date.now();
    console.log(eventName);
});
```

##### offAppActivityPause

> HBuilderX 3.6.9+

onAppActivityPause 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听


```ts
// 移除全部监听
UTSAndroid.offAppActivityPause();
// 移除指定监听
UTSAndroid.offAppActivityPause(() => {
});
```



#### 4.2.3 onAppActivityResume / offAppActivityResume

##### onAppActivityResume

> HBuilderX 3.6.3+



App的activity onResume时触发

```ts
UTSAndroid.onAppActivityResume(() => {
     let eventName = "onAppActivityResume - " + Date.now();
     console.log(eventName);
});
```

##### offAppActivityResume

> HBuilderX 3.6.9+

onAppActivityResume 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听


```ts
// 移除全部监听
UTSAndroid.onAppActivityResume();
// 移除指定监听
UTSAndroid.onAppActivityResume(() => {
});
```



#### 4.2.4 onAppActivityDestroy / offAppActivityDestroy

##### onAppActivityDestroy

> HBuilderX 3.6.3+


App 的 activity onDestroy时触发

```ts
UTSAndroid.onAppActivityDestroy(() => {
     let eventName = "onAppActivityDestroy- " + Date.now();
     console.log(eventName);
});
```

##### offAppActivityDestroy

> HBuilderX 3.6.9+

onAppActivityDestroy 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听


```ts
// 移除全部监听
UTSAndroid.offAppActivityDestroy();
// 移除指定监听
UTSAndroid.offAppActivityDestroy(() => {
});
```



#### 4.2.5 onAppActivityBack / offAppActivityBack

##### onAppActivityBack

> HBuilderX 3.6.3+


App 的 activity 回退物理按键点击时触发

```ts
UTSAndroid.onAppActivityBack(() => {
     let eventName = "onAppActivityBack- " + Date.now();
     console.log(eventName);
});

```

##### offAppActivityBack

> HBuilderX 3.6.9+

onAppActivityBack 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听


```ts
// 移除全部监听
UTSAndroid.offAppActivityBack();
// 移除指定监听
UTSAndroid.offAppActivityBack(() => {
});
```



#### 4.2.6 onAppActivityResult / offAppActivityResult



##### onAppActivityResult

> HBuilderX 3.6.8+

D
DCloud_LXH 已提交
683
App 的 activity 启动其他activity的回调结果监听 对应原生的  [onActivityResult](https://developer.android.com/training/basics/intents/result)
D
DCloud_LXH 已提交
684 685 686 687 688 689 690 691 692 693 694 695 696 697

需要特别注意的是 `requestCode` 参数,这个参数用于区别 不同的请求来源,开发者应该只处理自己发起请求

```ts
let customRequestCode = 12000

UTSAndroid.onAppActivityResult((requestCode: Int, resultCode: Int, data?: Intent) => {
	if(requestCode == 12000){
		// 我们发起的请求
		let eventName = "onAppActivityResult  -  requestCode:" + requestCode + " -resultCode:"+resultCode + " -data:"+JSON.stringify(data);
    	console.log(eventName);
	}else{
		// 别的代码发起的请求,不要处理
	}
D
DCloud_LXH 已提交
698

D
DCloud_LXH 已提交
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
});
```

##### offAppActivityResult

> HBuilderX 3.6.9+

onAppActivityResult 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听


```ts
// 移除全部监听
UTSAndroid.offAppActivityResult();
// 移除指定监听
UTSAndroid.offAppActivityResult(() => {
});
```


#### 4.2.7 onAppActivityRequestPermissionsResult / offAppActivityRequestPermissionsResult

> 已废弃,请使用 4.4章节系统权限管理替代此api

##### onAppActivityRequestPermissionsResult

> HBuilderX 3.6.3+


App 的 activity 获得权限请求结果的回调

```ts
UTSAndroid.onAppActivityRequestPermissionsResult((requestCode: number,
                                                     permissions: Array<string>,
                                                     grantResults: Array<number>) => {
D
DCloud_LXH 已提交
735

D
DCloud_LXH 已提交
736
		console.log(grantResults);
D
DCloud_LXH 已提交
737
		console.log(permissions);
D
DCloud_LXH 已提交
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
		console.log(requestCode);
	});

//发起定位权限申请
let permission = [Manifest.permission.ACCESS_COARSE_LOCATION]
ActivityCompat.requestPermissions(getUniActivity()!,
	    permission, 1001);

```

##### offAppActivityRequestPermissionsResult

> HBuilderX 3.6.9+

onAppActivityRequestPermissionsResult 对应的反注册函数

如果传入的函数可为空,如果为空,则视为移除所有监听


```ts
// 移除全部监听
UTSAndroid.offAppActivityRequestPermissionsResult();
// 移除指定监听
UTSAndroid.offAppActivityRequestPermissionsResult(() => {
});
杜庆泉's avatar
杜庆泉 已提交
763
```
D
DCloud_LXH 已提交
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
-----------------------------


特别说明:除了本章节列出的函数外,android环境下 activity 其他上下文方法都可以通过 getUniActivity()!.xxx()的方式实现

比如获取当前activity的顶层View容器

```ts
UTSAndroid.getUniActivity()!.getWindow().getDecorView();
```

### 4.3 UTS插件开发中Activity生命周期注意事项

即使在android原生开发中,应用的生命周期管理也是十分重要的。 [android生命周期](https://developer.android.com/guide/components/activities/activity-lifecycle?hl=zh_cn)

杜庆泉's avatar
杜庆泉 已提交
779
UTS环境中对原生的生命周期进行了封装和简化,大多数情况下,开发者只需要了解本章节中列出的 activity相关生命周期即可。
D
DCloud_LXH 已提交
780 781 782 783 784 785 786


其中最为常见的场景,要数`onAppActivityDestroy`中释放系统资源了:


举个例子,以Hello UTS  [用户截屏插件](https://ext.dcloud.net.cn/plugin?id=9897)为例。

D
DCloud_LXH 已提交
787
在注册监听回调时,添加了下列代码。
杜庆泉's avatar
杜庆泉 已提交
788
```ts
D
DCloud_LXH 已提交
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 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 859 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 885 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
UTSAndroid.onAppActivityDestroy(function(){
	screenOB?.stopWatching()
	screenOB = null
})
```

这段代码的意思是当宿主activity被销毁时,主动回收屏幕监听的FileObserver

这是因为除了正常的用户注册/注册 之外,还存在一种情况:用户没有反注册,便关闭了应用。   此时FileObserver 并没有被反注册回收。就会导致应用关闭后继续持有上一个uni-app js引擎实例的引用,从而导致下一次启动时出现引擎回调找不到的情况。


开发者在开发UTS插件时,如果遇到了类似使用系统组件的情况,也需要特别关注资源释放情况。


### 4.4 系统权限管理

HBuilder X 3.8.2版本之后支持

系统权限管理使用了 https://github.com/getActivity/XXPermissions 工具库

如果开发者使用了相同依赖,可能打包冲突。需要修改为 complileOnly 或者 修改为本章节内置API



##### 4.4.1 requestSystemPermission

请求系统权限,对应的两个参数:
1  请求的权限列表
2  请求结果回调

```ts
let permission = ["android.permission.ACCESS_FINE_LOCATION","android.permission.ACCESS_FINE_LOCATION"]
UTSAndroid.requestSystemPermission(UTSAndroid.getUniActivity()!,permission,function(allRight:boolean,grantedList:string[]){
		if(allRight){
			// 用户同意了全部权限
		}else{
			// 用户仅同意了 grantedList中的权限
		}
	},function(doNotAskAgain:boolean,grantedList:string[]){
		// 用户拒绝了部分权限,仅允许了grantedList中的权限
		if(doNotAskAgain){
			// 用户拒绝了权限,并且选择不再询问
		}
	})
```

##### 4.4.2 gotoSystemPermissionActivity

跳转至系统设置权限设置界面,一般是用户选择了不再继续询问选项后

```
let permissionWifi = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_FINE_LOCATION"]
UTSAndroid.gotoSystemPermissionActivity(UTSAndroid.getUniActivity()!,permissionWifi)
```


##### 4.4.3 getSystemPermissionDenied@getSystemPermissionDenied

判断权限是否已经被用户禁止

```ts
let permission = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_FINE_LOCATION"]
let denied = UTSAndroid.getSystemPermissionDenied(UTSAndroid.getUniActivity()!, permission)
// 执行结果
[android.permission.ACCESS_FINE_LOCATION, android.permission.ACCESS_FINE_LOCATION]
```

##### 4.4.4 checkSystemPermissionGranted

判断权限是否已经被用户授予

```ts
let permission = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_FINE_LOCATION"]
let grant = UTSAndroid.checkSystemPermissionGranted (UTSAndroid.getUniActivity()!, permission)
// 执行结果
false
```

## 5 Kotlin与UTS差异重点介绍 (持续更新)

通过上面的章节的阅读。

至此我们认为你已经掌握了UTS语法,掌握了基本的Kotlin语法,掌握了UTS对于android资源的支持。

但是对于一个熟悉android开发的kotlin语言者来说,有很多常用的习惯发生了改变,我们会在这个章节特别指出,便于开发者加深认识。


### 5.1 语法差异

-------------------------------

#### 5.1.1 可为空的语法标识

kotlin中可为空的语法统一为类型后加`?`,以下面的代码为例

```ts
// 一个可为空的字符串变量,变量名为user
var user:String? = null
```

但是ts中分两种情况,如果是全局变量,可为空,需要这样写

```ts
let user:string | null
```

如果是成员变量,与kotlin类似,但是区别在于?写在变量后,而非类型后
```ts
let user?:string
```

#### 5.1.2  let和var

`kotlin`中 可变变量修饰为 `var``val`。 区别在于 val 不可变,var可变。

`uts`中对应`var`的变量类型为 `var/let`

推荐使用`let` 因为只会在作用域内生效,需要慎用`var`,因为它具备有更大的作用范围


#### 5.1.3 方法定义

方法定义 `kotlin`里的方法只有一种定义方式

```kotlin
 fun startListener():void{
D
DCloud_LXH 已提交
915

D
DCloud_LXH 已提交
916 917 918 919 920 921 922
 }
```
uts中,需要区分全局方法、成员方法

```ts
 // 成员方法
 startListener():void{
D
DCloud_LXH 已提交
923

D
DCloud_LXH 已提交
924 925
 }
```
D
DCloud_LXH 已提交
926

D
DCloud_LXH 已提交
927 928 929
```ts
 // 全局方法
 function startListener():void{
D
DCloud_LXH 已提交
930

D
DCloud_LXH 已提交
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
 }
```

#### 5.1.4 extends

`kotlin`中的: 继承操作符,需要用`extends`取代

|语法|kotlin|uts|
|---|-------|---|
|继承类|:|extends|
|实现type接口|:|extends|
|实现接口|:|implements|


```ts
// 使用UTS 实现 OnClickListener接口
class StartServiceListener extends OnClickListener{
D
DCloud_LXH 已提交
948

D
DCloud_LXH 已提交
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
    override onClick(v?: View):void{
		// 执行点击逻辑
    }
}

```





#### 5.1.5 非空断言

kotlin中的非空断言是`!!`,ts中是一个`!`

```ts
user!.sayHello();
```

```kotlin
user!!.sayHello();
```


#### 5.1.6 快速调用父类实现


```kotlin
//kotlin 中快速实现super
constructor() : super() {
}
D
DCloud_LXH 已提交
980

D
DCloud_LXH 已提交
981 982
```

杜庆泉's avatar
杜庆泉 已提交
983
```ts
D
DCloud_LXH 已提交
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 1034 1035 1036 1037 1038 1039 1040 1041 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 1101 1102 1103 1104 1105 1106 1107
//uts 中快速实现super
constructor (){
	super();
}
```


#### 5.1.7 匿名内部类

`kotlin`中可以使用匿名内部类

```kotlin
// kotlin 新建事件监听
user.setListener(Listener(){
	//todo
});
```

目前版本UTS还不支持匿名内部类,需要显性的声明再新建

```ts
// 声明一个新的类,实现Listener
class MyListener extends Listener{
	// todo
}
// 新建实例
let myListener = new MyListener();
user.setListener(myListener);
```

#### 5.1.8 可为空函数调用


有一种特殊场景,我们需要定义一些可为空的函数变量,比如下面的 success,fail:

```ts
type Option = {
	success?: (res: object) => void;
	fail?: (res: object) => void;
};

```


这个时候我们需要这样调用

```ts
options.success?.(res)
```

这样的调用方式在kotlin中是非法的,属于TS中的特有语法,需要特别注意。


#### 5.1.9 一个类只能有一个构造函数

`Kotlin`/`java`中允许一个函数有多个构造器,但是UTS中是不被允许的



#### 5.1.10 界面跳转写法

android开发中场景的 intent跳转需要传入 目标界面的class对象,目前UTS中仅支持一种写法

```ts
let intent = new Intent(getUniActivity(),DemoActivity().javaClass);
getUniActivity()!.startActivity(intent);
```

#### 5.1.11 指定double数据类型

某些场景下开发者需要获得 指定double数据类型的数据

开发者下意识的写法可能是:
```ts
// 这样是错误的
let a:Int =3
let b:Int =4
let c:Double  = a/b
```

但是Android原生环境中,数据类型的精度是向下兼容的,如果想要获得一个double类型,必须要有一个double类型参与运算:

```ts
// 这样才是正确的
let a:Int =3
let b:Int =4
let c:Double  = a * 1.0 / b
```


---------------------------------

### 5.2 警告优化

下面的内容不会影响功能使用,但是在UTS环境中,有合适的解决办法

#### 5.2.1 java lang包的引入问题

`kotlin` 或者`java` 中java.lang.*是被特殊处理的,可以直接使用而不需要引入。

```kotlin
// 获取当前时间戳
System.currentTimeMillis()
```


UTS环境中,lang包没有被特殊对待,需要手动引入。

```ts
// 手动引入lang包下的类
import System from 'java.lang.System';

// 获取当前时间戳
System.currentTimeMillis()
```


#### 5.2.2 `UTS` 不建议使用 快捷构造

`kotlin`  中 支持通过()的方式,快速实现无参构造器的声明

```kotlin
// 获取当前时间戳
class ScreenReceiver extends BroadcastReceiver(){
D
DCloud_LXH 已提交
1108

D
DCloud_LXH 已提交
1109 1110 1111 1112 1113 1114 1115 1116
}
```


UTS环境中,不建议这样做(虽然目前这样做不会影响编译),建议使用手动声明无参构造

```ts
class ScreenReceiver extends BroadcastReceiver{
D
DCloud_LXH 已提交
1117

D
DCloud_LXH 已提交
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
	constructor (){
		super();
	}

}
```



## 6  常见问题(持续更新)

### 6.1 如何在UTS环境中,新建一个`activity`?

参考Hello UTS项目中的uts-nativepage插件


### 6.2 如何在UTS环境中,新建一个`service`?

参考Hello UTS项目中的uts-nativepage插件


### 6.3 如何在UTS环境中,新建一个`Thread`?

简单示例
杜庆泉's avatar
杜庆泉 已提交
1142
```ts
D
DCloud_LXH 已提交
1143
class CustomThread extends Thread{
D
DCloud_LXH 已提交
1144

D
DCloud_LXH 已提交
1145 1146 1147
	constructor(){
		super();
	}
D
DCloud_LXH 已提交
1148

D
DCloud_LXH 已提交
1149 1150 1151 1152 1153 1154 1155 1156 1157
	override run(){
		Thread.sleep(1000)
		console.log("CustomThread = " + Thread.currentThread().getName())
	}
}
```

完整示例参考Hello UTS项目中的uts-nativepage插件

杜庆泉's avatar
杜庆泉 已提交
1158
如果只是想要简单的开启一个异步任务,建议使用:
D
DCloud_LXH 已提交
1159

杜庆泉's avatar
杜庆泉 已提交
1160
```ts
杜庆泉's avatar
杜庆泉 已提交
1161
UTSAndroid.getDispatcher("io").async(function(_){
D
DCloud_LXH 已提交
1162

杜庆泉's avatar
杜庆泉 已提交
1163
}
D
DCloud_LXH 已提交
1164 1165
```

杜庆泉's avatar
杜庆泉 已提交
1166
[详细用法](https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html#getdispatcher)
D
DCloud_LXH 已提交
1167 1168 1169



杜庆泉's avatar
杜庆泉 已提交
1170
### 如何生成byte[]对象
D
DCloud_LXH 已提交
1171

D
DCloud_LXH 已提交
1172
在java平台中,二进制操作一般采用字节数组实现。
D
DCloud_LXH 已提交
1173 1174 1175 1176 1177 1178 1179

UTS在android平台编译后的语言为Kotlin,对应的语法对象是ByteArray.

使用这个类不需要额外引入包,直接运行即可

下面是一个简单的示例

杜庆泉's avatar
杜庆泉 已提交
1180
```ts
D
DCloud_LXH 已提交
1181 1182 1183 1184 1185 1186
let byteTest = new ByteArray(5)
console.log(byteTest)
```



杜庆泉's avatar
杜庆泉 已提交
1187
### 编译报错:unresolved reference R (R资源无法识别)
D
DCloud_LXH 已提交
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

UTS插件支持使用android的原生资源,比如动画,布局,字符串等。 [详细说明](https://uniapp.dcloud.net.cn/plugin/uts-for-android.html#_3-1-%E9%85%8D%E7%BD%AEandroidmanifest-xml)


如果提示 R资源无法找到:unresolved reference R

1 需要排查资源是否符合android原生格式

2 检查R资源引入的包名是否正确,参考hello uts nativepage插件

杜庆泉's avatar
杜庆泉 已提交
1198
```ts
D
DCloud_LXH 已提交
1199 1200 1201 1202
import R from 'io.dcloud.uni_modules.uts_nativepage.R';
```


杜庆泉's avatar
杜庆泉 已提交
1203
### 6.14  如何实现一个接口
D
DCloud_LXH 已提交
1204 1205

以HelloUTS nativepage插件 部分代码为例:
杜庆泉's avatar
杜庆泉 已提交
1206 1207

 ```ts
D
DCloud_LXH 已提交
1208 1209 1210 1211 1212 1213 1214
import OnClickListener from 'android.view.View.OnClickListener';
// 实现 OnClickListener 接口
class User {
	name:string = "name"
}

 class StartBroadcastListener extends User implements OnClickListener{
D
DCloud_LXH 已提交
1215

D
DCloud_LXH 已提交
1216
    override onClick(v?: View):void{
D
DCloud_LXH 已提交
1217

D
DCloud_LXH 已提交
1218 1219 1220 1221 1222
		let myReceiver = new ScreenReceiver();
		let filter = new IntentFilter();
		filter.addAction(Intent.ACTION_SCREEN_OFF);
		filter.addAction(Intent.ACTION_SCREEN_ON);
		UTSAndroid.getUniActivity()!.registerReceiver(myReceiver, filter);
D
DCloud_LXH 已提交
1223

D
DCloud_LXH 已提交
1224 1225
		// 提示屏幕状态监听已经注册
		Toast.makeText(UTSAndroid.getAppContext(),"屏幕状态监听已注册,注意观察控制台日志",Toast.LENGTH_LONG).show();
D
DCloud_LXH 已提交
1226

D
DCloud_LXH 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
    }
}


// 使用
let btn_start_screen_listen = this.findViewById<Button>(R.id.btn_start_screen_listen);
btn_start_screen_listen.setOnClickListener(new StartBroadcastListener());
 ```

如果要同时实现多个接口,采用的也是  implements 和 `,` 分隔来实现

杜庆泉's avatar
杜庆泉 已提交
1238
```ts
D
DCloud_LXH 已提交
1239 1240 1241 1242 1243
class Person{
	name:string = ""
}
class User extends Person implements android.view.View.OnClickListener,Cloneable{
	constructor(){
D
DCloud_LXH 已提交
1244

D
DCloud_LXH 已提交
1245
	}
D
DCloud_LXH 已提交
1246

D
DCloud_LXH 已提交
1247 1248 1249
	override onClick(v?: android.view.View):void{
		console.log(v)
	}
D
DCloud_LXH 已提交
1250

D
DCloud_LXH 已提交
1251 1252 1253 1254 1255 1256 1257 1258 1259
	override equals(other?: any):boolean{
		return true
	}
}

```

编译后的kotlin代码

杜庆泉's avatar
杜庆泉 已提交
1260
```kotlin
D
DCloud_LXH 已提交
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
open class Person {
    open var name: String = "";
}
open class User : Person, android.view.View.OnClickListener, Cloneable {
    constructor(){}
    override fun onClick(v: android.view.View?): Unit {
        console.log(v, " at uni_modules/uts-helloworld/utssdk/index.uts:37");
    }
    override fun equals(other: Any?): Boolean {
        return true;
    }
}
```

其中需要注意的是

+ 目前暂不支持匿名声明,需要先定义一个 StartBroadcastListener 声明实现 OnClickListener 后再显性的创建

杜庆泉's avatar
杜庆泉 已提交
1279
### UTS 如何访问静态实例方法
杜庆泉's avatar
杜庆泉 已提交
1280

杜庆泉's avatar
杜庆泉 已提交
1281
kotlin编译产出的AAR,会将访问方法修改为私有,不能以下面的方法访问
杜庆泉's avatar
杜庆泉 已提交
1282

杜庆泉's avatar
杜庆泉 已提交
1283
```ts
杜庆泉's avatar
杜庆泉 已提交
1284 1285 1286 1287 1288
ScancodeConfig.setShowLine(false);
```

应该使用属性访问:

杜庆泉's avatar
杜庆泉 已提交
1289
```ts
杜庆泉's avatar
杜庆泉 已提交
1290 1291
ScancodeConfig.showLine = false;
```
D
DCloud_LXH 已提交
1292 1293 1294 1295 1296 1297




## 7  已知待解决问题(持续更新)

杜庆泉's avatar
杜庆泉 已提交
1298
### 结构入参 boolean 参数默认为true
D
DCloud_LXH 已提交
1299 1300 1301

当以type 结构体为参数时,其内部boolean字段 默认值为false,不支持指定。

杜庆泉's avatar
杜庆泉 已提交
1302
### 目前尚不支持 8.x 版本gradle
D
DCloud_LXH 已提交
1303 1304 1305

建议先使用7.X版本,这个问题后续会处理

杜庆泉's avatar
杜庆泉 已提交
1306
### android原生资源文件,暂不支持三方库依赖
D
DCloud_LXH 已提交
1307 1308 1309

比如xml布局文件中暂时只支持 linearlayout等官方标签,不支持 appcompat等三方库标签。这个问题后续会被处理