uts-component.md 29.5 KB
Newer Older
杜庆泉's avatar
杜庆泉 已提交
1 2
# UTS 组件开发

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
3
> 需HBuilderX 3.6.18 及之后版本
杜庆泉's avatar
杜庆泉 已提交
4

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
5
> app平台目前仅支持nvue
杜庆泉's avatar
杜庆泉 已提交
6

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
7
UTS组件,是UTS插件的一个分支。UTS插件提供了原生API的扩展,而UTS组件提供了原生UI组件的开发模式。
杜庆泉's avatar
杜庆泉 已提交
8

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
9
组件是一种独立,可复用的UI单元,用于单独封装和承担一定的代码逻辑。
杜庆泉's avatar
杜庆泉 已提交
10

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
11
组件与插件的区别在于:前者以标签的形式,对外提供UI封装;后者则只提供API,虽然API可能涉及UI,但仍然是API,无法以标签方式在页面模板中引用。
杜庆泉's avatar
杜庆泉 已提交
12

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
13
比如`<video>`是组件;`uni.showModal``uni.chooseVideo` 虽然有UI,但属于API。
杜庆泉's avatar
杜庆泉 已提交
14

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
15
组件一般适用于封装非全屏的场景,即在页面中内嵌一个区域。如果需要你需要封装的UI是全屏界面,那没必要使用组件,通过UTS开发原生页面更简单。 [UTS开发原生页面示例](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules/uts-nativepage)
杜庆泉's avatar
杜庆泉 已提交
16

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
17
当然UTS组件是多端的,一个UTS组件作为一个`uni_modules`,可同时支持app-Android、app-iOS、web、以及各家小程序组件。
杜庆泉's avatar
杜庆泉 已提交
18

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
19
本文重点在于讲述如何在app-android和app-ios上,将一个原生UI封装为UTS组件,供使用者在页面template中以组件的方式调用。
杜庆泉's avatar
杜庆泉 已提交
20

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
21
## 前置条件
杜庆泉's avatar
杜庆泉 已提交
22

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
23
继续阅读文档前,开发者需要了解以下前置条件:
杜庆泉's avatar
杜庆泉 已提交
24

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
25 26
- 了解 [uts语法](../tutorial/syntax-uts.md)[uts原生插件](uts-plugin.md)
- 了解 [Vue组件](../tutorial/vue3-components.md)
杜庆泉's avatar
杜庆泉 已提交
27

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

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
29 30
## UTS组件简介

杜庆泉's avatar
杜庆泉 已提交
31
#### 为什么使用UTS开发组件
杜庆泉's avatar
杜庆泉 已提交
32

杜庆泉's avatar
杜庆泉 已提交
33
UTS组件,即:使用UTS语言在uni平台进行组件开发的技术。
杜庆泉's avatar
杜庆泉 已提交
34

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
35
UTS组件的优势在于,它秉承了UTS的跨平台特性,统一的UTS语法,各终端不同的原生产出物。
杜庆泉's avatar
杜庆泉 已提交
36

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
37
在Android平台会被编译渲染为Android原生View实例,IOS或其他终端平台也是如此。
杜庆泉's avatar
杜庆泉 已提交
38

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

杜庆泉's avatar
杜庆泉 已提交
40 41 42
|				|uts组件					|uni原生组件				|Vue组件				|
|:------		|:--------				|:-------- 				|:-------			|
|开发语言		|uts					|java/object-c			|js/ts				|
DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
43
|组件载体		|App平台为系统原生View对象		|系统原生View对象		|WebView内部标签		|
杜庆泉's avatar
杜庆泉 已提交
44 45


DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
46
为了统一开发规范、降低使用门槛,UTS原生组件采用了Vue组件的语法,但会根据实际情况略有定制。
杜庆泉's avatar
杜庆泉 已提交
47

DCloud_Heavensoft's avatar
DCloud_Heavensoft 已提交
48
即,您可以像写vue组件一样,使用uts语言来写一个UTS组件。
杜庆泉's avatar
杜庆泉 已提交
49

杜庆泉's avatar
杜庆泉 已提交
50
## UTS组件结构解析
杜庆泉's avatar
杜庆泉 已提交
51 52


杜庆泉's avatar
杜庆泉 已提交
53
#### UTS组件目录结构
杜庆泉's avatar
杜庆泉 已提交
54 55


杜庆泉's avatar
杜庆泉 已提交
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
<pre v-pre="" data-lang="">
	<code class="lang-" style="padding:0">
┌─common                          // 可跨端公用的uts代码。推荐,不强制
├─static                          // 静态资源
├─utssdk
│	├─app-android                 //Android平台目录
│	│	├─assets                  //Android原生assets资源目录,可选
│	│	├─libs                    //Android原生库目录,可选
│	│	├─res                     //Android原生res资源目录,可选
│	│	├─AndroidManifest.xml     //Android原生应用清单文件,可选
│	│	├─config.json             //Android原生配置文件
│	│	├─index.uts               //Android原生插件能力实现,可选
|	|	└─index.vue               //Android原生组件能力实现,必选
│	├─app-ios                     //iOS平台目录
│	│	├─Frameworks              //iOS原生依赖的第三方 framework 依赖库存放目录,可选
│	│	├─Resources               //iOS原生所依赖的资源文件存放目录,可选
│	│	├─info.plist              //iOS原生所需要添加到主 info.plist 文件中的配置文件,可选
│	│	├─UTS.entitlements        //iOS原生所需要添加到主工程 .entitlements 文件中的配置文件,可选
│	│	├─config.json             //iOS原生配置文件
│	│	├─index.uts               //iOS原生插件能力实现,可选
|	|	└─index.vue               //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.uts                   // 跨平台插件能力实现,可选
└─package.json                    // 插件清单文件
</code>
</pre>


