uts-for-android.md 27.9 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
});

```

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

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

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


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

```


D
DCloud_LXH 已提交
121
### 2.4 线程环境差异 @thread-environment
D
DCloud_LXH 已提交
122

杜庆泉's avatar
杜庆泉 已提交
123
UTS语言本身没有线程的概念。 但在具体的运行平台上会有线程环境差异:
杜庆泉's avatar
杜庆泉 已提交
124

杜庆泉's avatar
杜庆泉 已提交
125
+ uni-app 平台:默认代码执行在 `WeexJSBridgeThread`
杜庆泉's avatar
杜庆泉 已提交
126

杜庆泉's avatar
杜庆泉 已提交
127
+ uni-app x 平台:默认代码执行在 `main`线程
杜庆泉's avatar
杜庆泉 已提交
128

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

杜庆泉's avatar
杜庆泉 已提交
130
`Android`系统对线程操作存在较多的限制, UTS内置了[UTSAndroid.getDispatcher方法](https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html#getdispatcher)  用来屏蔽大多数底层细节,一般来说开发者只需要关心两种特殊情况:
D
DCloud_LXH 已提交
131

杜庆泉's avatar
杜庆泉 已提交
132 133 134 135 136 137 138 139 140
如果需要执行耗时任务:

```ts
UTSAndroid.getDispatcher("io").async(function(_){
	// 执行耗时任务
},null)
```

如果需要操作UI:
D
DCloud_LXH 已提交
141 142

```ts
杜庆泉's avatar
杜庆泉 已提交
143
UTSAndroid.getDispatcher("main").async(function(_){
杜庆泉's avatar
杜庆泉 已提交
144
	// 执行界面修改,包括view添加移除等
杜庆泉's avatar
杜庆泉 已提交
145
},null)
D
DCloud_LXH 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
```


## 3 Android原生环境配置

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

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

**注意**

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

### 3.1 配置AndroidManifest.xml

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

杜庆泉's avatar
杜庆泉 已提交
164
文件位置: ~\uni_modules\uts-nativepage\utssdk\app-android\AndroidManifest.xml
D
DCloud_LXH 已提交
165 166 167 168 169

AndroidManifest.xml示例:

```xml
<?xml version="1.0" encoding="utf-8"?>
D
DCloud_LXH 已提交
170
<manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools"
D
DCloud_LXH 已提交
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  // 注意:这里是插件的包名而不是应用的包名
  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
杜庆泉 已提交
187
UTS插件中的 `AndroidManifest.xml``android` 中的 `AndroidManifest.xml` 规则完全一致。
D
DCloud_LXH 已提交
188 189


杜庆泉's avatar
杜庆泉 已提交
190
**特别提示**
D
DCloud_LXH 已提交
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215

每一个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 已提交
216
~\uni_modules\uts-nativepage\utssdk\app-android\res
D
DCloud_LXH 已提交
217 218 219 220 221 222 223 224 225 226 227 228 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

除了这里列出的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依赖资源

杜庆泉's avatar
杜庆泉 已提交
261 262
#### 远程依赖

杜庆泉's avatar
杜庆泉 已提交
263
远端插件可以通过配置 `config.json`添加依赖 ,下面是一个`config.json`示例
D
DCloud_LXH 已提交
264 265 266 267 268 269 270 271 272 273 274 275 276 277

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


```


------

杜庆泉's avatar
杜庆泉 已提交
278
截止 HBuilder X 4.23 版本内置了以下依赖
D
DCloud_LXH 已提交
279 280 281 282 283 284

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

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

杜庆泉's avatar
杜庆泉 已提交
285 286


杜庆泉's avatar
杜庆泉 已提交
287
##### uni-app x
杜庆泉's avatar
杜庆泉 已提交
288

D
DCloud_LXH 已提交
289 290
```gradle

杜庆泉's avatar
杜庆泉 已提交
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
implementation 'androidx.core:core-ktx:1.10.1'
implementation 'androidx.recyclerview:recyclerview:1.3.2'
implementation 'androidx.appcompat:appcompat:1.0.0'
implementation 'androidx.exifinterface:exifinterface:1.3.6'
implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0@aar'
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
implementation 'com.google.android.material:material:1.4.0'
implementation 'androidx.viewpager2:viewpager2:1.1.0-beta02'
implementation 'com.alibaba:fastjson:1.2.83'
implementation 'com.facebook.fresco:fresco:3.1.3'
implementation 'com.facebook.fresco:middleware:3.1.3'
implementation 'com.facebook.fresco:animated-gif:3.1.3'
implementation 'com.facebook.fresco:webpsupport:3.1.3'
implementation 'com.facebook.fresco:animated-webp:3.1.3'
implementation 'com.github.bumptech.glide:glide:4.9.0'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'
implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.8.10'
implementation 'org.jetbrains.kotlin:kotlin-reflect:1.8.10'
implementation 'org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1'
implementation 'com.squareup.okhttp3:okhttp:3.12.12'
implementation 'com.github.getActivity:XXPermissions:18.0'
implementation 'androidx.recyclerview:recyclerview:1.0.0'
D
DCloud_LXH 已提交
314 315 316

```

杜庆泉's avatar
杜庆泉 已提交
317
##### uni-app
杜庆泉's avatar
杜庆泉 已提交
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

```gradle
implementation 'com.github.bumptech.glide:glide:4.9.0'
implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'
implementation 'androidx.core:core:1.1.0'
implementation 'androidx.fragment:fragment:1.1.0'
implementation 'androidx.recyclerview:recyclerview:1.1.0'
implementation 'androidx.appcompat:appcompat:1.1.0'
implementation 'com.alibaba:fastjson:1.2.83'
implementation 'androidx.webkit:webkit:1.3.0'
implementation 'com.squareup.okhttp3:okhttp:3.12.12'
implementation 'androidx.core:core-ktx:1.6.0'
implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.8.10'
implementation 'org.jetbrains.kotlin:kotlin-reflect:1.6.0'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.8'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.8'
implementation 'com.github.getActivity:XXPermissions:18.0'
implementation 'com.facebook.fresco:fresco:2.5.0'
implementation 'com.facebook.fresco:animated-gif:2.5.0'
implementation 'com.facebook.fresco:webpsupport:2.5.0'
implementation 'com.facebook.fresco:animated-webp:2.5.0'
implementation 'androidx.recyclerview:recyclerview:1.0.0'
implementation 'androidx.appcompat:appcompat:1.0.0'
```

杜庆泉's avatar
杜庆泉 已提交
343 344 345 346 347 348 349 350 351 352
关于 `config.json` 的更多写法,可以参考[文档](https://nativesupport.dcloud.net.cn/NativePlugin/course/package.html#dependencies)


#### 本地依赖

jar/aar文件:

参考 [hello uts](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules/uts-nativepage/utssdk/app-android/libs) 将jar/aar 添加到 `utssdk/app-android/libs` 目录下即可使用

so文件:
D
DCloud_LXH 已提交
353

杜庆泉's avatar
杜庆泉 已提交
354
目前暂不支持so文件直接本地调试,所以在HBuilderX 4.26版本支持 [混编](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-plugin-hybrid.html) 之前,推荐开发者将so 封装为AAR,或者分别集成 so和jar文件,自定义基座后再进行调试
杜庆泉's avatar
杜庆泉 已提交
355

杜庆泉's avatar
杜庆泉 已提交
356
HBuilderX 4.26版本之后,开发者可以使用混编kotlin代码的方式,直接集成so文件。参考[hello uts](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules/uts-nativepage/utssdk/app-android/libs)
D
DCloud_LXH 已提交
357

杜庆泉's avatar
杜庆泉 已提交
358 359
### 3.5 其他配置文件

杜庆泉's avatar
杜庆泉 已提交
360
uni-app x / uni-app 均支持打包时手动指定资源位置 [说明文档](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#nativeresources)
杜庆泉's avatar
杜庆泉 已提交
361

杜庆泉's avatar
杜庆泉 已提交
362
例如 接入`Firebase` 时需要将`google-services.json`文件放在 `app` 目录下,则可以通过如下的配置来实现:
杜庆泉's avatar
杜庆泉 已提交
363 364 365 366 367 368 369 370


<pre v-pre="" data-lang="">
	<code class="lang-" style="padding:0">
┌─pages                         //页面目录
│  └─[具体内容]                   
├─nativeResources               //配置文件目录
│  └─android
杜庆泉's avatar
杜庆泉 已提交
371 372
│  	└─google-services.json
├─ // 其他文件
杜庆泉's avatar
杜庆泉 已提交
373 374 375 376 377 378 379
└─App.vue 
	</code>
</pre>

具体的打包示例,参考 [Hello UTS](https://gitcode.net/dcloud/hello-uts) 

### 3.6 远程依赖仓库说明
D
DCloud_LXH 已提交
380 381 382

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

杜庆泉's avatar
杜庆泉 已提交
383
```gradle
D
DCloud_LXH 已提交
384

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

D
DCloud_LXH 已提交
386 387 388 389 390 391
jcenter()
google()
// huawei
maven {url 'https://developer.huawei.com/repo/'}
// jitpack 远程仓库:https://jitpack.io
maven { url 'https://jitpack.io' }
杜庆泉's avatar
杜庆泉 已提交
392 393
// mavenCentral 默认支持
mavenCentral()
D
DCloud_LXH 已提交
394 395 396 397 398 399 400 401

```

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

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


杜庆泉's avatar
杜庆泉 已提交
402
### 3.7 Android 编译SDK版本说明
杜庆泉's avatar
杜庆泉 已提交
403

杜庆泉's avatar
杜庆泉 已提交
404
截止 HBuilderX 4.15 版本:
杜庆泉's avatar
杜庆泉 已提交
405 406 407 408 409 410

+ uni-app x 项目: 本地Android sdk 版本为34

+ uni-app   项目: 本地Android sdk 版本为31

开发者在使用系统api时,需要注意版本兼容性
D
DCloud_LXH 已提交
411 412 413



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

D
DCloud_LXH 已提交
415 416
## 4 Android内置库@iodcloudutsandroid

杜庆泉's avatar
杜庆泉 已提交
417
**在UTS语言中,所有的Android原生API都可以调用**
D
DCloud_LXH 已提交
418

杜庆泉's avatar
杜庆泉 已提交
419
对于Android开发中高频使用的`application`/`activity`等系统能力、`uni-app`/`uni-app x` 运行时框架信息等,UTS通过内置对象`UTSAndroid` 进行了封装,以便开发者调用
D
DCloud_LXH 已提交
420

杜庆泉's avatar
杜庆泉 已提交
421
下面列出了常见API的使用示例,完整的 `UTSAndroid` API文档参考:https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html
D
DCloud_LXH 已提交
422 423


杜庆泉's avatar
杜庆泉 已提交
424
#### getAppContext
D
DCloud_LXH 已提交
425 426 427 428 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

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


杜庆泉's avatar
杜庆泉 已提交
460
#### getUniActivity
D
DCloud_LXH 已提交
461 462 463 464 465 466 467 468 469 470 471

获取当前插件所属的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)
```

杜庆泉's avatar
杜庆泉 已提交
472
#### onAppActivityDestroy
D
DCloud_LXH 已提交
473 474 475

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

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

杜庆泉's avatar
杜庆泉 已提交
478
其中最为常见的场景,要数`onAppActivityDestroy`中释放系统资源:
D
DCloud_LXH 已提交
479 480 481

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

D
DCloud_LXH 已提交
482
在注册监听回调时,添加了下列代码。
杜庆泉's avatar
杜庆泉 已提交
483
```ts
D
DCloud_LXH 已提交
484 485 486 487 488 489 490 491 492 493 494 495 496 497
UTSAndroid.onAppActivityDestroy(function(){
	screenOB?.stopWatching()
	screenOB = null
})
```

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

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


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


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

杜庆泉's avatar
杜庆泉 已提交
499
#### requestSystemPermission
D
DCloud_LXH 已提交
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

HBuilder X 3.8.2版本之后支持

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

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

请求系统权限,对应的两个参数:
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){
			// 用户拒绝了权限,并且选择不再询问
		}
	})
```

杜庆泉's avatar
杜庆泉 已提交
527
--------------------------------
D
DCloud_LXH 已提交
528 529


杜庆泉's avatar
杜庆泉 已提交
530
特别说明:
D
DCloud_LXH 已提交
531

杜庆泉's avatar
杜庆泉 已提交
532
除了本章节列出的函数外,android环境下 application 其他上下文方法都可以通过 getAppContext()!.xxx()的方式实现
D
DCloud_LXH 已提交
533

杜庆泉's avatar
杜庆泉 已提交
534
比如获取app缓存目录:
D
DCloud_LXH 已提交
535 536

```ts
杜庆泉's avatar
杜庆泉 已提交
537
UTSAndroid.getAppContext()!.getExternalCacheDir()!.getPath()
D
DCloud_LXH 已提交
538 539 540
```


杜庆泉's avatar
杜庆泉 已提交
541 542 543
activity 其他上下文方法都可以通过 getUniActivity()!.xxx()的方式实现

比如获取当前activity的顶层View容器
D
DCloud_LXH 已提交
544 545

```ts
杜庆泉's avatar
杜庆泉 已提交
546
UTSAndroid.getUniActivity()!.getWindow().getDecorView();
D
DCloud_LXH 已提交
547 548
```

杜庆泉's avatar
杜庆泉 已提交
549 550 551 552 553





D
DCloud_LXH 已提交
554 555
## 5 Kotlin与UTS差异重点介绍 (持续更新)

杜庆泉's avatar
杜庆泉 已提交
556
通过上面的章节的阅读,至此我们认为你已经掌握了UTS语法,掌握了基本的Kotlin语法,掌握了UTS对于android资源的支持。
D
DCloud_LXH 已提交
557 558 559 560

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


杜庆泉's avatar
杜庆泉 已提交
561
### 语法差异
D
DCloud_LXH 已提交
562 563 564 565

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


杜庆泉's avatar
杜庆泉 已提交
566
#### let和var
D
DCloud_LXH 已提交
567 568 569 570 571 572 573 574

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

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

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


杜庆泉's avatar
杜庆泉 已提交
575
#### 方法定义
D
DCloud_LXH 已提交
576 577 578 579 580

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

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

D
DCloud_LXH 已提交
582 583 584 585 586 587 588
 }
```
uts中,需要区分全局方法、成员方法

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

D
DCloud_LXH 已提交
590 591
 }
```
D
DCloud_LXH 已提交
592

D
DCloud_LXH 已提交
593 594 595
```ts
 // 全局方法
 function startListener():void{
D
DCloud_LXH 已提交
596

D
DCloud_LXH 已提交
597 598 599
 }
```

杜庆泉's avatar
杜庆泉 已提交
600
#### extends
D
DCloud_LXH 已提交
601 602 603 604 605 606 607 608 609 610 611 612 613

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

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


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

D
DCloud_LXH 已提交
615 616 617 618 619 620 621 622 623 624 625
    override onClick(v?: View):void{
		// 执行点击逻辑
    }
}

```





杜庆泉's avatar
杜庆泉 已提交
626
#### 非空断言
D
DCloud_LXH 已提交
627 628 629 630 631 632 633 634 635 636 637 638

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

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

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


杜庆泉's avatar
杜庆泉 已提交
639
#### 快速调用父类实现
D
DCloud_LXH 已提交
640 641 642 643 644 645


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

D
DCloud_LXH 已提交
647 648
```

杜庆泉's avatar
杜庆泉 已提交
649
```ts
D
DCloud_LXH 已提交
650 651 652 653 654 655 656
//uts 中快速实现super
constructor (){
	super();
}
```


杜庆泉's avatar
杜庆泉 已提交
657
#### 匿名内部类
D
DCloud_LXH 已提交
658 659 660 661 662 663 664 665 666 667

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

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

taohebin@dcloud.io's avatar
taohebin@dcloud.io 已提交
668
在UTS中这样使用:
D
DCloud_LXH 已提交
669 670

```ts
taohebin@dcloud.io's avatar
taohebin@dcloud.io 已提交
671 672 673
const myListener = new (class implements Listener {
	//todo
})
D
DCloud_LXH 已提交
674 675 676
user.setListener(myListener);
```

杜庆泉's avatar
杜庆泉 已提交
677
#### 可为空函数调用
D
DCloud_LXH 已提交
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699


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

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

```


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

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

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


杜庆泉's avatar
杜庆泉 已提交
700
#### 一个类只能有一个构造函数
D
DCloud_LXH 已提交
701 702 703 704 705

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



杜庆泉's avatar
杜庆泉 已提交
706
#### 界面跳转写法
D
DCloud_LXH 已提交
707 708 709 710 711 712 713 714

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

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

杜庆泉's avatar
杜庆泉 已提交
715
#### 指定double数据类型
D
DCloud_LXH 已提交
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738

某些场景下开发者需要获得 指定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
```


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

杜庆泉's avatar
杜庆泉 已提交
739
###  警告优化
D
DCloud_LXH 已提交
740 741 742

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

杜庆泉's avatar
杜庆泉 已提交
743
#### java lang包的引入问题
D
DCloud_LXH 已提交
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

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

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


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

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

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


杜庆泉's avatar
杜庆泉 已提交
764
#### `UTS` 不建议使用 快捷构造
D
DCloud_LXH 已提交
765 766 767 768 769 770

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

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

D
DCloud_LXH 已提交
772 773 774 775 776 777 778 779
}
```


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

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

D
DCloud_LXH 已提交
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
	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
杜庆泉 已提交
805
```ts
D
DCloud_LXH 已提交
806
class CustomThread extends Thread{
D
DCloud_LXH 已提交
807

D
DCloud_LXH 已提交
808 809 810
	constructor(){
		super();
	}
D
DCloud_LXH 已提交
811

D
DCloud_LXH 已提交
812 813 814 815 816 817 818 819 820
	override run(){
		Thread.sleep(1000)
		console.log("CustomThread = " + Thread.currentThread().getName())
	}
}
```

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

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

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

杜庆泉's avatar
杜庆泉 已提交
826
}
D
DCloud_LXH 已提交
827 828
```

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



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

