纵横千里独行客,何惧前路雨潇潇。夜半浊酒慰寂寞,天明走马入红尘。且将新火试新茶,诗酒趁年华。青春以末,壮志照旧,生活以悟,前路未明。时间善变,可执着翻不了篇。时光磨我少年心,却难灭我少年志,壮士活古不活皮。加油。
目录
一,定义
二,装饰器使用规则说明
三,变量的传递/访问规则说明
四,使用
1,简单使用
2,装饰复杂类型
3,@State和@Prop的同步场景
4,父组件@State到子组件@Prop简单数据类型同步
5,父组件@State到子组件@Prop复杂数据类型同步
注意事项
@Prop装饰的变量可以和父组件建立单向的同步关系。@Prop装饰的变量是可变的,但是变化不会同步回其父组件。
@Prop装饰的变量和父组件建立单向的同步关系:
①@Prop变量允许在本地修改,但修改后的变化不会同步回父组件。
②当数据源更改时,@Prop装饰的变量都会更新,并且会覆盖本地所有更改。因此,数值的同步是父组件到子组件(所属组件),子组件数值的变化不会同步到父组件。
!注意:
①@Prop修饰复杂类型时是深拷贝,在拷贝的过程中除了基本类型、Map、Set、Date、Array外,都会丢失类型。
②@Prop装饰器不能在@Entry装饰的自定义组件中使用。
@Prop变量装饰器 | 说明 |
---|---|
装饰器参数 | 无 |
同步类型 | 单向同步:对父组件状态变量值的修改,将同步给子组件@Prop装饰的变量,子组件@Prop变量的修改不会同步到父组件的状态变量上。 |
允许装饰的变量类型 | Object、class、string、number、boolean、enum类型,以及这些类型的数组。 不支持any,不支持简单类型和复杂类型的联合类型,不允许使用undefined和null。 支持Date类型。 必须指定类型。 说明 : 不支持Length、ResourceStr、ResourceColor类型,Length,ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。 在父组件中,传递给@Prop装饰的值不能为undefined或者null,反例如下所示。 CompA ({ aProp: undefined }) CompA ({ aProp: null }) @Prop和数据源类型需要相同,有以下三种情况: - @Prop装饰的变量和@State以及其他装饰器同步时双方的类型必须相同 - @Prop装饰的变量和@State以及其他装饰器装饰的数组的项同步时 ,@Prop的类型需要和@State装饰的数组的数组项相同,比如@Prop : T和@State : Array - 当父组件状态变量为Object或者class时,@Prop装饰的变量和父组件状态变量的属性类型相同 |
嵌套传递层数 | 在组件复用场景,建议@Prop深度嵌套数据不要超过5层,嵌套太多会导致深拷贝占用的空间过大以及GarbageCollection(垃圾回收),引起性能问题,此时更建议使用@ObjectLink。 |
被装饰变量的初始值 | 允许本地初始化。 |
传递/访问 | 说明 |
---|---|
从父组件初始化 | 如果本地有初始化,则是可选的。没有的话,则必选,支持父组件中的常规变量(常规变量对@Prop赋值,只是数值的初始化,常规变量的变化不会触发UI刷新。只有状态变量才能触发UI刷新)、@State、@Link、@Prop、@Provide、@Consume、@ObjectLink、@StorageLink、@StorageProp、@LocalStorageLink和@LocalStorageProp去初始化子组件中的@Prop变量。 |
用于初始化子组件 | @Prop支持去初始化子组件中的常规变量、@State、@Link、@Prop、@Provide。 |
是否支持组件外访问 | @Prop装饰的变量是私有的,只能在组件内访问。 |
创建组件,只能在组件中使用
@Component
export default struct PropTest {
@Prop yuanZhen:string ="222"
build() {
Row() {
Column() {
Text("name:" + this.yuanZhen)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.yuanZhen = "888"
})
}.width('100%')
}.height('100%')
}
}
引用组件:
import PropTest from './PropTest';
@Entry
@Component
struct Index {
build() {
Column(){
PropTest()
}
}
}
运行:
创建两个类:
export default class YuanZhen {
public name: string = 'YuanZhen';
public age: number = 18;
constructor(name: string, age: number) {
this.name = name
this.age = age
}
}
import YuanZhen from './YuanZhen';
export default class Yuan {
public number: number = 1;
public yuanZhen: YuanZhen = new YuanZhen('yuanzhen', 18);
constructor(number: number, yuanZhen: YuanZhen) {
this.number = number
this.yuanZhen = yuanZhen
}
}
在组件中应用:
import Yuan from './bean/Yuan'
@Component
export default struct PropTest {
@Prop yuanZhen:Yuan
build() {
Row() {
Column() {
Text("name:" + this.yuanZhen.yuanZhen.name+"\nage:"+this.yuanZhen.yuanZhen.age+"\nnumber:"+this.yuanZhen.number)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.yuanZhen.number=26
this.yuanZhen.yuanZhen.age=30
this.yuanZhen.yuanZhen.name="袁世震"
})
}.width('100%')
}.height('100%')
}
}
传值给组件:
import Yuan from './bean/Yuan';
import YuanZhen from './bean/YuanZhen';
import PropTest from './PropTest';
@Entry
@Component
struct Index {
build() {
Column(){
PropTest({yuanZhen:new Yuan(1,new YuanZhen("袁震",22))})
}
}
}
结果:
所以,当装饰的类型是Object或者class复杂类型时,可以观察到所有的属性的变化
①使用父组件中@State变量的值初始化子组件中的@Prop变量。当@State变量变化时,该变量值也会同步更新至@Prop变量。
②@Prop装饰的变量的修改不会影响其数据源@State装饰变量的值。
③除了@State,数据源也可以用@Link或@Prop装饰,对@Prop的同步机制是相同的。
④数据源和@Prop变量的类型需要相同,@Prop允许简单类型和class类型。
!注意:
初始渲染:
- 执行父组件的build()函数将创建子组件的新实例,将数据源传递给子组件;
- 初始化子组件@Prop装饰的变量。
更新:
- 子组件@Prop更新时,更新仅停留在当前子组件,不会同步回父组件;
- 当父组件的数据源更新时,子组件的@Prop装饰的变量将被来自父组件的数据源重置,所有@Prop装饰的本地的修改将被父组件的更新覆盖。
在父组件定义一个变量a,并传递到子组件
import PropTest from './PropTest';
@Entry
@Component
struct Index {
@State a:number=2
build() {
Column(){
Text("a="+this.a)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.a =66
})
PropTest({a:this.a})
}
}
}
@Component
export default struct PropTest {
@Prop a:number
build() {
Row() {
Column() {
Text("a:" +this.a)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.a =888
})
}.width('100%')
}.height('100%')
}
}
运行:
当点击上面的a=2时,运行结果
当点击a:66时,运行结果:
所以:当父组件的数据源更新时,子组件的@Prop装饰的变量将被来自父组件的数据源重置,所有@Prop装饰的本地的修改将被父组件的更新覆盖,当子组件@Prop更新时,更新仅停留在当前子组件,不会同步回父组件
父组件:
import Yuan from './bean/Yuan';
import YuanZhen from './bean/YuanZhen';
import PropTest from './PropTest';
@Entry
@Component
struct Index {
@State yuan:Yuan=new Yuan(2,new YuanZhen("袁震",18))
build() {
Column(){
Text("name:" + this.yuan.yuanZhen.name+"\nage:"+this.yuan.yuanZhen.age+"\nnumber:"+this.yuan.number)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.yuan.number=1
this.yuan.yuanZhen.age=32
this.yuan.yuanZhen.name="袁震1"
})
PropTest({yuan:this.yuan})
}
}
}
子组件:
import Yuan from './bean/Yuan'
@Component
export default struct PropTest {
@Prop yuan:Yuan
build() {
Row() {
Column() {
Text("name:" + this.yuan.yuanZhen.name+"\nage:"+this.yuan.yuanZhen.age+"\nnumber:"+this.yuan.number)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.yuan.number=26
this.yuan.yuanZhen.age=30
this.yuan.yuanZhen.name="袁世震"
})
}.width('100%')
}.height('100%')
}
}
运行:
点击上面的text:
点击下面的text:
@Prop需要被初始化,如果没有进行本地初始化的,则必须通过父组件进行初始化。如果进行了本地初始化,那么是可以不通过父组件进行初始化的。