杜庆泉's avatar
杜庆泉 已提交
94
如上所示,UTS组件的目录结构与UTS插件基本相同
杜庆泉's avatar
杜庆泉 已提交
95

杜庆泉's avatar
杜庆泉 已提交
96 97 98 99 100 101
唯一的差别在于,UTS组件入口文件有两个:

+ 必选的index.vue 组件入口

+ 可选的index.uts 函数能力入口

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

杜庆泉's avatar
杜庆泉 已提交
103
用户如果在开发组件的同时,存在一些与组件无关的能力需要对外暴露,可以在index.uts中进行实现
杜庆泉's avatar
杜庆泉 已提交
104

杜庆泉's avatar
杜庆泉 已提交
105
大多数情况下,我们只需要开发一个index.vue 即可,如果存在多个组件,可以新建多个 xxx.vue文件
杜庆泉's avatar
杜庆泉 已提交
106

杜庆泉's avatar
杜庆泉 已提交
107
关于 index.vue 源码如何编写,我们会在下一个章节介绍
杜庆泉's avatar
杜庆泉 已提交
108 109 110



杜庆泉's avatar
杜庆泉 已提交
111
#### index.vue源码结构
杜庆泉's avatar
杜庆泉 已提交
112

杜庆泉's avatar
杜庆泉 已提交
113 114 115

下面是一个组件源码 index.vue 完整示例:

fxy060608's avatar
fxy060608 已提交
116 117 118 119
**注意**

- 目前UTS组件仅支持`export default {}`的选项式API,vue3的组合式API暂未支持。

D
DCloud_LXH 已提交
120
```ts
杜庆泉's avatar
杜庆泉 已提交
121

杜庆泉's avatar
杜庆泉 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
<template>
	<view class="defaultStyles">

	</view>
</template>
<script lang="uts">
	import TextUtils from 'android.text.TextUtils'
	import Button from 'android.widget.Button'
	import LinearLayout from 'android.widget.LinearLayout'
	import Color from 'android.graphics.Color'
	import View from 'android.view.View'

	class ButtonClickListsner extends View.OnClickListener {
		constructor() {}
		override onClick(v ? : View) {
			console.log(v)
		}
	}

	//原生提供以下属性或方法的实现  
	export default {
杜庆泉's avatar
杜庆泉 已提交
143 144 145
		/**
		 * 组件名称,也就是开发者使用的标签
		 */
杜庆泉's avatar
杜庆泉 已提交
146 147 148 149 150
		name: "uts-hello-view",
		/**
		 * 组件涉及的事件声明,只有声明过的事件,才能被正常发送
		 */
		emits: ['buttonClick'],
杜庆泉's avatar
杜庆泉 已提交
151 152 153
		/**
		 * 属性声明,组件的使用者会传递这些属性值到组件
		 */
杜庆泉's avatar
杜庆泉 已提交
154 155 156 157 158 159 160 161 162
		props: {
			/**
			 * 字符串类型 属性:buttonText  需要设置默认值
			 */
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
杜庆泉's avatar
杜庆泉 已提交
163 164 165
		/**
		 * 组件内部变量声明
		 */
杜庆泉's avatar
杜庆泉 已提交
166 167 168
		data() {
			return {}
		},
杜庆泉's avatar
杜庆泉 已提交
169 170 171
		/**
		 * 属性变化监听器实现
		 */
杜庆泉's avatar
杜庆泉 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
		watch: {
			"buttonText": {
				/**
				 * 这里监听属性变化,并进行组件内部更新
				 */
				handler(newButtonText: string) {
					if (this.$el != null) {
						let button = this.$el!.findViewWithTag("centerButton") as Button
						if (!TextUtils.isEmpty(newButtonText)) {
							button.setText(newButtonText)
						}
					}
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},
		},
杜庆泉's avatar
杜庆泉 已提交
188 189 190 191
		/**
		 * 规则:如果没有配置expose,则methods中的方法均对外暴露,如果配置了expose,则以expose的配置为准向外暴露
		 * ['publicMethod'] 含义为:只有 `publicMethod` 在实例上可用
		 */
杜庆泉's avatar
杜庆泉 已提交
192 193
		expose: ['doSth'],
		methods: {
杜庆泉's avatar
杜庆泉 已提交
194 195 196
			/**
			 * 对外公开的组件方法
			 */
杜庆泉's avatar
杜庆泉 已提交
197 198 199
			doSth(paramA: string) {
				// 这是组件的自定义方法
				console.log("paramA")
杜庆泉's avatar
杜庆泉 已提交
200
			},
杜庆泉's avatar
杜庆泉 已提交
201 202 203
			/**
			 * 内部使用的组件方法
			 */
杜庆泉's avatar
杜庆泉 已提交
204
			privateMethod() {
杜庆泉's avatar
杜庆泉 已提交
205

杜庆泉's avatar
杜庆泉 已提交
206
			}
杜庆泉's avatar
杜庆泉 已提交
207 208
		},

杜庆泉's avatar
杜庆泉 已提交
209 210 211 212 213
		/**
		 * 组件被创建,组件第一个生命周期,
		 * 在内存中被占用的时候被调用,开发者可以在这里执行一些需要提前执行的初始化逻辑
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
214
		created() {
杜庆泉's avatar
杜庆泉 已提交
215

杜庆泉's avatar
杜庆泉 已提交
216
		},
杜庆泉's avatar
杜庆泉 已提交
217 218 219 220
		/**
		 * 对应平台的view载体即将被创建,对应前端beforeMount  
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
221 222 223
		NVBeforeLoad() {

		},
杜庆泉's avatar
杜庆泉 已提交
224 225 226 227 228
		/**
		 * 创建原生View,必须定义返回值类型
		 * 开发者需要重点实现这个函数,声明原生组件被创建出来的过程,以及最终生成的原生组件类型
		 * (Android需要明确知道View类型,需特殊校验) 
		 * todo 补充IOS平台限制
杜庆泉's avatar
杜庆泉 已提交
229
	  * [必须实现]
杜庆泉's avatar
杜庆泉 已提交
230
		 */
杜庆泉's avatar
杜庆泉 已提交
231 232 233 234 235 236 237 238 239 240 241
		NVLoad(): LinearLayout {
			//必须实现  
			let contentLayout = new LinearLayout($androidContext)
			let button = new Button($androidContext)
			button.setText("点击触发");
			button.setTag("centerButton");
			contentLayout.addView(button, LinearLayout.LayoutParams(500, 500));
			button.setOnClickListener(new ButtonClickListsner())
			return contentLayout
		},

杜庆泉's avatar
杜庆泉 已提交
242 243 244 245
		/**
		 * 原生View已创建 
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
246 247 248
		NVLoaded() {

		},
杜庆泉's avatar
杜庆泉 已提交
249 250 251 252
		/**
		 * 原生View布局完成  
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
253 254 255
		NVLayouted() {

		},
杜庆泉's avatar
杜庆泉 已提交
256 257 258 259
		/**
		 * 原生View将释放  
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
260
		NVBeforeUnload() {},
杜庆泉's avatar
杜庆泉 已提交
261 262 263 264
		/**
		 * 原生View已释放,这里可以做释放View之后的操作  
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
265 266 267
		NVUnloaded() {

		},
杜庆泉's avatar
杜庆泉 已提交
268 269 270 271
		/**
		 * 组件销毁  
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
272
		unmounted() {}
杜庆泉's avatar
杜庆泉 已提交
273 274 275 276
		/**
		 * 自定组件布局尺寸 
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
277
		NVMeasure(size: UTSSize): UTSSize {
杜庆泉's avatar
杜庆泉 已提交
278 279 280 281
			size.width = 120.0.toFloat()
			size.height = 800.0.toFloat()
			return size
		}
杜庆泉's avatar
杜庆泉 已提交
282 283 284 285 286 287 288 289 290 291
	}
</script>
<style>
	/* 定义默认样式值, 组件使用者没有配置时使用 */
	.defaultStyles {
		width: 750rpx;
		height: 240rpx;
		background-color: blue;
	}
</style>
杜庆泉's avatar
杜庆泉 已提交
292 293 294

```

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

杜庆泉's avatar
杜庆泉 已提交
296
index.vue 要素可以分为以下几类:
杜庆泉's avatar
杜庆泉 已提交
297

杜庆泉's avatar
杜庆泉 已提交
298
+ 配置:
杜庆泉's avatar
杜庆泉 已提交
299

杜庆泉's avatar
杜庆泉 已提交
300 301 302
	name:组件的使用标签,可以省略,若省略则默认为组件名称
	
	emits:组件允许的消息事件名称,如果没有组件消息,不需要配置
杜庆泉's avatar
杜庆泉 已提交
303

杜庆泉's avatar
杜庆泉 已提交
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
+ 属性:
	
	props:需要由组件的使用者提供,比如一个Image组件,会需要一个path属性作为图像路径来源
	
	watch:属性的监听实现,用来监听属性数据更新。
	
+ 数据:	

	data:组件内部数据定义,用于组件内部逻辑处理,不对外暴露

+ 方法:

	methods:组件方法定义,可以通过与expose组合使用,区分对内方法和对外方法
	
	expose:与methods 字段配合使用,用以区分组件对内方法和对外方法


+ 生命周期:

杜庆泉's avatar
杜庆泉 已提交
323
	组件需要重点处理 内存创建/销毁,View载体创建/销毁 过程中的资源管理,具体参考生命周期章节
杜庆泉's avatar
杜庆泉 已提交
324 325 326
	
+ 内置对象:
	
杜庆泉's avatar
杜庆泉 已提交
327
	为了方便组件开发者,UTS组件内置了部分变量与函数,具体参考内置对象与函数章节
杜庆泉's avatar
杜庆泉 已提交
328 329


杜庆泉's avatar
杜庆泉 已提交
330
#### 生命周期 
杜庆泉's avatar
杜庆泉 已提交
331