D
DCloud_LXH 已提交
835
在java平台中,二进制操作一般采用字节数组实现。
D
DCloud_LXH 已提交
836 837 838 839 840 841 842

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

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

下面是一个简单的示例

杜庆泉's avatar
杜庆泉 已提交
843
```ts
D
DCloud_LXH 已提交
844 845 846 847 848 849
let byteTest = new ByteArray(5)
console.log(byteTest)
```



杜庆泉's avatar
杜庆泉 已提交
850
### 编译报错:unresolved reference R (R资源无法识别)
D
DCloud_LXH 已提交
851 852 853 854 855 856 857 858 859 860

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
杜庆泉 已提交
861
```ts
D
DCloud_LXH 已提交
862 863 864 865
import R from 'io.dcloud.uni_modules.uts_nativepage.R';
```


taohebin@dcloud.io's avatar
taohebin@dcloud.io 已提交
866
### 6.4  如何实现一个接口
D
DCloud_LXH 已提交
867 868

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

 ```ts
D
DCloud_LXH 已提交
871 872 873 874 875 876 877
import OnClickListener from 'android.view.View.OnClickListener';
// 实现 OnClickListener 接口
class User {
	name:string = "name"
}

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

D
DCloud_LXH 已提交
879
    override onClick(v?: View):void{
D
DCloud_LXH 已提交
880

D
DCloud_LXH 已提交
881 882 883 884 885
		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 已提交
886

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

D
DCloud_LXH 已提交
890 891 892 893 894 895 896 897 898 899 900
    }
}


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

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

杜庆泉's avatar
杜庆泉 已提交
901
```ts
D
DCloud_LXH 已提交
902 903 904 905 906
class Person{
	name:string = ""
}
class User extends Person implements android.view.View.OnClickListener,Cloneable{
	constructor(){
D
DCloud_LXH 已提交
907

D
DCloud_LXH 已提交
908
	}
D
DCloud_LXH 已提交
909

D
DCloud_LXH 已提交
910 911 912
	override onClick(v?: android.view.View):void{
		console.log(v)
	}
D
DCloud_LXH 已提交
913

D
DCloud_LXH 已提交
914 915 916 917 918 919 920 921 922
	override equals(other?: any):boolean{
		return true
	}
}

