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

杜庆泉's avatar
杜庆泉 已提交
3 4 5
本文旨在帮助开发者,使用UTS开发Uni-App平台组件功能。


杜庆泉's avatar
杜庆泉 已提交
6
## 前置条件
杜庆泉's avatar
杜庆泉 已提交
7

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

杜庆泉's avatar
杜庆泉 已提交
10 11
+ HBuilderX 3.6.15 及之后版本

杜庆泉's avatar
杜庆泉 已提交
12 13
+ 了解Vue 组件基本概念

杜庆泉's avatar
杜庆泉 已提交
14 15
+ 目前仅支持nvue

杜庆泉's avatar
杜庆泉 已提交
16
## UTS组件简介
杜庆泉's avatar
杜庆泉 已提交
17

杜庆泉's avatar
杜庆泉 已提交
18
#### 为什么使用组件
杜庆泉's avatar
杜庆泉 已提交
19

杜庆泉's avatar
杜庆泉 已提交
20
组件是一种独立,可复用的UI单元,用于单独封装和承担一定的代码逻辑,组件化可以降低项目的工程复杂度,提升可维护性
杜庆泉's avatar
杜庆泉 已提交
21

杜庆泉's avatar
杜庆泉 已提交
22
组件与插件的区别在于:前者倾向于以标签的形式 对外提供UI封装,后者倾向于以函数/类 的形式 对外提供功能封装。如果你的需求更倾向于封装能力,请移步 [UTS插件开发](https://uniapp.dcloud.net.cn/plugin/uts-plugin.html)
杜庆泉's avatar
杜庆泉 已提交
23

杜庆泉's avatar
杜庆泉 已提交
24
组件一般适用于封装非全屏的场景,如果需要你需要封装的UI始终是全屏,那么可以考虑通过UTS开发原生页面来实现。 [UTS开发原生页面示例](https://gitcode.net/dcloud/hello-uts/-/tree/master/uni_modules/uts-nativepage)
杜庆泉's avatar
杜庆泉 已提交
25

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

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

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

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

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

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

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

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

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


杜庆泉's avatar
杜庆泉 已提交
44
为了降低前端开发者的开发门槛,UTS组件采用了类Vue组件的语法,[关于Vue组件](https://cn.vuejs.org/guide/essentials/component-basics.html),但是具体的函数上会有定制,我们会在下一个章节详细介绍
杜庆泉's avatar
杜庆泉 已提交
45 46


杜庆泉's avatar
杜庆泉 已提交
47
## UTS组件结构解析
杜庆泉's avatar
杜庆泉 已提交
48 49


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


杜庆泉's avatar
杜庆泉 已提交
53 54 55 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
<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.d.ts                  // 插件能力声明,可选
│	└─index.uts                   // 跨平台插件能力实现,可选
└─package.json                    // 插件清单文件
</code>
</pre>


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

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

+ 必选的index.vue 组件入口

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

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

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

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

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



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

杜庆泉's avatar
杜庆泉 已提交
111 112 113

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

fxy060608's avatar
fxy060608 已提交
114 115 116 117
**注意**

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

D
DCloud_LXH 已提交
118
```ts
杜庆泉's avatar
杜庆泉 已提交
119

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

杜庆泉's avatar
杜庆泉 已提交
204
			}
杜庆泉's avatar
杜庆泉 已提交
205 206
		},

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

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

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

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

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

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

```

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

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

杜庆泉's avatar
杜庆泉 已提交
296
+ 配置:
杜庆泉's avatar
杜庆泉 已提交
297

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

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

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

+ 方法:

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


+ 生命周期:

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


杜庆泉's avatar
杜庆泉 已提交
328
#### 生命周期 
杜庆泉's avatar
杜庆泉 已提交
329

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

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

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


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

杜庆泉's avatar
杜庆泉 已提交
358
+ doMeasure:
杜庆泉's avatar
杜庆泉 已提交
359

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

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

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



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

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

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




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

杜庆泉's avatar
杜庆泉 已提交
383 384 385 386

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


杜庆泉's avatar
杜庆泉 已提交
387
#### 创建插件
杜庆泉's avatar
杜庆泉 已提交
388

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

杜庆泉's avatar
杜庆泉 已提交
391
todo  目前还没有创建界面
杜庆泉's avatar
杜庆泉 已提交
392 393


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

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


杜庆泉's avatar
杜庆泉 已提交
399
#### 编写逻辑
杜庆泉's avatar
杜庆泉 已提交
400

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

杜庆泉's avatar
杜庆泉 已提交
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
```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
杜庆泉 已提交
423

杜庆泉's avatar
杜庆泉 已提交
424 425 426 427 428 429 430 431 432 433 434 435
	//原生提供以下属性或方法的实现  
	export default {
		name: "uts-hello-view",
		props: {
			"buttonText": {
				type: String,
				default: "点击触发"
			}
		},
		
		watch: {
			"buttonText": {
杜庆泉's avatar
杜庆泉 已提交
436
				
杜庆泉's avatar
杜庆泉 已提交
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 467 468
				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
杜庆泉 已提交
469

杜庆泉's avatar
杜庆泉 已提交
470 471
```

杜庆泉's avatar
杜庆泉 已提交
472 473 474

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

杜庆泉's avatar
杜庆泉 已提交
477 478
#### 使用组件

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

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

![](https://native-res.dcloud.net.cn/images/uts/component/helloview_use_file.jpg)
杜庆泉's avatar
杜庆泉 已提交
484 485 486 487 488

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

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

杜庆泉's avatar
杜庆泉 已提交
489
```js
杜庆泉's avatar
杜庆泉 已提交
490 491 492 493 494 495 496 497 498 499 500 501
<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
杜庆泉 已提交
502 503 504
```


杜庆泉's avatar
杜庆泉 已提交
505 506 507 508 509 510 511

#### 运行和测试

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



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

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

杜庆泉's avatar
杜庆泉 已提交
516
#### 创建插件
杜庆泉's avatar
杜庆泉 已提交
517

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

杜庆泉's avatar
杜庆泉 已提交
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
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
杜庆泉 已提交
538

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

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

杜庆泉's avatar
杜庆泉 已提交
543 544
依赖的配置原则与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
杜庆泉 已提交
545
#### 编写逻辑
杜庆泉's avatar
杜庆泉 已提交
546 547


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

杜庆泉's avatar
杜庆泉 已提交
550 551 552 553 554 555 556 557 558 559 560 561 562 563 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
```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
杜庆泉 已提交
786

杜庆泉's avatar
杜庆泉 已提交
787
```
杜庆泉's avatar
杜庆泉 已提交
788

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

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

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

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

杜庆泉's avatar
杜庆泉 已提交
804 805 806 807 808
#### 使用`uts-animation-vie`组件

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

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

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

```
杜庆泉's avatar
杜庆泉 已提交
813 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 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
<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
杜庆泉 已提交
901 902 903

```

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


杜庆泉's avatar
杜庆泉 已提交
907
#### 运行和测试
杜庆泉's avatar
杜庆泉 已提交
908

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

杜庆泉's avatar
杜庆泉 已提交
911 912


杜庆泉's avatar
杜庆泉 已提交
913
## 快速体验
杜庆泉's avatar
杜庆泉 已提交
914 915


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


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

`uts-animation-view`动画示例,对应的源码实现:~/uni_modules/uts-animation-view
杜庆泉's avatar
杜庆泉 已提交
922 923 924 925



## 常见问题