杜庆泉's avatar
杜庆泉 已提交
332
组件开发者需要重点关注组件的生命周期,以便进行资源的初始化和回收
杜庆泉's avatar
杜庆泉 已提交
333

杜庆泉's avatar
杜庆泉 已提交
334 335 336 337 338 339 340 341 342 343 344 345
```mermaid 
graph TD;
		Create-->NVBeforeLoad;
	subgraph View生命周期
		NVBeforeLoad-->NVLoad;
		NVLoad-->NVLoaded;
		NVLoaded-->NVLayouted;
		NVLayouted-->NVBeforeUnload;
	end
		NVBeforeUnload-->unmounted;
	
```
杜庆泉's avatar
杜庆泉 已提交
346

杜庆泉's avatar
杜庆泉 已提交
347 348 349 350 351 352 353 354 355
|函数名			|描述				|建议行为		|是否可选	|
|:----			|:---				|:---			|:---		|
|created		|组件在内存中被创建	|开发者可以在这里执行一些需要最早执行的初始化逻辑|可选|
|NVBeforeLoad	|组件对应平台的view载体,即将被创建|开发者可以在这里执行一些需要在View创建前初始化的逻辑|可选|
|NVLoad			|组件view载体正在被创建实现|开发者需要重点实现这个函数,声明原生组件被创建出来的过程,以及最终生成的原生组件类型|必须实现|
|NVLayouted		|组件对应平台的view载体已布局结束	|需要在view布局结束后执行的逻辑	|可选|
|NVBeforeUnload	|view载体即将被卸载				|View卸载前,需要回收资源的逻辑	|可选|
|NVUnloaded		|view载体已经被卸载				|View卸载后,需要回收资源的逻辑	|可选|
|unmounted		|组件在内存被销毁				|资源回收逻辑					|可选|
杜庆泉's avatar
杜庆泉 已提交
356 357


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

杜庆泉's avatar
杜庆泉 已提交
359
除上述生命周期外,还存在下列可选周期函数:
杜庆泉's avatar
杜庆泉 已提交
360

杜庆泉's avatar
杜庆泉 已提交
361
+ NVMeasure
杜庆泉's avatar
杜庆泉 已提交
362

杜庆泉's avatar
杜庆泉 已提交
363
NVMeasure 用于告诉排版系统,组件自身需要的宽高,具体的调用时机由排版系统决定。
杜庆泉's avatar
杜庆泉 已提交
364

杜庆泉's avatar
杜庆泉 已提交
365
一般情况下,组件的宽高应该是由终端系统的排版引擎决定,组件开发者不需要实现此函数。
杜庆泉's avatar
杜庆泉 已提交
366

杜庆泉's avatar
杜庆泉 已提交
367
但是部分场景下,组件开发者需要自己维护宽高,则需要开发者重写此函数
杜庆泉's avatar
杜庆泉 已提交
368

