

简体中文
HBuilderX 3.6+ 支持uts插件
UTS插件开发官方QQ交流群:527828934 点此加入
uts,全称 uni type script,统一、强类型、脚本语言。
它可以被编译为不同平台的编程语言,如:
uts 采用了与 ts 基本一致的语法规范,支持绝大部分 ES6 API。
如需详细了解uts语法,另见uts语法介绍
现有的 uni-app,仍以js引擎为主。但从HBuilderX 3.6开始,uni-app 支持 uts 插件(3.6支持vue3编译器,3.6.8支持vue2编译器)。
也就是 uts 的第一步不是完整开发一个独立的 app,而是作为 uni-app 的插件。后续 uts 会持续迭代,达到完整开发 app 的水平。
uts 插件编译到 app 平台时,在功能上相当于 uni-app 之前的 app 原生插件,也就是 Kotlin 和 Swift 开发的插件。
开发 uts 插件不需要熟悉 Kotlin 和 Swift 的语法,因为使用的是基于 ts 的语法。但需要熟悉 Android 和 iOS 的系统 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,支持摇树优化 |
相对原生语言插件,uts插件的优势:
如果您是插件作者,可以了解更多uts插件和uni原生语言插件对插件作者的区别。详见
在 uni-app 的项目工程下,提供了独立的目录 utssdk
,来存放 uts 插件。
当然官方更推荐使用 uni_modules 方式,这是更好的包管理方案。
首先确保项目根目录存在 uni_modules 文件夹,如果不存在,需要手动创建一个。
右键点击uni_modules
目录 -> 新建插件
选择类型 uts插件
为了避免和插件市场的其他插件冲突,建议起一个自己的插件前缀名称。
uts插件目录结构
package.json 为 uni_modules 插件配置清单文件,负责描述插件的基本配置。
{
"id": "uts-helloworld",
"displayName": "uts插件示例",
"version": "0.1",
"description": "uts插件示例",
"uni_modules": {
}
}
上面是一个默认的清单文件示例,关于 package.json 更多描述详见
┌─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 // 插件能力声明,可选
│ └─index.uts // 跨平台插件能力实现,可选
└─package.json // 插件清单文件
根目录 index.uts 文件是程序主入口。如果插件根目录下没有 index.uts,则会在编译到不同平台时,寻找分平台的目录下的 index.uts 文件。
比如编译到 app-android 平台时,如果 uts 插件根目录没有 index.uts,会寻找 utssdk/app-android/index.uts。如果也没有找到,会报错。
当同时存在分平台目录的 index.uts 和根目录 index.uts 时,会优先获取具体的分平台目录。
开发者有多种组织自己代码的方式:
index.d.ts 文件是对当前插件能力的声明,用于语法提示。它不是必写项。
因为 uts 写好后,HBuilderX 可以自动识别 uts api 并进行语法提示。它更多的用于后续 uts 插件加密时给予语法提示。
如果不熟悉 d.ts,可以自行网上搜索,它属于 ts 标准技术。
app-android 文件夹下存在Android平台原生配置,包括以下目录或文件
目录名/文件名 | 用途 |
---|---|
assets | Android平台原生assets资源目录 |
libs | Android平台原生引用的三方jar/aar目录 |
res | Android平台原生res资源目录 |
AndroidManifest.xml | Android平台原生应用清单文件 |
config.json | Android平台下的配置文件 |
index.uts | 主入口,index.d.ts声明的能力在Android平台下的实现 |
Android平台原生assets资源目录,建议只保存UTS插件内置的资源文件。
除了插件下有assets目录,项目下也有。注意2者的区别。 如果需要插件使用者配置(如三方SDK的授权文件),则插件作者应该在插件文档中告诉插件使用者,配置到项目的Android原生应用资源目录,而不是配置在插件目录下。详见
Android平台原生三方库目录,支持以下类型文件:
如果封装三方原生sdk为uni-app插件,可以将sdk的jar/aar文件放到此目录,但因为多个uts插件引用相同三方原生sdk时可能会产生冲突,所以如果sdk支持仓储,建议优先使用仓储配置,而不是直接把jar等文件放在libs目录。仓储配置参考config.json的dependencies。
如果使用的三方sdk包含了so库,保存到此目录时,需按Android的abi类型分目录保存。
关于libs目录的使用,可以参考 Hello UTS
Android平台原生res资源目录,建议只保存UTS插件内置的资源文件。
除了插件下有res目录,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置详见
Android原生应用清单文件,建议只保存UTS插件内置的清单文件配置。
除了插件下有AndroidManifest.xml,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置详见
uts插件在Android平台的原生层配置文件,可以在其中配置依赖仓储等gradle相关内容。
{
// 使用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"
]
}
}
implementation
方式依赖添加到build.gradle中,上面示例中"androidx.core:core-ktx:1.6.0"将会添加以下配置dependencies {
implementation 'androidx.core:core-ktx:1.6.0'
}
对于JSON类型项,将会把source字段值作为gradle源码添加到build.gradle中,上面示例中"id": "com.xxx.richtext:richtext"项将会添加以下配置
dependencies {
implementation 'com.xxx.richtext:richtext:3.0.7'
}
默认uni-app最低支持版本为19,即Android4.4.2
plugins {
id 'com.android.application'
// 前面config.json示例配置将会添加如下配置
id 'com.huawei.agconnect'
}
+ dependencies
此配置将会添加到云端打包工程项目级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"
}
}
注意:
Android平台原生配置需提交云端打包才能生效,真机运行时需使用自定义基座
HBuilderX 内置了android常见的依赖:内置依赖清单 ,开发者需要注意两点:
1 内置清单中涉及的依赖,无需手动添加,即可直接使用
2 请勿通过 手动添加jar/aar 等方式引入相同的依赖,否则会因依赖冲突导致云打包失败。
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 | 主入口,index.d.ts声明的能力在iOS平台下的实现 |
iOS平台插件依赖的三方framework存放目录,支持以下类型文件:
注意:目前支持静态库和动态库
HBuilder X 3.7.2+ 版本支持
iOS平台插件依赖的三方.a库存放目录,支持以下类型的.a库:
备注:有关OC及Swift创建的.a库的区别、.a库的使用方法和注意事项详见
iOS平台原生资源目录,建议只保存uts插件内置的资源文件。云端打包时会将此目录下的所有文件添加到应用 main bundle 中。
除了插件下有Resources目录,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置详见
iOS平台原生 Info.plist 文件配置,云端打包时会将配置信息合并到原生工程的 Info.plist 中。
除了插件下有Info.plist,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置详见
示例: 添加自定义字段 TencentLBSAPIKey 和 开启后台定位
<?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>
iOS平台原生 entitlements 文件配置,云端打包时会将配置信息合并到原生工程的 entitlements 配置文件中
插件需要开启 capabilities 中的相关服务时需要配置 UTS.entitlements 文件
示例:在 capabilities 中勾选 Access WiFi Information 项后对应的 UTS.entitlements 的配置
<?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>
uts插件在iOS平台的其它原生配置文件,可以在其中配置依赖的系统库等信息
{
"frameworks": [
"可选,依赖的系统库(系统库有.framework和.tbd和.dylib类型)"
],
"deploymentTarget": "9.0", // 可选,插件支持的最低 iOS 版本 默认:9.0"
"validArchitectures": [ // 可选,支持的 CPU 架构类型 默认:arm64
"arm64"
],
"dependencies-pods": [ // 可选, 需要依赖的pod库, HBuilderX 3.8.5+ 版本支持
{
"name": "WechatOpenSDK",
"version": "2.0.2"
}]
}
配置说明:
以获取电量为例,介绍uts
插件开发步骤
首先在 uni_modules
目录下新建名为 uts-getbatteryinfo 的 uts 插件
在Android平台目录下,编辑index.uts,键入以下内容。
// 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页面中这样使用它:
import { getBatteryCapacity } from "@/uni_modules/uts-getbatteryinfo";
console.log(getBatteryCapacity())
有些场景下,我们期望 将获取电量的能力封装为 异步的接口,我们可以使用下面的代码
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)
}
}
对应的使用代码需要调整为:
import {getBatteryInfo} from "@/uni_modules/uts-getbatteryinfo";
getBatteryInfo({
success(res) {
uni.showToast({
title: "当前电量:" + res.level + '%',
icon: 'none'
});
}
})
在下一节,我们将更加详细地介绍 前端如何使用这个插件。
注1:HBuilderX的代码提示系统,支持在uts文件中对Android的原生API进行提示
注2:io.dcloud.uts.android
库介绍文档见下
特别提示:
有android开发经验的开发者可以参考:Android平台uts开发指南
在 iOS 平台目录下,编辑 index.uts,键入以下内容
// index.uts
// 引用 iOS 原生平台 api
import { UIDevice } from "UIKit";
/**
* 定义 接口参数
*/
type GetBatteryInfoOptions = {
success?: (res: UTSJSONObject) => void;
fail?: (res: UTSJSONObject) => void;
complete?: (res: UTSJSONObject) => void;
};
/**
* 导出 获取电量方法
*/
export default function getBatteryInfo(options: GetBatteryInfoOptions) {
// 开启电量检测
UIDevice.current.isBatteryMonitoringEnabled = true
// 返回数据
const res = {
errMsg: "getBatteryInfo:ok",
level: Number(UIDevice.current.batteryLevel * 100),
isCharging: UIDevice.current.batteryState == UIDevice.BatteryState.charging,
};
options.success?.(res);
options.complete?.(res);
}
如果你想以同步接口的方式提供电量信息,代码可调整如下:
// index.uts
// 引用 iOS 原生平台 api
import { UIDevice } from "UIKit";
/**
* 导出 获取电量方法
*/
export default function getBatteryLevel():number {
// 开启电量检测
UIDevice.current.isBatteryMonitoringEnabled = true
let level = Number(UIDevice.current.batteryLevel * 100)
return level
}
至此,我们已经完成一个 iOS 平台上获取电量的原生能力封装。
uts
与uni-app
环境数据交互说明UTS向uni-app传值,支持下列类型:
// 基础类型-Number
export function getPluginVersionNum(): number{
return 120
}
// 基础类型-string
export function getPluginVersion(): string{
return "1.2.0"
}
// UTSJSONObjct 示例
export function getPluginVersion(): UTSJSONObject{
var ret = {
version: "1.2.0",
versionNum: 120,
pluginArray:["core","debug","network"]
}
return ret
}
uni-app向UTS环境传值,支持下列类型:
1 TS基本数据类型: number,string,boolean 等
// 基础数据类型示例
export function postUserInfo(name:string,age:number){
console.log("name == " + name);
console.log("age == " + age);
}
// uni-app 调用代码
postUserInfo("zhangsan",12);
2 type数据类型
// type 数据类型示例
export function postUserInfo(name:string,age:number){
console.log("name == " + name);
console.log("age == " + age);
}
// uni-app 调用代码
postUserInfo({
name:"zhangsan",
age:12
});
3 UTSJSONObjct
// UTSJSONObjct 数据类型示例
export function postUserInfo(user:UTSJSONObject){
console.log(user);
}
// uni-app 调用代码
postUserInfo({
name:"zhangsan",
age:12,
scoreInfo:{
"语文":100,
"数学":80,
}
});
更多UTSJSONObject的用法,详见
遗留问题:
有些场景,我们需要参数对象包含对象数组,比如
{
"name": "zhangsan",
"teacher": [{
"id": "1",
"name": "kongzi"
},
{
"id": "2",
"name": "mengzi"
}
]
}
目前在uni-app 1.0 环境下,复杂参数的传递是存在一定的缺陷。我们不能将teacher 声明为具体的类型数组,需要声明为any数组:
type Param{
name:string,
// 不能声明为 Teacher[]
teacher: any[];
}
访问数组元素时,通过 UTSJSONObjct 包装访问
// 循环遍历
list1.forEach((item : any) => {
const utsItem = new UTSJSONObject(item)
})
这个问题,我们稍后会改进。
虽然uts插件由uts语法开发,但前端引用插件并不要求一定需要ts,普通js即可引用uts插件。
下面介绍两种常见的引入方式
泛型引用
在uni-app x上需3.91+
作为一个对象全部import进来,然后通过点运算符调用这个对象的方法或属性。
// 先引用,全部导入,对象起名为UTSHello
import * as UTSHello from "../../../uni_modules/uts-osapi";
// 然后使用UTSHello的方法
UTSHello.getBatteryCapacity()
特别注意
需要特别注意的是,import UTS插件时,只能到插件的根目录,不能直接引入到最终的文件
// 正确的写法
import * as UTSHello from "../../../uni_modules/uts-osapi";
// 错误的写法
import * as UTSHello from "../../../uni_modules/uts-osapi/index.uts";
显性引用
从可导出的选项里import 1个或多个(逗号分隔),然后直接使用导出的方法或属性。
//先引用,导入指定方法或属性
import {
getBatteryCapacity
} from "../../../uni_modules/uts-osapi";
// 然后使用导入的方法
getBatteryCapacity()
关于电量这个插件,插件市场已经提供好了现成的插件,除了Android,还同时支持了web和小程序,可以去下载体验。详见
更多开发示例,可以参考 HelloUTS。
uts虽然是原生代码,但同样具有真机运行功能
若HBuilderX中没有uts编译运行插件
,在第一次运行时会自动下载。
自定义基座支持uts插件。
普通uts代码可以直接使用标准基座真机运行。但与原生插件一样,涉及以下场景,需要自定义基座后方能生效:
总结来说,就是所有 涉及新增依赖/gralde配置/androidManifest.xml/资源 等标准基座不具备的能力时,需要自定义基座
uts插件编译需要XCode环境,因此在mac电脑安装了XCode工具时支持直接使用标准基座真机运行。
在windows电脑或者mac电脑没有安装XCode工具时,需要提交云端打包生成自定义基座后才能调用uts插件。
uts插件支持debug断点调试。
截止到HBuilderX 3.6.9 时遗留事项:
遗留事项后续升级完善。
正常支持云端打包。但打包后uts编译为了纯原生二进制代码,不支持wgt热更新。
[plugin:vite:resolve] Failed toresolve entry for package "插件路径"
HBuilderX 的最低要求为3.6.0,低于此版本无法import uts插件,编译时将报错。
文件查找失败:'uts插件路径'
vue2项目使用 uts 插件的最低版本要求是HBuilderX 3.6.8,低于此版本,编译时将报错。 <!--
UTSCallback 已过时
HBuilderX 3.7.7开始,不再支持直接使用 UTSCallback 定义函数类型,当需要定义函数类型时,应定义为更具体的类型,如:const callback:UTSCallback
应调整为const callback:()=>void
如果您使用的是插件市场三方uts插件,可以检查更新插件最新版本
-->
android很多布局参数强制要求Float,但是ts中没有内置这种类型。可以使用下面的代码实现转换
let textSize = 30.0.toFloat();
let longVal = 1000.0.toLong()
目前 UTS 仅Android支持promise执行异步任务,iOS还不支持。类似场景可以使用setTimeOut。
UTS目前还不支持匿名内部类的写法,在android中类似这样的场景
getUniActivity()!!.runOnUiThread(Runnable(){
// do something
});
需要声明一个实现类,再新建实例的方式实现,代码如下
class AddUIRunnable extends Runnable {
override run():void {
// do something
}
};
let uiRunable = new AddUIRunnable();
getUniActivity()!.runOnUiThread(uiRunable)
android中UI相关的api,很多会要求泛型,目前uts中可以使用下面的代码实现
let frameContent = decorView.findViewById<FrameLayout>(android.R.id.content)
let layoutParam = new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,ViewGroup.LayoutParams.WRAP_CONTENT);
函数参数支持设置默认值,比如下面testName
function connectWifi(option: WifiConnectOption,testName :string = "zhangsan")
uts
环境中访问JSON
对象的属性,不能用user.age
而要用下标 user['age']
let jsonContent = "{'username':'zhangsan','age':12}"
let jsonObj = JSON.parse(jsonContent);
console.log("jsonObj['age'] == " + jsonObj['age'] );
如果想使用.操作符
,需要参考uts的type
更多UTSJSONObject的用法,详见
uts是一个宏大工程,产品将分阶段发布。近期将陆续发布:
最终,uts不再是uni-app的插件,而是应用的主体。(现在是以js为主,uts作为插件存在,主引擎仍然在v8或jscore里)
那时,即便是最复杂的应用,比如微信,也可以使用uts来开发,毫无功能和性能的影响。
DCloud提供了 Hello UTS示例,详见。
插件市场提供了很多uts项目: