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

杜庆泉's avatar
杜庆泉 已提交
3
> 需HBuilderX 3.7.0 及之后版本
杜庆泉'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暂未支持。

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
120 121 122 123
::: preview

> Android

D
DCloud_LXH 已提交
124
```ts
杜庆泉's avatar
杜庆泉 已提交
125

杜庆泉's avatar
杜庆泉 已提交
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
<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
杜庆泉 已提交
147 148 149
		/**
		 * 组件名称,也就是开发者使用的标签
		 */
杜庆泉's avatar
杜庆泉 已提交
150 151 152 153 154
		name: "uts-hello-view",
		/**
		 * 组件涉及的事件声明,只有声明过的事件,才能被正常发送
		 */
		emits: ['buttonClick'],
杜庆泉's avatar
杜庆泉 已提交
155 156 157
		/**
		 * 属性声明,组件的使用者会传递这些属性值到组件
		 */
杜庆泉's avatar
杜庆泉 已提交
158 159 160 161 162 163 164 165 166
		props: {
			/**
			 * 字符串类型 属性:buttonText  需要设置默认值
			 */
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
杜庆泉's avatar
杜庆泉 已提交
167 168 169
		/**
		 * 组件内部变量声明
		 */
杜庆泉's avatar
杜庆泉 已提交
170 171 172
		data() {
			return {}
		},
杜庆泉's avatar
杜庆泉 已提交
173 174 175
		/**
		 * 属性变化监听器实现
		 */
杜庆泉's avatar
杜庆泉 已提交
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
		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
杜庆泉 已提交
192 193 194 195
		/**
		 * 规则:如果没有配置expose,则methods中的方法均对外暴露,如果配置了expose,则以expose的配置为准向外暴露
		 * ['publicMethod'] 含义为:只有 `publicMethod` 在实例上可用
		 */
杜庆泉's avatar
杜庆泉 已提交
196 197
		expose: ['doSth'],
		methods: {
杜庆泉's avatar
杜庆泉 已提交
198 199 200
			/**
			 * 对外公开的组件方法
			 */
杜庆泉's avatar
杜庆泉 已提交
201 202 203
			doSth(paramA: string) {
				// 这是组件的自定义方法
				console.log("paramA")
杜庆泉's avatar
杜庆泉 已提交
204
			},
杜庆泉's avatar
杜庆泉 已提交
205 206 207
			/**
			 * 内部使用的组件方法
			 */
杜庆泉's avatar
杜庆泉 已提交
208
			privateMethod() {
杜庆泉's avatar
杜庆泉 已提交
209

杜庆泉's avatar
杜庆泉 已提交
210
			}
杜庆泉's avatar
杜庆泉 已提交
211 212
		},

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

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

		},
杜庆泉's avatar
杜庆泉 已提交
228 229 230 231 232
		/**
		 * 创建原生View,必须定义返回值类型
		 * 开发者需要重点实现这个函数,声明原生组件被创建出来的过程,以及最终生成的原生组件类型
		 * (Android需要明确知道View类型,需特殊校验) 
		 * todo 补充IOS平台限制
杜庆泉's avatar
杜庆泉 已提交
233
	  * [必须实现]
杜庆泉's avatar
杜庆泉 已提交
234
		 */
杜庆泉's avatar
杜庆泉 已提交
235 236 237 238 239 240 241 242 243 244 245
		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
杜庆泉 已提交
246 247 248 249
		/**
		 * 原生View已创建 
		 * [可选实现]
		 */
杜庆泉's avatar
杜庆泉 已提交
250 251 252
		NVLoaded() {

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

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

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

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
298 299 300
> iOS

```ts
杜庆泉's avatar
杜庆泉 已提交
301 302 303 304 305 306 307 308 309 310
<template>
	<view class="defaultStyles">
	</view>