杜庆泉's avatar
杜庆泉 已提交
369
[vue3 生命周期暂不支持](https://uniapp.dcloud.net.cn/tutorial/vue3-api.html#%E9%80%89%E9%A1%B9-%E7%94%9F%E5%91%BD%E5%91%A8%E6%9C%9F%E9%92%A9%E5%AD%90)
杜庆泉's avatar
杜庆泉 已提交
370 371


杜庆泉's avatar
杜庆泉 已提交
372
#### 内置对象和函数
杜庆泉's avatar
杜庆泉 已提交
373

杜庆泉's avatar
杜庆泉 已提交
374
为了方便组件开发者使用,UTS 组件内部内置了下列对象:
杜庆泉's avatar
杜庆泉 已提交
375

杜庆泉's avatar
杜庆泉 已提交
376 377 378 379
|变量名			|类型		|简介				|平台限制	|方法&属性	|
|:-------		|:--------	|:--------			|:---		|:---			|
|$el			|对象		|当前View实例对象	|全部平台	|开发者在NVLoad返回的对象类型|
|$androidContext|对象		|当前组件上下文		|仅android	|android平台对应Context对象|
杜庆泉's avatar
杜庆泉 已提交
380
|emit("event",Any)|函数		|发送已注册的事件	|全部平台	|emit(事件名称-必选,事件参数可选)|
杜庆泉's avatar
杜庆泉 已提交
381 382


杜庆泉's avatar
杜庆泉 已提交
383 384 385 386 387 388 389 390 391 392
#### 组件的通用事件

对于UTS组件来说,除了通过 emit/emits 函数来自定义事件外,UTS组件还内置了下列标准事件,组件的使用者无需实现,直接使用


|事件名称			|简介				
|:-------			|:--------			
|click				|组件点击事件响应
|longpress			|组件长按事件响应

杜庆泉's avatar
杜庆泉 已提交
393 394


杜庆泉's avatar
杜庆泉 已提交
395
## 简单View的示例
杜庆泉's avatar
杜庆泉 已提交
396

杜庆泉's avatar
杜庆泉 已提交
397 398 399 400

本章节以 一个极简的组件开发为例,介绍说明UTS组件开发流程


杜庆泉's avatar
杜庆泉 已提交
401
#### 创建插件
杜庆泉's avatar
杜庆泉 已提交
402

杜庆泉's avatar
杜庆泉 已提交
403
在HBuilder X 中选中Uni-App项目下 uni_modules目录  
杜庆泉's avatar
杜庆泉 已提交
404

杜庆泉's avatar
杜庆泉 已提交
405
todo  目前还没有创建界面
杜庆泉's avatar
杜庆泉 已提交
406 407


杜庆泉's avatar
杜庆泉 已提交
408
这是创建后的目录结构
杜庆泉's avatar
杜庆泉 已提交
409

杜庆泉's avatar
杜庆泉 已提交
410
![目录结构](https://native-res.dcloud.net.cn/images/uts/component/image1.png)
杜庆泉's avatar
杜庆泉 已提交
411 412


杜庆泉's avatar
杜庆泉 已提交
413
#### 编写逻辑
杜庆泉's avatar
杜庆泉 已提交
414

杜庆泉's avatar
杜庆泉 已提交
415
打开index.vue,键入下面的组件源码:
杜庆泉's avatar
杜庆泉 已提交
416

杜庆泉's avatar
杜庆泉 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
```ts
<template>
	<view class="defaultStyles">

	</view>
</template>
<script lang="uts">

	import TextUtils from 'android.text.TextUtils'
	import Button from 'android.widget.Button'
	import LinearLayout from 'android.widget.LinearLayout'
	import Color from 'android.graphics.Color'
	import View from 'android.view.View'

	class ButtonClickListsner extends View.OnClickListener {
		constructor() {}
		override onClick(v ? : View) {
			console.log(v)
		}
	}
杜庆泉's avatar
杜庆泉 已提交
437

杜庆泉's avatar
杜庆泉 已提交
438 439 440 441 442 443 444 445 446 447 448 449
	//原生提供以下属性或方法的实现  
	export default {
		name: "uts-hello-view",
		props: {
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
		
		watch: {
			"buttonText": {
杜庆泉's avatar
杜庆泉 已提交
450
				
杜庆泉's avatar
杜庆泉 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
				handler(newButtonText: string) {
					if (this.$el != null) {
						let button = this.$el!.findViewWithTag("centerButton") as Button
						if (!TextUtils.isEmpty(newButtonText)) {
							button.setText(newButtonText)
						}
					}
				}
			},
		},
		
		NVLoad(): LinearLayout {
			//必须实现  
			let contentLayout = new LinearLayout($androidContext)
			let button = new Button($androidContext)
			button.setTag("centerButton");
			contentLayout.addView(button, LinearLayout.LayoutParams(500, 500));
			button.setOnClickListener(new ButtonClickListsner())
			return contentLayout
		},
		
		
	}
</script>
<style>
	/* 定义默认样式值, 组件使用者没有配置时使用 */
	.defaultStyles {
		width: 750rpx;
		height: 240rpx;
		background-color: blue;
	}
</style>
杜庆泉's avatar
杜庆泉 已提交
483

杜庆泉's avatar
杜庆泉 已提交
484 485
```

杜庆泉's avatar
杜庆泉 已提交
486 487 488

上面的代码,我们自定义了一个  名为<uts-hello-view/>的UTS 组件,该组件对外提供了一个包含按钮的简单UI实现,并且对外暴露了一个名为 `buttonText`字符串属性,用来构建按钮上的文案
 
杜庆泉's avatar
杜庆泉 已提交
489
接下来,我们介绍在uni-app项目中如何使用它
杜庆泉's avatar
杜庆泉 已提交
490

杜庆泉's avatar
杜庆泉 已提交
491 492
#### 使用组件

杜庆泉's avatar
杜庆泉 已提交
493
> 注意:UTS组件默认全局注册,无需使用者手动配置
杜庆泉's avatar
杜庆泉 已提交
494

杜庆泉's avatar
杜庆泉 已提交
495 496 497
我们在uni-app项目中新建 helloView.nvue 页面,

![](https://native-res.dcloud.net.cn/images/uts/component/helloview_use_file.jpg)
杜庆泉's avatar
杜庆泉 已提交
498 499 500 501 502

直接使用`uts-hello-view`标签,并且定义`buttonText`文本内容即可看到效果。

点击按钮,可以在控制台看到组件内部实现的日志输出

杜庆泉's avatar
杜庆泉 已提交
503
```js
杜庆泉's avatar
杜庆泉 已提交
504 505 506 507 508 509 510 511 512 513 514 515
<template>
	<div>
		<text>UTS view组件</text>
		<uts-hello-view buttonText="点击按钮内容" style="width:375px;height: 375px;background-color: aqua;"></uts-hello-view>
	</div>
</template>

<script>
</script>

<style>
</style>
杜庆泉's avatar
杜庆泉 已提交
516 517 518
```


杜庆泉's avatar
杜庆泉 已提交
519 520 521 522 523 524 525

#### 运行和测试

在当前示例中,不涉及第三方依赖,使用标准基座直接运行即可



杜庆泉's avatar
杜庆泉 已提交
526
## 包含第三方SDK的示例
杜庆泉's avatar
杜庆泉 已提交
527

杜庆泉's avatar
杜庆泉 已提交
528 529
本章节以lottie动画组件为例,介绍包含三方SDK的UTS组件开发过程

杜庆泉's avatar
杜庆泉 已提交
530
#### 创建插件
杜庆泉's avatar
杜庆泉 已提交
531

杜庆泉's avatar
杜庆泉 已提交
532
在HBuilder X 中选中Uni-App项目下 uni_modules目录  
杜庆泉's avatar
杜庆泉 已提交
533

杜庆泉's avatar
杜庆泉 已提交
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
todo  目前还没有创建界面

这是创建后的目录结构

![目录结构](https://native-res.dcloud.net.cn/images/uts/component/image1.png)


#### 引入依赖

打开 ~/uni_modules/uts-animation-view/utssdk/app-android/config.json

键入如下代码:

```
"dependencies": [
	"com.airbnb.android:lottie:3.4.0"
]
```
杜庆泉's avatar
杜庆泉 已提交
552

杜庆泉's avatar
杜庆泉 已提交
553
UTS组件建议使用远程依赖的方式集成,如果需要以AAR的形式添加SDK,可以添加到
杜庆泉's avatar
杜庆泉 已提交
554

杜庆泉's avatar
杜庆泉 已提交
555
~/uni_modules/uts-animation-view/utssdk/app-android/libs目录
杜庆泉's avatar
杜庆泉 已提交
556

杜庆泉's avatar
杜庆泉 已提交
557 558
依赖的配置原则与UTS插件一致 [UTS插件依赖说明](https://uniapp.dcloud.net.cn/plugin/uts-for-android.html#_3-4-%E5%A2%9E%E5%8A%A0libs%E4%BE%9D%E8%B5%96%E8%B5%84%E6%BA%90)

杜庆泉's avatar
杜庆泉 已提交
559
#### 编写逻辑
杜庆泉's avatar
杜庆泉 已提交
560 561


杜庆泉's avatar
杜庆泉 已提交
562
打开index.vue,键入下面的组件源码:
杜庆泉's avatar
杜庆泉 已提交
563

杜庆泉's avatar
杜庆泉 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
```ts
<template>
    <view class="defaultStyles">

    </view>
</template>
<script lang="uts">
    import Animator from 'android.animation.Animator'
    import TextUtils from 'android.text.TextUtils'
    import View from 'android.view.View'
    import LottieAnimationView from 'com.airbnb.lottie.LottieAnimationView'
    import LottieDrawable from 'com.airbnb.lottie.LottieDrawable'
	import FileInputStream from 'java.io.FileInputStream'
	import { UTSAndroid } from "io.dcloud.uts";

    class CustomAnimListener extends Animator.AnimatorListener {

        comp: UTSComponent < LottieAnimationView >
            constructor(com: UTSComponent < LottieAnimationView > ) {
                super();
                this.comp = com
            }

        override onAnimationStart(animation: Animator | null) {}

        override onAnimationEnd(animation: Animator | null, isReverse: Boolean) {
            this.comp.emit("bindended")
        }

        override onAnimationEnd(animation: Animator | null) {}

        override onAnimationCancel(animation: Animator | null) {}

        override onAnimationRepeat(animation: Animator | null) {}
    }

    //原生提供以下属性或方法的实现  
    export default {
        name: "uts-animation-view",
        /**
         * 当播放到末尾时触发 ended 事件(自然播放结束会触发回调,循环播放结束及手动停止动画不会触发)
         */
        emits: ['bindended'],
        props: {
            /**
             * 动画资源地址,目前只支持绝对路径
             */
            "path": {
                type: String,
                default: ""
            },
            /**
             * 动画是否循环播放
             */
            "autoplay": {
                type: Boolean,
                default: false
            },
            /**
             * 动画是否自动播放
             */
            "loop": {
                type: Boolean,
                default: false
            },
            /**
             * 是否隐藏动画
             */
            "hidden": {
                type: Boolean,
                default: false
            },
            /**
             * 动画操作,可取值 play、pause、stop
             */
            "action": {
                type: String,
                default: "stop"
            }

        },
        data() {
            return {

            }
        },
        watch: {
            "path": {
                handler(newPath: string) {

                    
					if(this.$el != null){
						let lottieAnimationView = this.$el!
						if (!TextUtils.isEmpty(newPath)) {
							
							
						    if (newPath.startsWith("http://") || newPath.startsWith("https://")) {
						        lottieAnimationView.setAnimationFromUrl(newPath)
						    } else {
						        // 默认是static了
								var realJsonPath = UTSAndroid.getResourcePath(newPath)
						        lottieAnimationView.setAnimation(new FileInputStream(realJsonPath),newPath)
						    }
						}
						if (this.autoplay) {
						    lottieAnimationView.playAnimation()
						}
					}
                },
                immediate: false //创建时是否通过此方法更新属性,默认值为false  
            },
            "loop": {
                handler(newLoop: Boolean) {
					if(this.$el != null){
						if (newLoop) {
						    this.$el!.repeatCount = Int.MAX_VALUE
						} else {
						    // 不循环则设置成1次
						    this.$el!.repeatCount = 0
						}
						
						if (this.autoplay) {
						    this.$el!.playAnimation()
						}
					}
                    
                },
                immediate: false //创建时是否通过此方法更新属性,默认值为false  
            },

            "autoplay": {
                handler(newValue: boolean) {
					if(this.$el != null){
						if (newValue) {
						    this.$el!.playAnimation()
						}
					}
                    
                },
                immediate: false //创建时是否通过此方法更新属性,默认值为false  
            },

            "action": {
                handler(newAction: string) {

                    if (newAction == "play" || newAction == "pause" || newAction == "stop") {

						if(this.$el != null){
							if (this.action == "play") {
							    this.$el!.playAnimation()
							} else if (this.action == "pause") {
							    this.$el!.pauseAnimation()
							} else if (this.action == "stop") {
							    this.$el!.cancelAnimation()
							    this.$el!.clearAnimation()
							}
						}
                        

                    } else {
                        // 非法入参,不管
                    }
                },
                immediate: false //创建时是否通过此方法更新属性,默认值为false  
            },

            "hidden": {
                handler(newValue: boolean) {
					if(this.$el != null){
						if (newValue) {
						    this.$el!.visibility = View.GONE
						} else {
						    this.$el!.visibility = View.VISIBLE
						}
					}
                },
                immediate: false //创建时是否通过此方法更新属性,默认值为false  
            },

        },
        methods: {
            setRepeatMode(repeat: string) {
				if(this.$el != null){
					if ("RESTART" == repeat) {
					    this.$el!.repeatMode = LottieDrawable.RESTART
					} else if ("REVERSE" == repeat) {
					    this.$el!.repeatMode = LottieDrawable.RESTART
					}
				}
            },
            privateMethod() { //如何定义不对外暴露的API? 暂不支持,需在export外写  
            }
        },
        created() { //创建组件,替换created  

        },
        NVBeforeLoad() { //组件将要创建,对应前端beforeMount  
            //可选实现,这里可以提前做一些操作  
        },
        NVLoad(): LottieAnimationView { //创建原生View,必须定义返回值类型(Android需要明确知道View类型,需特殊校验)  
            //必须实现  
            let lottieAnimationView = new LottieAnimationView($androidContext)
            return lottieAnimationView
        },
		
        NVLoaded() { //原生View已创建  
			//可选实现,这里可以做后续操作
			if(this.$el != null){
				this.$el!.repeatMode = LottieDrawable.RESTART;
				this.$el!.visibility = View.GONE
				this.$el!.repeatCount = 0
				this.$el!.addAnimatorListener(new CustomAnimListener(this))
			}
           
        },
        NVLayouted() { //原生View布局完成  
            //可选实现,这里可以做布局后续操作  
        },
        NVBeforeUnload() { //原生View将释放  
            //可选实现,这里可以做释放View之前的操作  
        },
        NVUnloaded() { //原生View已释放  
            //可选实现,这里可以做释放View之后的操作  
        },
        unmounted() { //组件销毁  
            //可选实现  
        }
    }
</script>
<style>
    /* 定义默认样式值, 组件使用者没有配置时使用 */
    .defaultStyles {
        width: 750rpx;
        height: 240rpx;
    }
</style>
杜庆泉's avatar
杜庆泉 已提交
800

杜庆泉's avatar
杜庆泉 已提交
801
```
杜庆泉's avatar
杜庆泉 已提交
802

杜庆泉's avatar
杜庆泉 已提交
803
上面的代码我们实现了一个支持lottie动画播放的 UTS组件,标签名称为 `uts-animation-view`
杜庆泉's avatar
杜庆泉 已提交
804

杜庆泉's avatar
杜庆泉 已提交
805
对外提供了下列属性和方法
杜庆泉's avatar
杜庆泉 已提交
806

杜庆泉's avatar
杜庆泉 已提交
807 808 809 810 811 812 813 814
|属性		|类型	|默认值	|描述	|
|:---		|:--	|:--	|:---	|
|`path`		|string	||`lottie`资源路径,支持本地地址和`http`协议下的网络地址|
|`loop`		|boolean|false	|动画是否循环播放|
|`autoplay`	|boolean|true	|动画是否自动播放|
|`action`	|string	|play	|动画操作,可取值 play、pause、stop|
|`hidden`	|boolean|true	|是否隐藏动画|
|`bindended`|event	|		|当播放到末尾时触发 ended 事件|
杜庆泉's avatar
杜庆泉 已提交
815
|`setRepeatMode`|function|	|设置动画的重复方式,RESTART:重新开始播放,REVERSE,反向播放|
杜庆泉's avatar
杜庆泉 已提交
816

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

杜庆泉's avatar
杜庆泉 已提交
818 819 820 821 822
#### 使用`uts-animation-vie`组件

在uni-app项目中新建 lottie/index.nvue 页面

![](https://native-res.dcloud.net.cn/images/uts/component/lottie_use_file.jpg)
杜庆泉's avatar
杜庆泉 已提交
823

杜庆泉's avatar
杜庆泉 已提交
824
引用自定义 uts-animation-view 组件,并编写测试用例
杜庆泉's avatar
杜庆泉 已提交
825 826

```
杜庆泉's avatar
杜庆泉 已提交
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
<template>
    <div>
        <button @tap="changeUrl">播放本地动画资源</button>
		<button @tap="changeServerUrl">播放远程动画资源</button>
		
        <button @tap="changeAutoPlay">测试AutoPlay</button>
        <button @tap="changeLoop">测试Loop</button>
        <button @tap="changeAction(1)">测试action play</button>
        <button @tap="changeAction(2)">测试action pause</button>
        <button @tap="changeAction(3)">测试action stop</button>
        <uts-animation-view ref="animView" :path="animUrl" :autoplay="autoplay" :loop="loop" :action="action"
            :hidden="hidden" @bindended="testAnimEnd" @click="lottieClickTest" @longpress="lottieLongpressTest"
            :style="{width:widthNum+'rpx',height:heightNum+'px',background:yanse}">
        </uts-animation-view>
        
    </div>
</template>

<script>
  
    export default {
        data() {
            return {
                hidden: false,
                autoplay: false,
                action: "play",
                loop: false,
                yanse: "red",
                widthNum: 750,
                heightNum: 200,
                comShow: true,
                animUrl: "/static/anim_a.json"
            }
        },
        
        methods: {

            changeAutoPlay: function() {
                this.autoplay = !this.autoplay
            },
            changeUrl: function() {
                if (this.animUrl == "/static/anim_a.json") {
                    this.animUrl = "/static/anim_b.json"
                } else {
                    this.animUrl = "/static/anim_a.json"
                }
            },

			changeServerUrl: function() {
                this.animUrl = "https://b.bdstatic.com/miniapp/images/lottie_example_one.json"
            },
            changeAction: function(type) {
                if (type == 1) {
                    this.action = "play"
                } else if (type == 2) {
                    this.action = "pause"
                } else if (type == 3) {
                    this.action = "stop"
                }
            },
            changeLoop: function() {
                this.loop = !this.loop
            },
            testAnimEnd: function(res) {
                console.log("testAnimEnd");
            },

            changeRepeat: function(res) {
                let repeatConfig = {
                    count: 3,
                    mode: "restart"
                }
                this.$refs["animView"].updateRepeatConfig(repeatConfig, function(res) {
                    console.log(res);
                });

            },
            lottieClickTest: function(res) {
                console.log("lottieClickTest");
                console.log(res);
            },
            lottieLongpressTest: function(res) {
                console.log("lottieClickTest");
                console.log(res);
            },
        }
    }
</script>
杜庆泉's avatar
杜庆泉 已提交
915 916 917

```

杜庆泉's avatar
杜庆泉 已提交
918
以上,我们完成了 `uts-animation-view`组件的集成和使用工作
杜庆泉's avatar
杜庆泉 已提交
919 920


杜庆泉's avatar
杜庆泉 已提交
921
#### 运行和测试
杜庆泉's avatar
杜庆泉 已提交
922

杜庆泉's avatar
杜庆泉 已提交
923 924
在当前例子中,因为配置了额外的第三方依赖,需要自定义基座方能使用

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

杜庆泉's avatar
杜庆泉 已提交
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 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 1004 1005 1006 1007
## UTS开发容器组件

## 简介

组件一般有两种场景,第一种是: 单标签组件
```
<uts-view style="xxxx"/>
```

我们上面介绍的 `uts-hello-view`或者`uts-animation-view`都是这种类型

第二种是 作为容器使用:

```
<uts-view >
	<text> 文字子组件</text>
	<image src="https://xxx">
<uts-view >
```
## 声明

UTS组件作为容器组件与普通View组件遵循完全相同的规范,

唯一的区别在于 当组件布局中包含 <solt>标签时,编译器会自动将其转换为容器组件

```ts
<template>
	<view class="defaultStyles">
		<solt/>
	</view>
</template>
<script lang="uts">

	import LinearLayout from 'android.widget.LinearLayout'

	//原生提供以下属性或方法的实现  
	export default {
		name: "uts-hello-container",
		
		NVLoad(): LinearLayout {
			let contentLayout = new LinearLayout($androidContext)
			return contentLayout
		}
		
	}
</script>
<style>
	/* 定义默认样式值, 组件使用者没有配置时使用 */
	.defaultStyles {
		width: 750rpx;
		height: 240rpx;
		background-color: blue;
	}
</style>

```

如上,我们即可到了一个最简的UTS容器组件


## 使用容器组件

UTS容器组件的使用与Vue等常见的前端容器组件一致。唯一要注意的是,目前UTS容器组件还不支持 具名插槽。

如下是一个容器组件的使用示例


```js
<template>
	<uts-hello-container>
		<text>UTS contianer组件</text>
		<button text="点击按钮内容" style="width:375px;height: 375px;background-color: aqua;"></button>
	</uts-hello-container>
</template>

<script>
</script>

<style>
</style>
```

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

杜庆泉's avatar
杜庆泉 已提交
1009
## 快速体验
杜庆泉's avatar
杜庆泉 已提交
1010 1011


杜庆泉's avatar
杜庆泉 已提交
1012
开发者可以使用[Hello UTS](https://gitcode.net/dcloud/hello-uts) 快速体验UTS 组件开发
杜庆泉's avatar
杜庆泉 已提交
1013 1014


杜庆泉's avatar
杜庆泉 已提交
1015 1016 1017
Lottie动画示例,对应的源码实现:~/uni_modules/uts-animation-view

`uts-animation-view`动画示例,对应的源码实现:~/uni_modules/uts-animation-view
杜庆泉's avatar
杜庆泉 已提交
1018 1019 1020 1021



## 常见问题