UTS 在安卓系统上的开发应用

uts for Android

本文旨在帮助Android开发者，快速上手UTS。

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

#1 了解UTS插件是什么

UTS插件是uni-app新型插件形式，拥有跨平台，高效率，易调试等优点。详情(opens new window)

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

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

#2 掌握UTS语法

#2.1 对于掌握kotlin语言者

因为UTS语法与kotlin很类似，建议快速阅读后，在实践中掌握这UTS语法。uts语法介绍 (opens new window)。

#2.2 对于仅掌握java语言者

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

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

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

• kotlin https://kotlinlang.org/(opens new window)

• kotlin for android https://developer.android.com/kotlin(opens new window)

#2.3 数据类型差异

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

原则上：

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

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

---

#举例一： Int 和Number

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

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

原生开发环境中，应该这样写：

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

Copy code

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

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

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

Copy code

#举例二：MutableList

MutableList是android平台 特有的数据类型，一般场景下，可以使用UTS中内置类型 Array 替代

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

在原生环境中，应该这样写：

onAppActivityRequestPermissionsResult(fun(requestCode: Number, permissions: MutableList<String>, grantResults: MutableList<Number>){
      
});

Copy code

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

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

onAppActivityRequestPermissionsResult((requestCode: number,permissions: MutableList<string>,grantResults: MutableList<number>) => {
	
});

Copy code

#3 Android原生环境配置

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

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

注意：

• 1 本章节内的实例代码均取自Hello UTS 项目地址(opens new window)
• 2 本章节设计的配置，均需自定义基座后才能生效
• 3 截止到HX 3.6.8，还不支持R文件的自动生成，因此本章节中涉及R文件生成部分暂时还不支持。这是个遗留问题，稍后版本会支持。

#3.1 配置AndroidManifest.xml

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

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

~\uni_modules\uts-nativepage\utssdk\app-android\AndroidManifest.xml

AndroidManifest.xml示例：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" 
  // 配置包名
  package="io.dcloud.uni_modules.uts_nativepage">
   // 配置权限
   <!--创建前台服务权限-->
   <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>

Copy code

AndroidManifest.xml配置规则与android中的规则是一致的。

特别提示：

每一个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

Copy code

#3.2 配置res资源

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

~\uni_modules\uts-nativepage\utssdk\app-android\res

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

#3.3 配置asset资源

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

关键代码:

// 获取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();

Copy code

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

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

#3.4 增加libs依赖资源

以Hello UTS项目下的uts-tencentgeolocation 插件为例

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

~\uni_modules\uts-tencentgeolocation\utssdk\app-android\libs

---

HX3.6.7 版本内置了以下依赖

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

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

+--- my-imageloader.jar
+--- my-nineoldandroids-2.4.0.jar
+--- zip4j-2.8.0.jar
+--- uts-runtime-jvm-1.0.jar
+--- [email protected]
+--- 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

Copy code

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

通过上面的章节的阅读。

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

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

#4.1 语法差异

---

#4.1.1 可为空的语法标识

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

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

Copy code

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

let user:string | null

Copy code

如果是成员变量，与kotlin类似，但是区别在于?写在变量后，而非类型后

let user?:string

Copy code

#4.1.2 let和var

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

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

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

#4.1.3 方法定义

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

 fun startListener():void{
	 
 }

Copy code

uts中，需要区分全局方法、成员方法

 // 成员方法
 startListener():void{
	 
 }

Copy code

 // 全局方法
 function startListener():void{
	 
 }

Copy code

#4.1.4 extends

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

语法	kotlin	uts
继承类	:	extends
实现接口	:	extends

class MediaContentObserver : ContentObserver {
}

Copy code

class MediaContentObserver extends ContentObserver {
}

Copy code

#4.1.5 非空断言

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

user!.sayHello();

Copy code

user!!.sayHello();

Copy code

#4.1.6 快速调用父类实现

//ts 中快速实现super
constructor() : super() {
}
	

Copy code

//kotlin 中快速实现super
constructor (){
	super();
}

Copy code

#4.1.7 匿名内部类

kotlin中可以使用匿名内部类

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

Copy code

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

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

Copy code

#4.1.8 可为空函数调用

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

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

Copy code

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

options.success?.(res)

Copy code

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

---

#4.2 警告优化

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

#4.2.1 java lang包的引入问题

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

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

Copy code

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

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

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

Copy code

#4.2.2 UTS 不建议使用 快捷构造

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

// 获取当前时间戳
class ScreenReceiver extends BroadcastReceiver(){
  
}

Copy code

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

class ScreenReceiver extends BroadcastReceiver{
	
	constructor (){
		super();
	}

}

Copy code

#4.2.3 UTS 中下划线前缀的变量，有屏蔽未使用警告的含义

// IDE会提示 name,status,desc 变量未使用
onStatusUpdate(name:string, status:Int, desc:string){
	
}

// 不会警告变量未使用
onStatusUpdate(_name:string, _status:Int, _desc:string){
	
}

Copy code

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

#5.1 如何在UTS环境中，新建一个activity？

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

路径:

~\uni_modules\uts-nativepage

#5.2 如何在UTS环境中，新建一个service？

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

路径:

~\uni_modules\uts-nativepage