vue3.x新特性之setup函数,看完就会用了

最近有小伙伴跟我聊起setup函数,因为习惯了vue2.x的写法导致了,setup用起来觉得奇奇怪怪的,在一些api混编的情况下,代码变得更加混乱了,个人觉得在工程化思想比较强的团队中使用setup确实能更好的使用模块化开发,但是用得不好的话也确实降低了代码的可读性。本篇文章是从使用角度来聊聊setup的实际使用。

setup 使用

1、setup和以前的api(data,methods,computed等)并不冲突,也是可以相互访问的,值得注意的是setup里面不能用this,并且在setup执行的时候组件实例还未创建完毕,故不也能使用data,methods,computed定义的变量和函数。如下混编示例:

import { getCurrentInstance} from 'vue'

setup() {
  const count = 10; // 非响应式的。

  const { proxy } = getCurrentInstance(); // 这里 proxy 相当于this
  console.log(proxy.msg) // 不能在setup调用时访问data里面的属性

  return {
    count,
    consoleMsg: () => {
      console.log(proxy.msg) // 123,点击按钮时可以访问了
    }
  }
},
data() {
  return {
    msg: '123'
  }
},
created() {
  console.log(this.count) // 10,这时可以访问setup抛出的属性了。
}

2、setup 还可以返回一个渲染函数,不过返回一个渲染函数将阻止我们返回任何其它的东西,当我们想暴漏函数给其父组件使用的时候,可以使用expose来处理这个问题。示例如下:

import { h, ref } from 'vue'

export default {
  setup(props, { expose }) {
    const count = ref(0) // 创建一个响应式的变量
    const increment = () => ++count.value

    expose({
      increment
    })

    return () => h('div', count.value) // 请注意这里我们需要显式使用 ref 的 value
  }
}

看到这里就完全可以使用setup来做项目了,接下来就是封山开路遇水搭桥,碰到不会的就各种查,磕磕碰碰总能成功。然而一篇帖子不能写到这里就结束了,后面还有一大堆相关的知识点呢。

响应式

为什么聊响应式呢,因为setup里面返回的变量虽然可以直接在模版语法中使用,但是它并不是响应式的,如上面第一个示例,我们如果在模版中使用了{{ count }}来展示count的值,然后我们改变count的值,值改变了,但是显示不会变化。

// 非响应式示例,等价于错误示例,请尽量不要复制这块代码到你项目中去了。
<template>
  <div>
    <span>{{ count }}</span>
    <button @click="count ++; consoleValue(count)">Increment count</button>
  </div>
</template>

<script>
  export default {
    setup() {
      let count = 10; // 这里不是响应式的。
      return {
        count,
        consoleValue: (value) => {
          console.log(value); // 这里值发生了变化
        }
      }
    }
  }
</script>

响应式这块在官网api比较多,只说几个用得比较多的。
1、上面有提到的ref,ref 接收参数并将其包裹在一个带有 value property 的对象中返回,然后可以使用该 property 访问或更改响应式变量的值。最简单的例子,上面示例改成响应式的,如下:

<template>
  <div>
    <span>{{ count }}</span>
    <button @click="count ++">Increment count</button>
    <button @click="doubleCount">double count</button>
  </div>
</template>

<script>
  import { ref } from 'vue'

  export default {
    setup() {
      let count = ref(10);
      return {
        count,
        doubleCount: () => {
          // 值得注意在setup里面需要使用.value来访问
          count.value *= 2;
        }
      }
    }
  }
</script>

2、reactive返回对象的响应式副本。这个比较好理解,跟以前2.x时代差别不大。

<template>
  <div>
    <span>{{ countObj.count }}</span>
    <button @click="countObj.count ++">Increment count</button>
    <button @click="doubleCount">double count</button>
  </div>
</template>

<script>
  import { reactive } from 'vue'

  export default {
    setup() {
      const countObj = reactive({ count: 10 });
      return {
        countObj,
        doubleCount: () => {
          countObj.count *= 2;
        }
      }
    }
  }
</script>

3、toRef 和 toRefs 这两个函数都是为了获取一个响应式的子项,并且跟以前的响应式数据进行关联

<template>
  <div>
    <div>{{ countObj.count }} {{countObj.changeTimes}}</div>
    <div>{{ count }} {{ changeTimes }}</div>
    <button @click="count ++; changeTimes ++">increment count</button>
    <button @click="doubleCount">double count</button>
  </div>
</template>

<script>
  import { reactive, toRefs, toRef } from 'vue'

  export default {
    setup() {
      const countObj = reactive({ count: 10, changeTimes: 0 });
      const { count } = toRefs(countObj);
      const changeTimes = toRef(countObj, 'changeTimes');
      return {
        countObj,
        count,
        changeTimes,
        doubleCount: () => {
          countObj.count *= 2;
          changeTimes.value ++;
        }
      }
    }
  }
</script>

注意:toRefs 只会为源对象中包含的 property 生成 ref。如果要为特定的 property 创建 ref,则应当使用toRef,简单粗暴的理解toRef可以给源对象添加一个关联的响应式属性,如:(本想写在上面示例中,不过感觉不清晰,就单独列了一块伪代码)

const countObj = reactive({ count: 10 });
const testV = toRef(countObj, 'test');

testV.value = 10;
console.log(countObj.test); // 10

setup 参数

使用 setup 函数时,它将接收两个参数:
Props
setup 函数中的第一个参数是 props。正如在一个标准组件中所期望的那样,setup 函数中的 props 是响应式的,当传入新的 prop 时,它将被更新。

export default {
  props: {
    title: String
  },
  setup(props) {
    console.log(props.title)
  }
}

但是,因为 props 是响应式的,你不能使用 ES6 解构,它会消除 prop 的响应性,上面说到的toRefs可以很好的解决这个问题。

import { toRefs } from 'vue'

setup(props) {
  const { title } = toRefs(props)
  console.log(title.value)
}

如果 title 是可选的 prop,则传入的 props 中可能没有 title 。在这种情况下,toRefs 将不会为 title 创建一个 ref 。你需要使用 toRef 替代它:

import { toRef } from 'vue'
setup(props) {
  const title = toRef(props, 'title')
  console.log(title.value)
}

Context
传递给 setup 函数的第二个参数是 contextcontext 是一个普通 JavaScript 对象,暴露了其它可能在 setup 中有用的值:

export default {
  setup(props, context) {
    // Attribute (非响应式对象,等同于 $attrs)
    console.log(context.attrs)

    // 插槽 (非响应式对象,等同于 $slots)
    console.log(context.slots)

    // 触发事件 (方法,等同于 $emit)
    console.log(context.emit)

    // 暴露公共 property (函数)
    console.log(context.expose)
  }
}

setup生命周期钩子

在setup中可以访问到以下生命周期钩子:

  • onBeforeMount
  • onMounted
  • onBeforeUpdate
  • onUpdated
  • onBeforeUnmount
  • onUnmounted
  • onErrorCaptured
  • onRenderTracked
  • onRenderTriggered
  • onActivated
  • onDeactivated

这些函数接受一个回调函数,当钩子被组件调用时将会被执行,如:

export default {
  setup() {
    // mounted
    onMounted(() => {
      console.log('Component is mounted!')
    })
  }
}

原创不易,转载请注明出处,欢迎留言提议。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,312评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,578评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,337评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,134评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,161评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,303评论 1 280
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,761评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,421评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,609评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,450评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,504评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,194评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,760评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,836评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,066评论 1 257
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,612评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,178评论 2 341

推荐阅读更多精彩内容