> HBuilderX 3.6+ 支持uts插件 ## 1 uts插件介绍 ### 什么是uts uts,全称 uni type script,是一门跨平台的、高性能的、强类型的现代编程语言。 它可以被编译为不同平台的编程语言,如: - web平台,编译为JavaScript - Android平台,编译为Kotlin - iOS平台,编译Swift(暂未发布) uts 采用了与 ts 基本一致的语法规范,支持绝大部分 ES6 API。 如需详细了解uts语法,另见[uts语法介绍](../tutorial/syntax-uts.md) ### 什么是uts插件 现有的uni-app,仍以js引擎为主。但从HBuilderX 3.6开始,uni-app支持uts插件。 也就是uts的第一步不是完整开发一个独立的app,而是作为uni-app的插件。后续uts会持续迭代,达到完整开发app的水平。 uts插件编译到app平台时,在功能上相当于uni-app之前的app原生插件,也就是kotlin和swift开发的插件。 开发uts插件不需要熟悉kotlin和swift的语法,因为使用的是基于ts的语法。但需要熟悉Android和iOS的系统API,否则无法调用原生能力。 ![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原生语言插件的区别 在HBuilderX 3.6以前,uni-app在App侧只有一种原生插件,即用java或object-c开发的插件。 在uts推出后,原来的“App原生插件”,更名为“App原生语言插件”。 不同的名字,代表它们需要开发者编写语言不同。但殊途同归,最后都编译为原生的二进制代码。 |- |原生语言插件 |uts插件 | |- |------- |-------- | |开发语言 |java/oc |uts | |开发环境 |Android studio/XCode |HBuilderX | |打包方式 |外挂aar 等产出物 |编译时生成原生代码 | |js层调用方式 |uni.requireNativePlugin() |普通的js函数/对象,可以直接import| 相当于原生语言插件,uts插件的优势: 1. 统一了编程语言(uts),一种语言开发所有平台,真正大前端。 2. 统一了开发工具(HBuilderX),免除搭建复杂的原生开发环境。 3. 插件封装中要理解的概念更少。 传统原生语言插件需要在js和原生层处理通信,使用各种特殊转换,使用特殊语法导入,注意事项很多。**uts统一为纯前端概念,简单清晰。** 4. uts下前端和原生可以统一在HBuilderX中联调。而传统原生语言插件需要在多个开发工具间切换,联调复杂。 ## 2 创建uts插件 ### uts插件目录结构 在uni-app的项目工程下,提供了独立的目录`utssdk`,来存放uts插件。 当然官方更推荐使用[uni_modules](uni_modules.md)方式,这是更好的包管理方案。 首先确保项目根目录存在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": { } } ``` package.json的完整文档[详见](uni_modules.md#package.json) ### 插件的目录结构
	
┌─utssdk
│	├─app-android //Android平台目录
│	│ └─index.uts
│	│ └─config.json //Android原生配置
│	├─app-ios //ios平台目录
│	│ └─index.uts
│	│ └─config.json //ios原生配置
│	├─web //web平台目录
│	│ └─index.uts
│	└─mp-xxx  // 其他平台,待实现
├─common // 可跨端公用的uts代码。推荐,不强制
├─static // 静态资源
├─package.json
├─index.d.ts  // 插件能力声明,非必需
└─index.uts   // 插件能力实现