</template>
<script lang="uts">
	import {
		UIButton
	} from "UIKit"

	// 定义按钮点击后触发回调的类
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
311
	class ButtonClickListsner {
杜庆泉's avatar
杜庆泉 已提交
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
		// 按钮点击回调方法
		@objc buttonClick() {
			console.log("按钮被点击")
		}
	}

	//原生提供以下属性或方法的实现  
	export default {
		/**
		 * 组件名称,也就是开发者使用的标签
		 */
		name: "uts-hello-view",
		/**
		 * 组件涉及的事件声明,只有声明过的事件,才能被正常发送
		 */
		emits: ['buttonClick'],
		/**
		 * 属性声明,组件的使用者会传递这些属性值到组件
		 */
		props: {
			/**
			 * 字符串类型 属性:buttonText  需要设置默认值
			 */
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
		/**
		 * 组件内部变量声明
		 */
		data() {
			return {}
		},
		/**
		 * 属性变化监听器实现
		 */
		watch: {
			"buttonText": {
				/**
				 * 这里监听属性变化,并进行组件内部更新
				 */
				handler(newButtonText: string, oldButtonText) {
					this.$el.setTitle(newButtonText, for = UIControl.State.normal)
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},
		},
		/**
		 * 规则:如果没有配置expose,则methods中的方法均对外暴露,如果配置了expose,则以expose的配置为准向外暴露
		 * ['publicMethod'] 含义为:只有 `publicMethod` 在实例上可用
		 */
		expose: ['doSth'],
		methods: {
			/**
			 * 对外公开的组件方法
			 */
			doSth(paramA: string) {
				// 这是组件的自定义方法
				console.log("paramA")
			},
			/**
			 * 内部使用的组件方法
			 */
		},


		/**
		 * 组件被创建,组件第一个生命周期,
		 * 在内存中被占用的时候被调用,开发者可以在这里执行一些需要提前执行的初始化逻辑
		 * [可选实现]
		 */
		created() {

		},
		/**
		 * 对应平台的view载体即将被创建,对应前端beforeMount  
		 * [可选实现]
		 */
		NVBeforeLoad() {

		},
		/**
		 * 创建原生View,必须定义返回值类型
		 * 开发者需要重点实现这个函数,声明原生组件被创建出来的过程,以及最终生成的原生组件类型
		 * [必须实现]
		 */
		NVLoad(): UIButton {
			//必须实现  
			let button = new UIButton()
			button.setTitle(this.buttonText, for = UIControl.State.normal)
			const target = new ButtonClickListsner()
			const method = Selector("buttonClick")
			button.addTarget(target, action = method, for = UIControl.Event.touchUpInside)
			return button
		},

		/**
		 * 原生View已创建 
		 * [可选实现]
		 */
		NVLoaded() {

		},
		/**
		 * 原生View布局完成  
		 * [可选实现]
		 */
		NVLayouted() {

		},
		/**
		 * 原生View将释放  
		 * [可选实现]
		 */
		NVBeforeUnload() {},
		/**
		 * 原生View已释放,这里可以做释放View之后的操作  
		 * [可选实现]
		 */
		NVUnloaded() {

		},
		/**
		 * 组件销毁  
		 * [可选实现]
		 */
		unmounted() {}
		/**
		 * 自定组件布局尺寸 
		 * [可选实现]
		 */
		NVMeasure(size: UTSSize): UTSSize {
			return new UTSSize(120, 45);
		}
	}
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
448
</script>
杜庆泉's avatar
杜庆泉 已提交
449 450
```

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
451
:::
杜庆泉's avatar
杜庆泉 已提交
452

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

杜庆泉's avatar
杜庆泉 已提交
455
+ 配置:
杜庆泉's avatar
杜庆泉 已提交
456

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

杜庆泉's avatar
杜庆泉 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
+ 属性:
	
	props:需要由组件的使用者提供,比如一个Image组件,会需要一个path属性作为图像路径来源
	
	watch:属性的监听实现,用来监听属性数据更新。
	
+ 数据:	

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

+ 方法:

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


+ 生命周期:

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


杜庆泉's avatar
杜庆泉 已提交
487
#### 生命周期 
杜庆泉's avatar
杜庆泉 已提交
488

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

杜庆泉's avatar
杜庆泉 已提交
491 492 493 494 495 496 497 498 499 500 501 502
```mermaid 
graph TD;
		Create-->NVBeforeLoad;
	subgraph View生命周期
		NVBeforeLoad-->NVLoad;
		NVLoad-->NVLoaded;
		NVLoaded-->NVLayouted;
		NVLayouted-->NVBeforeUnload;
	end
		NVBeforeUnload-->unmounted;
	
```
杜庆泉's avatar
杜庆泉 已提交
503

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


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

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

杜庆泉's avatar
杜庆泉 已提交
518
+ NVMeasure
杜庆泉's avatar
杜庆泉 已提交
519

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

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

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

杜庆泉's avatar
杜庆泉 已提交
526
[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
杜庆泉 已提交
527 528


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

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

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


杜庆泉's avatar
杜庆泉 已提交
540
#### 通用事件
杜庆泉's avatar
杜庆泉 已提交
541

杜庆泉's avatar
杜庆泉 已提交
542
对于UTS组件来说,除了通过 $emit/emits 函数来自定义组件事件外,UTS组件还内置了下列通用事件:
杜庆泉's avatar
杜庆泉 已提交
543 544 545 546 547 548 549


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

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

杜庆泉's avatar
杜庆泉 已提交
551 552 553 554 555 556
通用事件,组件的使用者无需实现,直接使用

```js
<uts-hello-view buttonClick="自定义事件处理函数" click="通用点击事件处理函数" longpress="通用长按事件处理函数"/>
```

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

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

杜庆泉's avatar
杜庆泉 已提交
560 561 562 563

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


杜庆泉's avatar
杜庆泉 已提交
564
#### 创建插件
杜庆泉's avatar
杜庆泉 已提交
565

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

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

杜庆泉's avatar
杜庆泉 已提交
570 571 572
选择`UTS插件-组件插件`

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

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

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
576
![目录结构](https://native-res.dcloud.net.cn/images/uts/component/image1.jpg)
杜庆泉's avatar
杜庆泉 已提交
577 578


杜庆泉's avatar
杜庆泉 已提交
579
#### 编写逻辑
杜庆泉's avatar
杜庆泉 已提交
580

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

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
583 584 585 586
::: preview

> Android

杜庆泉's avatar
杜庆泉 已提交
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
```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
杜庆泉 已提交
607

杜庆泉's avatar
杜庆泉 已提交
608 609 610 611 612 613 614 615 616 617 618 619
	//原生提供以下属性或方法的实现  
	export default {
		name: "uts-hello-view",
		props: {
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
		
		watch: {
			"buttonText": {
杜庆泉's avatar
杜庆泉 已提交
620
				
杜庆泉's avatar
杜庆泉 已提交
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
				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
杜庆泉 已提交
653

杜庆泉's avatar
杜庆泉 已提交
654 655
```

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
656 657 658
> iOS

```ts
杜庆泉's avatar
杜庆泉 已提交
659 660 661 662 663 664 665 666 667 668
<template>
	<view class="defaultStyles">
	</view>
</template>
<script lang="uts">
	import {
		UIButton
	} from "UIKit"

	// 定义按钮点击后触发回调的类
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
669
	class ButtonClickListsner {
杜庆泉's avatar
杜庆泉 已提交
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
		// 按钮点击回调方法
		@objc buttonClick() {
			console.log("按钮被点击")
		}
	}

	//原生提供以下属性或方法的实现  
	export default {
		name: "uts-hello-view",
		emits: ['buttonClick'],
		props: {
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
		watch: {
			"buttonText": {
				/**
				 * 这里监听属性变化,并进行组件内部更新
				 */
				handler(newButtonText: string, oldButtonText) {
					this.$el.setTitle(newButtonText, for = UIControl.State.normal)
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},
		},
		expose: ['doSth'],
		methods: {
			/**
			 * 对外公开的组件方法
			 */
			doSth(paramA: string) {
				// 这是组件的自定义方法
				console.log("paramA")
			}
		},
		/**
		 * 创建原生View,必须定义返回值类型
		 */
		NVLoad(): UIButton {
			//必须实现  
			let button = new UIButton()
			button.setTitle(this.buttonText, for = UIControl.State.normal)
			const target = new ButtonClickListsner()
			const method = Selector("buttonClick")
			button.addTarget(target, action = method, for = UIControl.Event.touchUpInside)
			return button
		}
	}
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
720 721 722 723
</script>
```

:::
杜庆泉's avatar
杜庆泉 已提交
724

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

杜庆泉's avatar
杜庆泉 已提交
729 730
#### 使用组件

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

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

![](https://native-res.dcloud.net.cn/images/uts/component/helloview_use_file.jpg)
杜庆泉's avatar
杜庆泉 已提交
736 737 738 739 740

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

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

杜庆泉's avatar
杜庆泉 已提交
741
```js
杜庆泉's avatar
杜庆泉 已提交
742 743 744 745 746 747 748 749 750 751 752 753
<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
杜庆泉 已提交
754 755 756
```


杜庆泉's avatar
杜庆泉 已提交
757 758 759 760 761 762 763

#### 运行和测试

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



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

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

杜庆泉's avatar
杜庆泉 已提交
768
#### 创建插件
杜庆泉's avatar
杜庆泉 已提交
769

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

杜庆泉's avatar
杜庆泉 已提交
772 773 774 775 776
![](https://native-res.dcloud.net.cn/images/uts/component/uts_component_create.jpg)

选择`UTS插件-组件插件`

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

这是创建后的目录结构

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
780
![目录结构](https://native-res.dcloud.net.cn/images/uts/component/image3.jpg)
杜庆泉's avatar
杜庆泉 已提交
781 782


DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
783
#### Android 平台引入依赖
杜庆泉's avatar
杜庆泉 已提交
784 785 786 787 788 789 790 791 792 793

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

键入如下代码:

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

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

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

杜庆泉's avatar
杜庆泉 已提交
799 800
依赖的配置原则与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)

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
801 802 803 804
#### iOS 平台引入依赖库

iOS 平台需要将三方依赖库放到 组件目录下 app-ios/Frameworks 中

杜庆泉's avatar
杜庆泉 已提交
805
#### 编写逻辑
杜庆泉's avatar
杜庆泉 已提交
806 807


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

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
810 811 812 813
::: preview

> Android

杜庆泉's avatar
杜庆泉 已提交
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
```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) {
杜庆泉's avatar
杜庆泉 已提交
840
            this.comp.$emit("bindended")
杜庆泉's avatar
杜庆泉 已提交
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 915 916 917 918 919 920 921 922 923 924 925 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 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
        }

        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
杜庆泉 已提交
1050

杜庆泉's avatar
杜庆泉 已提交
1051
```
杜庆泉's avatar
杜庆泉 已提交
1052

DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
1053 1054 1055
> iOS

```ts
杜庆泉's avatar
杜庆泉 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
<template>
	<view class="defaultStyles">

	</view>
</template>
<script lang="uts">
	import {
		LottieAnimationView,
		LottieAnimation,
		LottieLoopMode
	} from 'Lottie'
	import {
		URL,
		Bundle
	} from 'Foundation'
	import {
		UIView
	} from "UIKit"
	import {
		UTSiOS
	} from "DCloudUTSFoundation"


	//原生提供以下属性或方法的实现  
	export default {
		/**
		 * 组件名称,也就是开发者使用的标签
		 */
		name: "uts-animation-view",
		/**
		 * 组件涉及的事件声明,只有声明过的事件,才能被正常发送
		 */
		emits: ['bindended'], // 当播放到末尾时触发 ended 事件(自然播放结束会触发回调,循环播放结束及手动停止动画不会触发)
		/**
		 * 属性声明,组件的使用者会传递这些属性值到组件
		 */
		props: {
			/**
			 * 动画资源地址,支持远程 URL 地址和本地绝对路径
			 */
			"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(newValue: string, oldValue: string) {
					this.path = newValue
					this.playAnimation()
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},
			"loop": {
				handler(newValue: boolean, oldValue: boolean) {
					this.loop = newValue
					if (this.loop) {
						this.$el.loopMode = LottieLoopMode.loop
					} else {
						this.$el.loopMode = LottieLoopMode.playOnce
					}
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},
			"autoplay": {
				handler(newValue: boolean, oldValue: boolean) {
					this.autoplay = newValue
					if (this.autoplay) {
						this.playAnimation()
					}
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},
			"action": {
				handler(newValue: string, oldValue: string) {
					const action = newValue

					if (action == "play" || action == "pause" || action == "stop") {
						this.action = action
						switch (action) {
							case "play":
								this.playAnimation()
								break;
							case "pause":
								this.$el.pause()
								break;
							case "stop":
								this.$el.stop()
								break;
							default:
								break;
						}
					} else {
						// 非法入参,不管
					}
				},
				immediate: false //创建时是否通过此方法更新属性,默认值为false  
			},

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

		},
		expose: ['setRepeatMode'],
		methods: {
			// 需要对外暴露的方法
			// 设置 RepeatMode 
			setRepeatMode(repeatMode: string) {
				if (repeatMode == "RESTART") {
					if (this.loop) {
						this.$el.loopMode = LottieLoopMode.loop
					} else {
						this.$el.loopMode = LottieLoopMode.playOnce
					}
				} else if (repeatMode == "REVERSE") {
					if (this.loop) {
						this.$el.loopMode = LottieLoopMode.autoReverse
					} else {
						this.$el.loopMode = LottieLoopMode.repeatBackwards(1)
					}
				}
			},
			// 不对外暴露的方法
			// 播放动画 
			playAnimation() {
				// 构建动画资源 url
				var animationUrl: URL | null

				if (this.path.hasPrefix("http")) {
					animationUrl = new URL(string = this.path)
				} else {
					const filePath = UTSiOS.getResourcePath(this.path)
					animationUrl = new URL(fileURLWithPath = filePath)
				}

				if (animationUrl != null) {
					// 加载动画 LottieAnimation
					LottieAnimation.loadedFrom(url = animationUrl!, closure = (animation: LottieAnimation | null):
						void => {
							if (animation != null) {
								// 加载成功开始播放
								this.$el.animation = animation
								this.$el.play(completion = (isFinish: boolean): void => {
									if (isFinish) {
										// 播放完成回调事件
										this.fireEvent("bindended")
									}
								})
							}
						})
				} else {
					console.log("url 构建失败,请检查 path 是否正确")
				}
			}
		},
		created() { //创建组件,替换created  

		},
		NVBeforeLoad() { //组件将要创建,对应前端beforeMount  
			//可选实现,这里可以提前做一些操作  
		},
		NVLoad(): LottieAnimationView { //创建原生View,必须定义返回值类型(Android需要明确知道View类型,需特殊校验)  
			// 初始化 Lottie$el
			const animationView = new LottieAnimationView()
			// 默认只播放一次动画
			animationView.loopMode = LottieLoopMode.playOnce
			return animationView
		},
		NVLoaded() { //原生View已创建  

			/// 更新 props 中定义的属性值

			if (this.loop) {
				this.$el.loopMode = LottieLoopMode.loop
			}

			this.$el.isHidden = this.hidden

			if (this.autoplay) {
				this.playAnimation()
			}
		},

		NVLayouted() { //原生View布局完成  
			//可选实现,这里可以做布局后续操作  
		},

		NVBeforeUnload() { //原生View将释放  
			//可选实现,这里可以做释放View之前的操作  
		},
		NVUnloaded() { //原生View已释放  
			//可选实现,这里可以做释放View之后的操作  
		},
		unmounted() { //组件销毁  
			//可选实现  
		}
	}
</script>
<style>
	//定义默认样式值, 组件使用者没有配置时使用  
	.defaultStyles {
		width: 750rpx;
		height: 240rpx;
	}
DCloud_iOS_XHY's avatar
DCloud_iOS_XHY 已提交
1299 1300 1301 1302 1303
</style>
```

:::

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

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

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

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

杜庆泉's avatar
杜庆泉 已提交
1319 1320 1321 1322 1323
#### 使用`uts-animation-vie`组件

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

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

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

```
杜庆泉's avatar
杜庆泉 已提交
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
<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
杜庆泉 已提交
1416 1417 1418

```

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


杜庆泉's avatar
杜庆泉 已提交
1422
#### 运行和测试
杜庆泉's avatar
杜庆泉 已提交
1423

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

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

杜庆泉's avatar
杜庆泉 已提交
1427 1428
## UTS开发容器组件

杜庆泉's avatar
杜庆泉 已提交
1429
#### 容器组件简介
杜庆泉's avatar
杜庆泉 已提交
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445

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

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

第二种是 作为容器使用:

```
<uts-view >
	<text> 文字子组件</text>
	<image src="https://xxx">
<uts-view >
```
杜庆泉's avatar
杜庆泉 已提交
1446
#### 容器组件声明
杜庆泉's avatar
杜庆泉 已提交
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

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容器组件


杜庆泉's avatar
杜庆泉 已提交
1487
#### 使用容器组件
杜庆泉's avatar
杜庆泉 已提交
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508

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
杜庆泉 已提交
1509

杜庆泉's avatar
杜庆泉 已提交
1510
## 快速体验
杜庆泉's avatar
杜庆泉 已提交
1511 1512


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

杜庆泉's avatar
杜庆泉 已提交
1515 1516
本文档中涉及的示例均可以在其中找到:
uts-hello-component
杜庆泉's avatar
杜庆泉 已提交
1517

杜庆泉's avatar
杜庆泉 已提交
1518
`uts-hello-view`对应的源码实现:~/uni_modules/uts-hello-component
杜庆泉's avatar
杜庆泉 已提交
1519

杜庆泉's avatar
杜庆泉 已提交
1520
`uts-animation-view`对应的源码实现:~/uni_modules/uts-animation-view
杜庆泉's avatar
杜庆泉 已提交
1521 1522 1523 1524



## 常见问题