uts-plugin.md 25.7 KB
Newer Older
杜庆泉's avatar
杜庆泉 已提交
1 2 3
# UTS插件介绍

## 1 介绍
杜庆泉's avatar
杜庆泉 已提交
4

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
5 6
> HBuilderX 3.6+ 支持uts插件

DCloud-yyl's avatar
DCloud-yyl 已提交
7 8
UTS插件开发官方QQ交流群:527828934 [点此加入](https://qm.qq.com/cgi-bin/qm/qr?k=3Z-cQCXGiTyThkrqufUNNw7TaJd2xEPb&jump_from=webapi&authKey=4UQdplol3kPLwlDfuSdYleE8JUHnJChC2+8HcuBavZq2q51iAkLdzT4Bupt4ZJZu)

W
wanganxp 已提交
9
### 什么是uts
杜庆泉's avatar
杜庆泉 已提交
10

W
wanganxp 已提交
11
uts,全称 uni type script,是一门跨平台的、高性能的、强类型的现代编程语言。
杜庆泉's avatar
杜庆泉 已提交
12

W
wanganxp 已提交
13
它可以被编译为不同平台的编程语言,如:
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
14

W
wanganxp 已提交
15 16
- web平台,编译为JavaScript
- Android平台,编译为Kotlin
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
17
- iOS平台,编译为Swift(HX 3.6.7+ 版本支持)
18

W
wanganxp 已提交
19
uts 采用了与 ts 基本一致的语法规范,支持绝大部分 ES6 API。
20

W
wanganxp 已提交
21
如需详细了解uts语法,另见[uts语法介绍](../tutorial/syntax-uts.md)
W
wanganxp 已提交
22 23 24

### 什么是uts插件

25
现有的 uni-app,仍以js引擎为主。但从HBuilderX 3.6开始,uni-app 支持 uts 插件(3.6支持vue3编译器,3.6.8支持vue2编译器)。
W
wanganxp 已提交
26

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
27
也就是 uts 的第一步不是完整开发一个独立的 app,而是作为 uni-app 的插件。后续 uts 会持续迭代,达到完整开发 app 的水平。
W
wanganxp 已提交
28

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
29
uts 插件编译到 app 平台时,在功能上相当于 uni-app 之前的 app 原生插件,也就是 Kotlin 和 Swift 开发的插件。
W
wanganxp 已提交
30

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
31
开发 uts 插件不需要熟悉 Kotlin 和 Swift 的语法,因为使用的是基于 ts 的语法。但需要熟悉 Android 和 iOS 的系统 API,否则无法调用原生能力。
杜庆泉's avatar
杜庆泉 已提交
32 33 34

![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)

W
wanganxp 已提交
35
### uts插件与uni原生语言插件的区别
36

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
37
在 HBuilderX 3.6 以前,uni-app 在 App 侧只有一种原生插件,即用 java 或 Objective-C 开发的插件。
38

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
39
在 uts 推出后,原来的 “App原生插件”,更名为 “App原生语言插件”。
40 41

不同的名字,代表它们需要开发者编写语言不同。但殊途同归,最后都编译为原生的二进制代码。
杜庆泉's avatar
杜庆泉 已提交
42

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
43 44 45 46 47
|				|原生语言插件				|uts插件|
|:------		|:-------					|:--------|
|开发语言		|java/oc					|uts|
|开发环境		|Android Studio/XCode		|HBuilderX|
|打包方式		|外挂aar 等产出物			|编译时生成原生代码|
fxy060608's avatar
fxy060608 已提交
48
|js层调用方式	|uni.requireNativePlugin()	|普通的js函数/对象,可以直接 import,支持摇树优化|
杜庆泉's avatar
杜庆泉 已提交
49

W
wanganxp 已提交
50
相当于原生语言插件,uts插件的优势:
杜庆泉's avatar
杜庆泉 已提交
51

W
wanganxp 已提交
52
1. 统一了编程语言(uts),一种语言开发所有平台,真正大前端。
53
2. 统一了开发工具(HBuilderX),免除搭建复杂的原生开发环境。
杜庆泉's avatar
杜庆泉 已提交
54
3. 插件封装中要理解的概念更少。 传统原生语言插件需要在js和原生层处理通信,使用各种特殊转换,使用特殊语法导入,注意事项很多。**uts统一为纯前端概念,简单清晰。**
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
55 56 57
4. uts 下前端和原生可以统一在 HBuilderX 中联调。而传统原生语言插件需要在多个开发工具间切换,联调复杂。

但当前的 uts 插件的完善度还没有达到原生语言插件的水平,虽然会陆续升级解决,但明示如下:
杜庆泉's avatar
杜庆泉 已提交
58

59 60
1. uts 插件无法封装 nvue 页面组件
2. uts 插件还无法在插件市场计费销售
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
61 62 63

### uts插件和Native.js的区别

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
64 65
- [Native.js](../tutorial/native-js.md) 运行在js上,通过反射调用os api。功能和性能都不及真正的原生
- uts 在 app 上不运行在 js 引擎里,是真正的原生。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
66

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

W
wanganxp 已提交
68
## 2 创建uts插件
杜庆泉's avatar
杜庆泉 已提交
69

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
70
### uts 插件目录结构
杜庆泉's avatar
杜庆泉 已提交
71

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
72
在 uni-app 的项目工程下,提供了独立的目录 `utssdk`,来存放 uts 插件。
杜庆泉's avatar
杜庆泉 已提交
73

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
74
当然官方更推荐使用 [uni_modules](uni_modules.md) 方式,这是更好的包管理方案。
W
wanganxp 已提交
75

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
76
首先确保项目根目录存在 uni_modules 文件夹,如果不存在,需要手动创建一个。
杜庆泉's avatar
杜庆泉 已提交
77 78 79

![插件目录](https://native-res.dcloud.net.cn/images/uts/uni_modules.jpg)

W
wanganxp 已提交
80
### 新建步骤拆解
杜庆泉's avatar
杜庆泉 已提交
81

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
82
右键点击`uni_modules`目录 -> 新建插件
杜庆泉's avatar
杜庆泉 已提交
83 84 85

![新建插件1](https://native-res.dcloud.net.cn/images/uts/new_uts_plugin.jpg)

杜庆泉's avatar
杜庆泉 已提交
86
选择类型 **uts插件**
杜庆泉's avatar
杜庆泉 已提交
87

杜庆泉's avatar
杜庆泉 已提交
88
![新建插件2](https://native-res.dcloud.net.cn/images/uts/new_uts_plugin2_1.jpg)
杜庆泉's avatar
杜庆泉 已提交
89

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
90
**为了避免和插件市场的其他插件冲突,建议起一个自己的插件前缀名称。**
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
91

W
wanganxp 已提交
92
uts插件目录结构
杜庆泉's avatar
杜庆泉 已提交
93

94
![新建插件3](https://native-res.dcloud.net.cn/images/uts/new_uts_plugin3_1.jpg)
杜庆泉's avatar
杜庆泉 已提交
95 96


DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
97
### package.json
杜庆泉's avatar
杜庆泉 已提交
98

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
99
package.json 为 uni_modules 插件配置清单文件,负责描述插件的基本配置。
100

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

102
```json
杜庆泉's avatar
杜庆泉 已提交
103 104
{
  "id": "uts-helloworld",
W
wanganxp 已提交
105
  "displayName": "uts插件示例",
杜庆泉's avatar
杜庆泉 已提交
106
  "version": "0.1",
W
wanganxp 已提交
107
  "description": "uts插件示例",
杜庆泉's avatar
杜庆泉 已提交
108
  "uni_modules": {
杜庆泉's avatar
杜庆泉 已提交
109
    
杜庆泉's avatar
杜庆泉 已提交
110 111 112 113
  }
}
```

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
114
上面是一个默认的清单文件示例,关于 package.json 更多描述[详见](uni_modules.md#package.json)
杜庆泉's avatar
杜庆泉 已提交
115

W
wanganxp 已提交
116
### 插件的目录结构
117

118 119
<pre v-pre="" data-lang="">
	<code class="lang-" style="padding:0">
DCloud-yyl's avatar
DCloud-yyl 已提交
120 121 122 123 124 125 126 127 128
┌─common                          // 可跨端公用的uts代码。推荐,不强制
├─static                          // 静态资源
├─utssdk
│	├─app-android                 //Android平台目录
│	│	├─assets                  //Android原生assets资源目录,可选
│	│	├─libs                    //Android原生库目录,可选
│	│	├─res                     //Android原生res资源目录,可选
│	│	├─AndroidManifest.xml     //Android原生应用清单文件,可选
│	│	├─config.json             //Android原生配置文件
DCloud-yyl's avatar
DCloud-yyl 已提交
129 130 131 132 133
│	│	└─index.uts               //Android原生插件能力实现
│	├─app-ios                     //iOS平台目录
│	│	├─Frameworks              //iOS原生依赖的第三方 framework 依赖库存放目录,可选
│	│	├─Resources               //iOS原生所依赖的资源文件存放目录,可选
│	│	├─info.plist              //iOS原生所需要添加到主 info.plist 文件中的配置文件,可选
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
134
│	│	├─UTS.entitlements        //iOS原生所需要添加到主工程 .entitlements 文件中的配置文件,可选
DCloud-yyl's avatar
DCloud-yyl 已提交
135 136
│	│	├─config.json             //iOS原生配置文件
│	│	└─index.uts               //iOS原生插件能力实现
DCloud-yyl's avatar
DCloud-yyl 已提交
137 138
│	├─web                         //web平台目录
│	│	└─index.uts
fxy060608's avatar
fxy060608 已提交
139 140 141 142 143 144 145 146 147
│	├─mp-alipay                   // 支付宝小程序平台,可选
│	├─mp-baidu                    // 百度小程序平台,可选
│	├─mp-jd                       // 京东小程序平台(仅限vue2),可选
│	├─mp-kuaishou                 // 快手小程序平台,可选
│	├─mp-lark                     // 飞书小程序平台,可选
│	├─mp-qq                       // QQ小程序平台,可选
│	├─mp-toutiao                  // 字节跳动小程序平台,可选
│	├─mp-weixin                   // 微信小程序平台,可选
│	├─mp-xhs                      // 小红书小程序平台(仅限vue2),可选
DCloud-yyl's avatar
DCloud-yyl 已提交
148 149 150
│	├─index.d.ts                  // 插件能力声明,可选
│	└─index.uts                   // 跨平台插件能力实现,可选
└─package.json                    // 插件清单文件
151 152
</code>
</pre>
杜庆泉's avatar
杜庆泉 已提交
153 154


DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
155
根目录 index.uts 文件是程序主入口。如果插件根目录下没有 index.uts,则会在编译到不同平台时,寻找分平台的目录下的 index.uts 文件。
W
wanganxp 已提交
156

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
157
比如编译到 app-android 平台时,如果 uts 插件根目录没有 index.uts,会寻找 utssdk/app-android/index.uts。如果也没有找到,会报错。
158

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
159
当同时存在分平台目录的 index.uts 和根目录 index.uts 时,会优先获取具体的分平台目录。
160

W
wanganxp 已提交
161
开发者有多种组织自己代码的方式:
162

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
163 164 165 166 167
1. 在插件根目录的 index.uts 中写条件编译代码。简单的业务一个文件搞定
2. 在插件根目录 index.uts 中写条件编译,import 分平台的文件
3. 不写根目录的 index.uts,直接在分平台目录写 index.uts。不跨端时,比如只做一个 Android 插件,这样写比较简单

index.d.ts 文件是对当前插件能力的**声明**,用于语法提示。它不是必写项。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
168

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
169
因为 uts 写好后,HBuilderX 可以自动识别 uts api 并进行语法提示。它更多的用于后续 uts 插件加密时给予语法提示。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
170

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
171
如果不熟悉 d.ts,可以自行网上搜索,它属于 ts 标准技术。
172

DCloud-yyl's avatar
DCloud-yyl 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185
### App原生配置

#### Android平台原生配置

app-android 文件夹下存在Android平台原生配置,包括以下目录或文件

|目录名/文件名			|用途									|
|---					|---									|
|assets					|Android平台原生assets资源目录			|
|libs					|Android平台原生引用的三方jar/aar目录		|
|res					|Android平台原生res资源目录				|
|AndroidManifest.xml	|Android平台原生应用清单文件				|
|config.json			|Android平台下的配置文件					|
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
186
|index.uts				|主入口,index.d.ts声明的能力在Android平台下的实现	|
187

W
wanganxp 已提交
188

DCloud-yyl's avatar
DCloud-yyl 已提交
189 190
##### assets  
Android平台原生assets资源目录,建议只保存UTS插件内置的资源文件。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
191 192 193

除了插件下有assets目录,项目下也有。注意2者的区别。
如果需要插件使用者配置(如三方SDK的授权文件),则插件作者应该在插件文档中告诉插件使用者,配置到项目的Android原生应用资源目录,而不是配置在插件目录下。[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android)
W
wanganxp 已提交
194

DCloud-yyl's avatar
DCloud-yyl 已提交
195 196 197 198
##### libs  
Android平台原生三方库目录,支持以下类型文件:
- jar 
- aar
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
199
- so库
DCloud-yyl's avatar
DCloud-yyl 已提交
200

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
201
如果封装三方原生sdk为uni-app插件,可以将sdk的jar/aar文件放到此目录,但因为多个uts插件引用相同三方原生sdk时可能会产生冲突,所以如果sdk支持仓储,建议优先使用仓储配置,而不是直接把jar等文件放在libs目录。仓储配置参考config.json的[dependencies](#dependencies)
DCloud-yyl's avatar
DCloud-yyl 已提交
202

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
203
如果使用的三方sdk包含了so库,保存到此目录时,需按Android的abi类型分目录保存。
杜庆泉's avatar
杜庆泉 已提交
204

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
205
关于libs目录的使用,可以参考 [Hello UTS](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules)
杜庆泉's avatar
杜庆泉 已提交
206

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

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

DCloud-yyl's avatar
DCloud-yyl 已提交
209 210
##### res  
Android平台原生res资源目录,建议只保存UTS插件内置的资源文件。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
211 212

除了插件下有res目录,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android)
DCloud-yyl's avatar
DCloud-yyl 已提交
213

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
214

DCloud-yyl's avatar
DCloud-yyl 已提交
215 216
##### AndroidManifest.xml  
Android原生应用清单文件,建议只保存UTS插件内置的清单文件配置。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
217 218

除了插件下有AndroidManifest.xml,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android)
DCloud-yyl's avatar
DCloud-yyl 已提交
219 220 221

##### config.json
uts插件在Android平台的原生层配置文件,可以在其中配置依赖仓储等gradle相关内容。
杜庆泉's avatar
杜庆泉 已提交
222 223 224

```json
{
杜庆泉's avatar
杜庆泉 已提交
225
	// 使用NDK时支持的CPU类型,可选(打包时不要复制注释)
DCloud-yyl's avatar
DCloud-yyl 已提交
226
	"abis": [
227
	    "使用NDK时支持的cpu类型, 可取值armeabi-v7a|arm64-v8a|x86|x86_64"
杜庆泉's avatar
杜庆泉 已提交
228
	],
杜庆泉's avatar
杜庆泉 已提交
229
    // 依赖的仓储配置,可选,打包时会合并到原生工程的build.gradle中(打包时不要复制注释)
230 231 232 233 234 235 236
	"dependencies": [
		"androidx.core:core-ktx:1.6.0",
		{
			"id": "com.xxx.richtext:richtext",
			"source": "implementation 'com.xxx.richtext:richtext:3.0.7'"
		}
	],
杜庆泉's avatar
杜庆泉 已提交
237
    // Android系统版本要求,最低Android 5.0(打包时不要复制注释)
杜庆泉's avatar
杜庆泉 已提交
238
	"minSdkVersion": 21
W
wanganxp 已提交
239
}
杜庆泉's avatar
杜庆泉 已提交
240
```
杜庆泉's avatar
杜庆泉 已提交
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
- abis  
当插件使用了NDK开发的so库时配置,描述插件支持CPU类型。  
可取值:armeabi-v7a、arm64-v8a、x86、x86_64

<a id="dependencies"/>

- dependencies  
配置插件依赖的仓储,云端打包时会合并到Android原生工程的build.gradle的  
数组类型,数组中的项可以是字符串类型或JSON对象  
对于字符串类型项,将会作为`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'
}
```


- minSdkVersion  
W
wanganxp 已提交
266 267
插件支持的Android最低版本,整数类型,取值范围为Android API Level

杜庆泉's avatar
杜庆泉 已提交
268
默认uni-app最低支持版本为19,即Android4.4.2
269 270


杜庆泉's avatar
杜庆泉 已提交
271
**注意:**
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
272

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
273
- Android平台原生配置需提交云端打包才能生效,真机运行时需使用[自定义基座](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground)
W
wanganxp 已提交
274

杜庆泉's avatar
杜庆泉 已提交
275 276
- HBuilderX 内置了android常见的依赖:内置依赖清单 ,开发者需要注意两点:

杜庆泉's avatar
杜庆泉 已提交
277
    1 内置清单中涉及的依赖,无需手动添加,即可直接使用
杜庆泉's avatar
杜庆泉 已提交
278

杜庆泉's avatar
杜庆泉 已提交
279
    2 请勿通过 手动添加jar/aar 等方式引入相同的依赖,否则会因依赖冲突导致云打包失败。
280

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

杜庆泉's avatar
杜庆泉 已提交
282 283


DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
284 285
#### iOS 平台原生配置

DCloud-yyl's avatar
DCloud-yyl 已提交
286
app-ios 文件夹下存在iOS平台原生配置,包括以下目录或文件
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
287

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
288 289 290 291 292 293 294 295
|目录名/文件名		|用途													|
|:---				|:---													|
|Frameworks			|iOS平台插件需要引用的三方 framework 依赖库存放目录			|
|Resources			|iOS平台插件需要引用的资源文件存放目录						|
|Info.plist			|iOS平台插件需要添加到原生工程Info.plist中的配置文件			|
|UTS.entitlements	|iOS平台插件需要添加到原生工程 entitlements 文件中的配置文件		|
|config.json		|iOS平台原生工程的配置文件									|
|index.uts			|主入口,index.d.ts声明的能力在iOS平台下的实现				|
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
296 297

##### Frameworks 
DCloud-yyl's avatar
DCloud-yyl 已提交
298
iOS平台插件依赖的三方库存放目录,支持以下类型文件:
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
299

DCloud-yyl's avatar
DCloud-yyl 已提交
300 301
- framework  
- xcframework
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
302

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
303 304
注意:目前只支持静态库

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
305
##### Resources
DCloud-yyl's avatar
DCloud-yyl 已提交
306
iOS平台原生资源目录,建议只保存uts插件内置的资源文件。云端打包时会将此目录下的所有文件添加到应用 main bundle 中。  
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
307

DCloud-yyl's avatar
DCloud-yyl 已提交
308
除了插件下有Resources目录,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html#%E8%B5%84%E6%BA%90%E6%96%87%E4%BB%B6-bundle-resources)  
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
309

DCloud-yyl's avatar
DCloud-yyl 已提交
310 311
##### Info.plist
iOS平台原生 Info.plist 文件配置,云端打包时会将配置信息合并到原生工程的 Info.plist 中。
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
312

DCloud-yyl's avatar
DCloud-yyl 已提交
313
除了插件下有Info.plist,项目下也有。注意2者的区别。一般使用者的配置不放在插件下,而放在自己的项目下。项目下配置[详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6-info-plist)
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
314

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
315
示例: 添加自定义字段 TencentLBSAPIKey 和 开启后台定位
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
316 317 318 319 320 321

```xml
<?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>
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
322 323
	<key>TencentLBSAPIKey</key>
	<string>填写您申请的APIKey</string>
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
324 325 326 327 328 329 330 331
	<key>UIBackgroundModes</key>
	<array>
		<string>location</string>
	</array>
  </dict>
</plist>
```

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
##### UTS.entitlements
iOS平台原生 entitlements 文件配置,云端打包时会将配置信息合并到原生工程的 entitlements 配置文件中

插件需要开启 capabilities 中的相关服务时需要配置 UTS.entitlements 文件

示例:在 capabilities 中勾选 Access WiFi Information 项后对应的 UTS.entitlements 的配置

```xml
<?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>
```

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
350
##### config.json
DCloud-yyl's avatar
DCloud-yyl 已提交
351
uts插件在iOS平台的其它原生配置文件,可以在其中配置依赖的系统库等信息  
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

```json
{
	"frameworks": [
		"可选,依赖的系统库(系统库有.framework和.tbd和.dylib类型)" 
	],
	"deploymentTarget": "9.0",   // 可选,插件支持的最低 iOS 版本  默认:9.0"
	"validArchitectures": [    // 可选,支持的 CPU 架构类型 默认:armv7、arm64
		"arm64"    // 支持多个值,可取值:"arm64", "armv7"
	]
}
```

**注意:**

- iOS 平台 uts 原生插件需提交云端打包才能生效,真机运行时需使用[自定义基座](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground)

DCloud-yyl's avatar
DCloud-yyl 已提交
369

杜庆泉's avatar
杜庆泉 已提交
370
## 3 开发uts插件
371

杜庆泉's avatar
杜庆泉 已提交
372 373
### 3.1 获取电量插件示例

杜庆泉's avatar
杜庆泉 已提交
374
以获取电量为例,介绍`uts`插件开发步骤
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
375

杜庆泉's avatar
杜庆泉 已提交
376
**首先在 `uni_modules` 目录下新建名为 uni-getbatteryinfo 的 uts 插件**
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
377

杜庆泉's avatar
杜庆泉 已提交
378
#### Android平台
杜庆泉's avatar
杜庆泉 已提交
379

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

381
![OSAPI示例](https://native-res.dcloud.net.cn/images/uts/uts_osapi_demo_1.jpg)
杜庆泉's avatar
杜庆泉 已提交
382

DCloud-yyl's avatar
DCloud-yyl 已提交
383
在Android平台目录下,编辑index.uts,键入以下内容。
杜庆泉's avatar
杜庆泉 已提交
384 385


386
```ts
杜庆泉's avatar
杜庆泉 已提交
387 388 389 390 391
// index.uts

// 引用android api
import Context from "android.content.Context";
import BatteryManager from "android.os.BatteryManager";
392
// 引用uts环境库
杜庆泉's avatar
杜庆泉 已提交
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
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%";
}

```

W
wanganxp 已提交
412
`io.dcloud.uts.android`库介绍文档[见下](#iodcloudutsandroid)
杜庆泉's avatar
杜庆泉 已提交
413

DCloud-yyl's avatar
DCloud-yyl 已提交
414
至此,我们已经完成一个Android平台上获取电量的原生能力封装。
杜庆泉's avatar
杜庆泉 已提交
415

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
416
在下一节,将介绍前端如何使用这个插件。
417 418

注:HBuilderX的代码提示系统,支持在uts文件中对Android的原生API进行提示。
杜庆泉's avatar
杜庆泉 已提交
419

杜庆泉's avatar
杜庆泉 已提交
420 421 422

特别提示:

杜庆泉's avatar
杜庆泉 已提交
423
**有android开发经验的开发者可以参考:[Android平台uts开发指南](https://uniapp.dcloud.net.cn/plugin/uts-for-android.html)**
杜庆泉's avatar
杜庆泉 已提交
424 425


杜庆泉's avatar
杜庆泉 已提交
426
#### iOS 平台
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
427 428 429 430 431

![](https://native-res.dcloud.net.cn/images/uts/iOS/getbatteryinfo1.png)

在 iOS 平台目录下,编辑 index.uts,键入以下内容

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
432
```ts
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
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 466
// 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);
}
```

至此,我们已经完成一个 iOS 平台上获取电量的原生能力封装。
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
467

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

杜庆泉's avatar
杜庆泉 已提交
469
### 3.2 `uts`与`uni-app`环境数据交互说明
杜庆泉's avatar
杜庆泉 已提交
470 471


杜庆泉's avatar
杜庆泉 已提交
472
UTS向uni-app传值,支持下列类型:
杜庆泉's avatar
杜庆泉 已提交
473 474


杜庆泉's avatar
杜庆泉 已提交
475
1 TS基本数据类型: number,string,boolean 等
杜庆泉's avatar
杜庆泉 已提交
476 477
```ts
// 基础类型-Number
杜庆泉's avatar
杜庆泉 已提交
478
export function getPluginVersionNum(): number{
杜庆泉's avatar
杜庆泉 已提交
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 511 512 513 514
	return 120
}
// 基础类型-string
export function getPluginVersion(): string{
	return "1.2.0"
}
```

2 UTSJSONObjct 

```ts
// UTSJSONObjct 示例
export function getPluginVersion(): UTSJSONObject{
	
	var ret = {
		version: "1.2.0",
		versionNum: 120,
		pluginArray:["core","debug","network"]
	}
	return ret
}
```

3 JSONObject

```ts
// JSONObject 示例
export function getPluginVersion(): JSONObject{
	
	var retJson = new JSONObject()
	retJson["version"] = "1.2.0"
	retJson["versionNum"] = 120
	return retJson
}
```

杜庆泉's avatar
杜庆泉 已提交
515
uni-app向UTS环境传值,支持下列类型:
杜庆泉's avatar
杜庆泉 已提交
516

杜庆泉's avatar
杜庆泉 已提交
517
1 TS基本数据类型: number,string,boolean 等
杜庆泉's avatar
杜庆泉 已提交
518 519
```ts
// 基础数据类型示例
杜庆泉's avatar
杜庆泉 已提交
520
export function postUserInfo(name:string,age:number){
杜庆泉's avatar
杜庆泉 已提交
521 522 523 524 525 526 527 528 529 530
	console.log("name == " + name);
	console.log("age == " + age);
}
```

```js
// uni-app 调用代码
postUserInfo("zhangsan",12);
```

杜庆泉's avatar
杜庆泉 已提交
531 532
2 type数据类型

杜庆泉's avatar
杜庆泉 已提交
533 534
```ts
// type 数据类型示例
杜庆泉's avatar
杜庆泉 已提交
535
export function postUserInfo(name:string,age:number){
杜庆泉's avatar
杜庆泉 已提交
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
	console.log("name == " + name);
	console.log("age == " + age);
}
```

```js
// uni-app 调用代码
postUserInfo({
	name:"zhangsan",
	age:12
});
```


3 UTSJSONObjct

```ts
// UTSJSONObjct 数据类型示例
export function postUserInfo(user:UTSJSONObject){
	console.log(user);
}
```

```js
// uni-app 调用代码
postUserInfo({
	name:"zhangsan",
	age:12,
	scoreInfo:{
		"语文":100,
		"数学":80,
	}
});

```
杜庆泉's avatar
杜庆泉 已提交
571 572


W
wanganxp 已提交
573
## 4 前端使用插件
杜庆泉's avatar
杜庆泉 已提交
574

W
wanganxp 已提交
575
虽然uts插件由uts语法开发,但前端引用插件并不要求一定需要ts,普通js即可引用uts插件。
576

杜庆泉's avatar
杜庆泉 已提交
577 578
下面介绍两种常见的引入方式

579
 **泛型引用**
杜庆泉's avatar
杜庆泉 已提交
580

581 582 583 584
作为一个对象全部import进来,然后通过点运算符调用这个对象的方法或属性。

```js
// 先引用,全部导入,对象起名为UTSHello
W
wanganxp 已提交
585
import * as UTSHello from "../../../uni_modules/uts-osapi";
杜庆泉's avatar
杜庆泉 已提交
586

587 588
// 然后使用UTSHello的方法
UTSHello.getBatteryCapacity()
杜庆泉's avatar
杜庆泉 已提交
589
```
590

杜庆泉's avatar
杜庆泉 已提交
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
**特别注意**

需要特别注意的是,import UTS插件时,只能到插件的根目录,不能直接引入到最终的文件

```
// 正确的写法
import * as UTSHello from "../../../uni_modules/uts-osapi";

```
```
// 错误的写法
import * as UTSHello from "../../../uni_modules/uts-osapi/index.uts";

```


607

608
**显性引用**
609 610 611 612 613

从可导出的选项里import 1个或多个(逗号分隔),然后直接使用导出的方法或属性。

```js
//先引用,导入指定方法或属性
杜庆泉's avatar
杜庆泉 已提交
614
import {
615
  getBatteryCapacity
W
wanganxp 已提交
616
} from "../../../uni_modules/uts-osapi";
杜庆泉's avatar
杜庆泉 已提交
617

618
// 然后使用导入的方法
杜庆泉's avatar
杜庆泉 已提交
619 620 621
getBatteryCapacity()
```

杜庆泉's avatar
杜庆泉 已提交
622 623


DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
624 625 626
关于电量这个插件,插件市场已经提供好了现成的插件,除了Android,还同时支持了web和小程序,可以去下载体验。[详见](https://ext.dcloud.net.cn/plugin?id=9295)

更多开发示例,可以参考 [HelloUTS](https://gitcode.net/dcloud/hello-uts)
杜庆泉's avatar
杜庆泉 已提交
627

628
## 5 真机运行
杜庆泉's avatar
杜庆泉 已提交
629

630 631 632
### 5.1 UTS支持真机运行

**uts虽然是原生代码,但同样具有真机运行功能**
杜庆泉's avatar
杜庆泉 已提交
633

634
若HBuilderX中没有`uts编译运行插件`,在第一次运行时会自动下载。
杜庆泉's avatar
杜庆泉 已提交
635

W
wan201809 已提交
636 637
#### Android平台

W
wanganxp 已提交
638
- Android上,运行体验与uni-app基本无差异。一样可以热刷新,打印console.log。
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
639

W
wan201809 已提交
640 641 642
#### iOS平台

- HBuilderX 3.6.9以下版本,uts插件不支持热刷新,真机需提交云端打包生成[自定义基座](https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground)才能生效  
W
wan201809 已提交
643
- HBuilderX 3.6.9+,uts插件,支持本地编译和真机运行 [详情](https://uniapp.dcloud.net.cn/tutorial/run/uts-development-ios.html)
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
644

645 646
### 5.2 自定义基座

DCloud-yyl's avatar
DCloud-yyl 已提交
647
自定义基座支持uts插件。
648

DCloud-yyl's avatar
DCloud-yyl 已提交
649 650
#### Android平台  
普通uts代码可以直接使用标准基座真机运行。但与原生插件一样,涉及以下场景,需要自定义基座后方能生效:
651 652 653 654 655 656

- 1 集成三方sdk
- 2 新增资源(包括res/asset 等)

总结来说,就是所有 涉及新增依赖/gralde配置/androidManifest.xml/资源 等标准基座不具备的能力时,需要自定义基座

DCloud-yyl's avatar
DCloud-yyl 已提交
657
#### iOS平台  
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
658
uts代码暂不支持直接使用标准基座真机运行。与原生插件一样,需要自定义基座才能生效。
DCloud-yyl's avatar
DCloud-yyl 已提交
659

660 661 662

### 5.3 遗留问题

杜庆泉's avatar
杜庆泉 已提交
663
截止到HBuilderX 3.6.9 时遗留事项:
杜庆泉's avatar
杜庆泉 已提交
664
- 不能debug断点uts源码   
DCloud-yyl's avatar
DCloud-yyl 已提交
665
- iOS平台uts插件需要提交云端生成自定义基座才能真机运行,修改uts代码后需重新提交云端打包才能生效  
杜庆泉's avatar
杜庆泉 已提交
666

W
wanganxp 已提交
667
遗留事项后续升级完善。
杜庆泉's avatar
杜庆泉 已提交
668 669


DCloud-yyl's avatar
DCloud-yyl 已提交
670
## 6 云端打包
杜庆泉's avatar
杜庆泉 已提交
671

DCloud-yyl's avatar
DCloud-yyl 已提交
672
正常支持云端打包。但打包后uts编译为了纯原生二进制代码,不支持wgt热更新。  
杜庆泉's avatar
杜庆泉 已提交
673

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
674

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

676

W
wanganxp 已提交
677
## 常见问题
W
wanganxp 已提交
678

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
679
### 常见报错
fxy060608's avatar
fxy060608 已提交
680

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
681 682
- [plugin:vite:resolve] Failed toresolve entry for package "插件路径"
	HBuilderX 的最低要求为3.6.0,低于此版本无法import uts插件,编译时将报错。
fxy060608's avatar
fxy060608 已提交
683

fxy060608's avatar
fxy060608 已提交
684
- 文件查找失败:'uts插件路径'
685
    vue2项目使用 uts 插件的最低版本要求是HBuilderX 3.6.8,低于此版本,编译时将报错。
fxy060608's avatar
fxy060608 已提交
686

W
wanganxp 已提交
687 688
### Float类型传参

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
689
android很多布局参数强制要求Float,但是ts中没有内置这种类型。可以使用下面的代码实现转换
W
wanganxp 已提交
690

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
691
```ts
W
wanganxp 已提交
692 693 694
let textSize =  30.0.toFloat();
```

杜庆泉's avatar
杜庆泉 已提交
695 696 697 698 699
### 异步任务

目前UTS 还不支持使用promise执行异步任务,类似场景可以使用setTimeOut


杜庆泉's avatar
杜庆泉 已提交
700 701 702 703 704 705 706 707 708 709 710 711
### 匿名内部类

UTS目前还不支持匿名内部类的写法,在android中类似这样的场景

```kotlin
getUniActivity()!!.runOnUiThread(Runnable(){
    // do something
});
```

需要声明一个实现类,再新建实例的方式实现,代码如下

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
712
```js
杜庆泉's avatar
杜庆泉 已提交
713 714 715 716 717 718 719 720 721
class AddUIRunnable extends Runnable {
    override run():void {
		// do something
    }
};
let uiRunable = new AddUIRunnable();
getUniActivity()!.runOnUiThread(uiRunable)
```

W
wanganxp 已提交
722 723
### 泛型参数

724
android中UI相关的api,很多会要求泛型,目前uts中可以使用下面的代码实现
W
wanganxp 已提交
725

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
726
```ts
727 728
let frameContent = decorView.findViewById<FrameLayout>(android.R.id.content)
let layoutParam = new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,ViewGroup.LayoutParams.WRAP_CONTENT);
W
wanganxp 已提交
729
```
杜庆泉's avatar
杜庆泉 已提交
730

杜庆泉's avatar
杜庆泉 已提交
731 732 733 734 735 736 737 738
### 函数参数默认值

函数参数支持设置默认值,比如下面testName

```ts
function connectWifi(option: WifiConnectOption,testName :string = "zhangsan") 
```

杜庆泉's avatar
杜庆泉 已提交
739 740 741 742 743 744 745 746 747 748 749
### 访问JSON对象属性

`uts`环境中访问`JSON`对象的属性,不能用`user.age` 而要用 `user['age']`

```ts

let jsonContent = "{'username':'zhangsan','age':12}"
let jsonObj = JSON.parse(jsonContent);
console.log("jsonObj['age']  == " + jsonObj['age'] );

```
杜庆泉's avatar
杜庆泉 已提交
750

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
751 752 753
## 路线图

uts是一个宏大工程,产品将分阶段发布。近期将陆续发布:
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
754 755 756 757
1. 原生插件的组件
2. ide debug
3. 插件市场支持uts插件的加密和计费销售
4. uvue页面,纯原生的视图组件构成的页面
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
758 759 760 761 762

最终,uts不再是uni-app的插件,而是应用的主体。(现在是以js为主,uts作为插件存在,主引擎仍然在v8或jscore里)

那时,即便是最复杂的应用,比如微信,也可以使用uts来开发,毫无功能和性能的影响。

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

W
wanganxp 已提交
764
## 示例项目
杜庆泉's avatar
杜庆泉 已提交
765

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
766
DCloud提供了 Hello UTS示例,[详见](https://gitcode.net/dcloud/hello-uts)
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
767

W
wanganxp 已提交
768 769 770 771
插件市场提供了很多uts项目:
- 电量获取封装插件,[详见](https://ext.dcloud.net.cn/plugin?id=9295)
- 截屏监听插件,[详见](https://ext.dcloud.net.cn/plugin?id=9897)

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
772
更多uts插件见:[https://ext.dcloud.net.cn/?cat1=8&type=UpdatedDate](https://ext.dcloud.net.cn/?cat1=8&type=UpdatedDate)