```

编译后的kotlin代码

杜庆泉's avatar
杜庆泉 已提交
923
```kotlin
D
DCloud_LXH 已提交
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
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;
    }
}
```

其中需要注意的是

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

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

杜庆泉's avatar
杜庆泉 已提交
944
```ts
杜庆泉's avatar
杜庆泉 已提交
945 946 947 948 949
ScancodeConfig.setShowLine(false);
```

应该使用属性访问:

杜庆泉's avatar
杜庆泉 已提交
950
```ts
杜庆泉's avatar
杜庆泉 已提交
951 952
ScancodeConfig.showLine = false;
```
D
DCloud_LXH 已提交
953

taohebin@dcloud.io's avatar
taohebin@dcloud.io 已提交
954
### 6.5 Android原生API过时警告处理
taohebin@dcloud.io's avatar
taohebin@dcloud.io 已提交
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970

调用原生过时的API插件编译时产生警告,可以使用`@Suppress("DEPRECATION")`添加注解到使用的方法上忽略警告,例:
```js
@Suppress("DEPRECATION")
function getAppName(context : Context) : string {
	let appName = ""
	try {
		const packageManager = context.getPackageManager()
		const applicationInfo = packageManager.getApplicationInfo(context.getPackageName(), 0)
		appName = packageManager.getApplicationLabel(applicationInfo) as string
	} catch (e : Exception) {
		e.printStackTrace()
	}
	return appName
}
```
D
DCloud_LXH 已提交
971

972
### 6.6 泛型传递丢失的问题 @lost-generics
杜庆泉's avatar
杜庆泉 已提交
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

如果在UTS中声明一个包含泛型声明的方法,可能会出现泛型丢失,原因是因为普通的kotlin 方法没有实现泛型的传递

错误的kt代码:

```kotlin
fun <T> getArtListByres(): A<T>? {
   var aRet = UTSAndroid.consoleDebugError(JSON.parse<A<T>>("{\"x\":111,\"y\":\"aaa\",\"t\":{\"name\":\"zhangsan\"}}"), " at pages/index/index.uvue:27");
   return aRet;
}
```

期望得到的正确的kt代码:

```ts
inline fun <reified T> getArtListByres(): A<T>? {
    var aRet = UTSAndroid.consoleDebugError(JSON.parse<A<T>>("{\"x\":111,\"y\":\"aaa\",\"t\":{\"name\":\"zhangsan\"}}"), " at pages/index/index.uvue:27");
    return aRet;
}
```

为了解决这种情况,我们可以在UTS中 添加android方法注解,来告诉编译器生成正确的代码:

```kotlin
@UTSAndroid.keyword("inline")
@UTSAndroid.keyword('reified')
export function request<T>(options : RequestOptions<T>) : RequestTask {
	//xxx
}
```

杜庆泉's avatar
杜庆泉 已提交
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
### 6.7 获取原生Class 对象

可以使用下面的代码获取指定class对象
```kotlin
// 根据 类名 获取 class
let getClassByName = Class.forName("io.dcloud.uts.UTSJSONObject")
console.log(getClassByName);
// 根据 实例 获取 class
let getClassByInstance = UTSAndroid.getJavaClass(UTSAndroid.getUniActivity()!)
console.log(getClassByInstance);
```
D
DCloud_LXH 已提交
1015 1016 1017

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

杜庆泉's avatar
杜庆泉 已提交
1018
### 结构入参 boolean 参数默认为true
D
DCloud_LXH 已提交
1019 1020 1021 1022

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


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

比如xml布局文件中暂时只支持 linearlayout等官方标签,不支持 appcompat等三方库标签。这个问题后续会被处理
杜庆泉's avatar
杜庆泉 已提交
1026 1027 1028 1029 1030

### 不支持直接添加so文件到插件目录

截止HBuilder X 4.19 :

杜庆泉's avatar
杜庆泉 已提交
1031
UTS插件本地调试尚不支持直接使用so文件,需要将so文件和调用代码封装为AAR 或者分别集成 so和jar文件
杜庆泉's avatar
杜庆泉 已提交
1032

杜庆泉's avatar
杜庆泉 已提交
1033
AAR调用示例参考:[hello uts](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules/uts-toast)