index.uts文件是程序主入口。如果插件根目录下没有index.uts,则会在编译到不同平台时,寻找分平台的目录下的index.uts文件。 比如编译到app-android平台时,如果uts插件根目录没有index.uts,会寻找app-android/index.uts。如果也没有找到,会报错。 当同时存在分平台目录的index.uts和根目录index.uts时,会优先获取具体的分平台目录。 开发者有多种组织自己代码的方式: 1. 在插件根目录的index.uts中写条件编译代码。简单的业务一个文件搞定 2. 在插件根目录index.uts中写条件编译,import分平台的文件 3. 不写根目录的index.uts,直接在分平台目录写index.uts。不跨端时,比如只做一个Android插件,这样写比较简单 index.d.ts文件是对当前插件能力的**声明**,用于语法提示。它不是必写项。 因为uts写好后,HBuilderX可以自动识别uts api并进行语法提示。它更多的用于后续uts插件加密时给予语法提示。 如果不熟悉d.ts,可以自行网上搜索,它属于ts标准技术。 app-android 文件夹下存在下面两个文件 |文件名 |用途 | |--- |--- | |index.uts |index.d.ts声明的能力在Android平台下的实现 | |config.json|Android平台下的配置文件 | ### 原生层配置 app-android、app-ios目录下的config.json,是uts插件在相应平台的原生层配置文件。可以在其中配置依赖的aar包或gradle配置。 ```json { // 依赖某些aar "libs": [ "xxx.aar" ], // 依赖某些gradle配置 "dependencies": [{ "id": "com.xxx.richtext:richtext", "source": "implementation 'com.xxx.richtext:richtext:3.0.7'" }], // Android系统版本要求,最低Android 5.0 "minSdkVersion": 21 } ``` config.json只是uts插件的配置。如需要配置uni-app应用级的原生配置,需要另行在uni-app主项目中配置。 uni-app项目根目录有: - manifest.json:uni-app封装的常用的原生层配置 - AndroidManifest.xml:Android打包时的扩展配置。manifest.json中不包含的部分,可以在这里配置。如没有这个文件,可自行创建。[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android) uni-app项目根目录还支持 nativeresource 目录,下面有 android、ios 目录。其中 android 目录下可以放原生应用资源目录 res、assets。[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android) ## 3 开发uts原生插件 以android平台获取电量为例,介绍uts原生插件开发步骤 ![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"; // 引用uts环境库 import { getAppContext } from "io.dcloud.uts.android"; export function getBatteryCapacity(): string { // 获取android系统 application上下文 const context = 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%"; } ``` `io.dcloud.uts.android`库介绍文档[见下](#iodcloudutsandroid) 至此,我们已经完成一个android平台上获取电量的原生能力封装。 在下一节,将介绍插件的使用,可以像使用普通js函数一样,使用getBatteryCapacity函数来获取设备电量。 注:HBuilderX的代码提示系统,支持在uts文件中对Android的原生API进行提示。 ## 4 前端使用插件 虽然uts插件由uts语法开发,但前端引用插件并不要求一定需要ts,普通js即可引用uts插件。 下面介绍两种常见的引入方式 **泛型引用** 作为一个对象全部import进来,然后通过点运算符调用这个对象的方法或属性。 ```js // 先引用,全部导入,对象起名为UTSHello import * as UTSHello from "../../../uni_modules/uts-osapi"; // 然后使用UTSHello的方法 UTSHello.getBatteryCapacity() ``` **显性引用** 从可导出的选项里import 1个或多个(逗号分隔),然后直接使用导出的方法或属性。 ```js //先引用,导入指定方法或属性 import { getBatteryCapacity } from "../../../uni_modules/uts-osapi"; // 然后使用导入的方法 getBatteryCapacity() ``` 更多示例,可以参考 [HelloUTS](https://gitcode.net/dcloud/hello-uts)。 ## 5 真机运行 **uts虽然是原生代码,但同样具有真机运行功能。** 若HBuilderX中没有`uts编译运行插件`,在第一次运行时会自动下载。 在Android上,运行体验与uni-app基本无差异。一样可以热刷新,打印console.log。 **自定义基座**:同之前的uni-app。如果涉及微信支付等自定义manifest信息,需要选择自定义基座运行。自定义基座也支持uts插件。 截止到HBuilderX 3.6时遗留事项: - 不能debug uts源码 - iOS版还未发布 遗留事项后续升级完善。 ## 6 云端打包 正常支持云端打包。 注意:虽然uts在真机运行时支持热刷,但打包后uts编译为了纯原生二进制代码,不支持wgt热更新。 ## Android内置库@iodcloudutsandroid 在uts里,Android的所有api都可以访问。同时DCloud提供了`io.dcloud.uts.android`库,处理在uni-app下的特殊情况。 ```ts import { getAppContext } from "io.dcloud.uts.android"; ``` ### getAppContext 获取当前应用Application上下文,对应android平台上的application context ```ts fun getAppContext():Context? ``` ### getUniActivity 获取当前应用宿主activity示例,当前 uni-app 应用实例的宿主activity ```ts fun getUniActivity():Context? ``` ### getResourcePath(resourceName:String) 获取指定插件资源 的运行期绝对路径 ```ts fun getResourcePath(resourceName:String):String ``` 比如,插件A使用到了一张图片,开发期间 存放位置为`uni_modules/test-uts-static/static/logo.png` 程序运行期间,需要获取到此资源,可以使用 ```ts getResourcePath("uni_modules/test-uts-static/static/logo.png") ``` 得到文件运行时路径: `/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/__UNI__3732623/www/uni_modules/test-uts-static/static/logo.png` ### onAppActivityPause 容器的宿主activity onPause时触发 ### onAppActivityResume 容器的宿主activity onResume时触发 ### onAppActivityDestroy 容器的宿主activity onDestroy时触发 ### onAppActivityBack 容器的宿主activity 回退物理按键点击时触发 ## 常见问题 ### 常见报错 - [plugin:vite:resolve] Failed toresolve entry for package "插件路径" HBuilderX 的最低要求为3.6.0,低于此版本无法import uts插件,编译时将报错。 ### Float类型传参 android很多布局参数强制要求Float,但是ts中没有内置这种类型。可以使用下面的代码实现转换 ```ts let textSize = 30.0.toFloat(); ``` ### 泛型参数 android中UI相关的api,很多会要求泛型,目前uts支持用as关键字强转,满足类似的场景 ```ts let frameContent = decorView.findViewById(android.R.id.content) as FrameLayout ``` ## 路线图 uts是一个宏大工程,产品将分阶段发布。近期将陆续发布: 1. iOS相关功能 2. debug 3. UI操作能力 4. 插件市场支持uts插件的加密和计费销售 最终,uts不再是uni-app的插件,而是应用的主体。(现在是以js为主,uts作为插件存在,主引擎仍然在v8或jscore里) 那时,即便是最复杂的应用,比如微信,也可以使用uts来开发,毫无功能和性能的影响。 ## 示例项目 DCloud提供了 Hello UTS示例,[详见](https://gitcode.net/dcloud/hello-uts)。