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

杜庆泉's avatar
杜庆泉 已提交
3 4 5 6
## 1 前置条件

+ HBuilderX 3.6.15 及之后版本

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

杜庆泉's avatar
杜庆泉 已提交
9 10 11 12
+ 目前仅支持nvue

## 2 组件概述

杜庆泉's avatar
杜庆泉 已提交
13
### 2.1 UTS组件简介
杜庆泉's avatar
杜庆泉 已提交
14

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

杜庆泉's avatar
杜庆泉 已提交
17
UTS组件,即:使用UTS语言在uni平台进行组件开发的技术。 [关于UTS的更多介绍](https://uniapp.dcloud.net.cn/plugin/uts-plugin.html)
杜庆泉's avatar
杜庆泉 已提交
18 19


杜庆泉's avatar
杜庆泉 已提交
20
组件约定上采用了类Vue组件的语法,[关于Vue组件的更多介绍](https://cn.vuejs.org/guide/essentials/component-basics.html)
杜庆泉's avatar
杜庆泉 已提交
21

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

杜庆泉's avatar
杜庆泉 已提交
23
### 2.2 UTS组件和Vue组件差异
杜庆泉's avatar
杜庆泉 已提交
24

杜庆泉's avatar
杜庆泉 已提交
25
UTS组件,与传统Vue组件区别在于,它秉承了UTS的跨平台特性,统一的UTS语法,各终端不同的本地产出物。
杜庆泉's avatar
杜庆泉 已提交
26

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

杜庆泉's avatar
杜庆泉 已提交
29 30


杜庆泉's avatar
杜庆泉 已提交
31 32
## 3 如何开发组件-举个例子

杜庆泉's avatar
杜庆泉 已提交
33
以lottie动画组件为例,本章节提到全部示例源码可以在Hello UTS 中找到
杜庆泉's avatar
杜庆泉 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126


#### 3.1 目录结构

组件的目录结构和插件一样:

![生命周期](https://native-res.dcloud.net.cn/images/uts/component/image1.png)

入口文件是index.vue


#### 3.2 示例代码简介

```uts

    //原生提供以下属性或方法的实现  
    export default {
		/**
		 * 组件名称,也就是开发者使用的标签
		 */
        name: "xxx-view",
        /**
         * 组件涉及的事件声明
         */
        emits: ['bindended'],
        props: {
            /**
             * 属性A:propA  需要声明属性类型和默认值
             */
            "propA": {
                type: String,
                default: ""
            },
        },
        data() {
            return {
            }
        },
        watch: {
            "propA": {
                handler(newPropA: string) {
					// 这里处理属性newPropA 的更新逻辑
                },
                immediate: false //创建时是否通过此方法更新属性,默认值为false  
            },
        },
		// 规则:如果没有配置expose,则methods中的方法均对外暴露,如果配置了expose,则以expose的配置为准向外暴露
		// 只有 `publicMethod` 在实例上可用
		expose: ['publicMethod'],
        methods: {
			publicMethod() {
				doSth(paramA: string) {
					// 这是组件的自定义方法
				}
			},
			privateMethod() {
				doSth(paramA: string) {
					// 这是组件的自定义方法
				}
			}
            
        },
        created() { //创建组件,替换created  

        },
        NVBeforeLoad() { //组件将要创建,对应前端beforeMount  
            //可选实现,这里可以提前做一些操作  
        },
        NVLoad(): View { //创建原生View,必须定义返回值类型(Android需要明确知道View类型,需特殊校验)  
            //必须实现  
            let viewInstance = new View($androidContext)
            return aView
        },
		
        NVLoaded() { //原生View已创建  
			//可选实现,这里可以做后续操作
        },
        NVLayouted() { //原生View布局完成  
            //可选实现,这里可以做布局后续操作  
        },
        NVBeforeUnload() { //原生View将释放  
            //可选实现,这里可以做释放View之前的操作  
        },
        NVUnloaded() { //原生View已释放  
            //可选实现,这里可以做释放View之后的操作  
        },
        unmounted() { //组件销毁  
            //可选实现  
        }
    }

```

杜庆泉's avatar
杜庆泉 已提交
127
#### 3.3 组件开发关键函数
杜庆泉's avatar
杜庆泉 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240


首先开发者需要重点关注的是 NVLoad 函数,开发者需要在这个函数内实现View载体的具体实现

```
let viewInstance = new View($androidContext)
return aView
```

除了组件的基本功能外,组件还以属性和方法的形式为使用者提供额外的功能

组件的开发者,声明属性
```
props: {
	/**
	 * 属性A:propA  需要声明属性类型和默认值
	 */
	"propA": {
		type: String,
		default: ""
	},
},
```

组件使用者,使用属性
```js
 <xxx-view  :propA="自定义属性值" >
 </xxx-view>
```

组件的开发者,定义公开方法

```
methods: {
	publicMethod() {
		doSth(paramA: string) {
			// 这是组件的自定义方法
		}
	}
}
```
组件使用者,使用方法

```js
 // 布局代码
 <xxx-view  ref="xxxView" >
 </xxx-view>
 // 调用代码
 this.$refs["xxxView"].doSth('字符串参数')
```

#### 3.4 使用组件

1  需要自定义基座方能使用

2 不需要特殊引用,直接使用自定义

```js
 <xxx-view  :propA="自定义属性值" ref="当前组件标签">
 </xxx-view>
```




3 调用组件的方法


参考Hello UTS ,源码路径: 

~\pages\SDKIntegration\Lottie\index.nvue


## 4 组件的生命周期


![生命周期](https://native-res.dcloud.net.cn/images/uts/component/image2.png)

+ created:

组件被创建,组件第一个生命周期,在内存中被占用的时候被调用,开发者可以在这里执行一些需要提前执行的初始化逻辑

+ NVBeforeLoad:

组件对应平台的view载体 即将被创建

+ NVLoad:

组件对应平台的view载体 正在被创建,开发者需要重点实现这个函数,声明原生组件被创建出来的过程,以及最终生成的原生组件类型

+ NVLayouted:

组件对应平台的view载体,布局完成

+ NVBeforeUnload:

view载体即将被卸载

资源回收

+ NVUnloaded:

view载体已经被卸载

资源回收

+ unmounted:

view载体被回收

资源回收

## 常见问题