【Vue】当你 watch 一个 computed value…

各位五一快乐,最近工作比较忙,来拿点工作中遇到的问题水一水。在 Vue 中我们经常使用 watch 来监听响应式变量的变化。有时,我们需要监听多个变量,但执行同样的逻辑,这时写多个 watch 就很浪费。不难想到,可以使用 computed 把这几个变量组合起来,这样只需监听这个单独的计算属性就可以了。

下面的例子展示了这一用法:当 id 和 Post 表单的 title 属性变化时,打印一行日志。

<!-- App.vue -->
<script>
export default {
  data() {
    return {
      id: 1,
      post: {
        title: 'hello world',
        desc: 'Lorem ipsum'
      }
    }
  },
  computed: {
    mutableParams() {
      return {
        id: this.id,
        title: this.post.title
      }
    }
  },
  watch: {
    mutableParams: {
      handler() {
        console.log('triggered')
      }
    }
  }
}
</script>
<template>
  <div>ID: <input v-model="id" /></div>
  <div>Post Title: <input v-model="post.title" /></div>
  <div>Post Desc: <input v-model="post.desc" /></div>
</template>

但现实往往并没有那么简单。假设我们需要把 Post 表单封装成一个单独的组件:

<!-- PostForm.vue -->
<script>
export default {
  props: {
    modelValue: {
      type: Object,
      required: true
    }
  },
  methods: {
    emit(key, value) {
      this.$emit('update:modelValue', { ...this.modelValue, [key]: value })
    }
  }
}
</script>
<template>
  <div>Post Title: <input :value="modelValue.title" @input="emit('title', $event.target.value)" /></div>
  <div>Post Desc: <input :value="modelValue.desc" @input="emit('desc', $event.target.value)" /></div>
</template>

然后用这个组件替换掉上文的例子:

<!-- App.vue -->
...
<template>
  <div>ID: <input v-model="id" /></div>
-   <div>Post Title: <input v-model="post.title" /></div>
-   <div>Post Desc: <input v-model="post.desc" /></div>
+   <post-form v-model="post" />
</template>

看上去一切天衣无缝。但倘若你编辑了 Post 表单的 desc 属性,会发现日志依旧被打出了,即使我们并没有监听 desc 的变化。这显然是与我们的预期不符的。
……
……
相信各位身经百战的读者们很快就能发现问题所在。当 PostForm 封装为组件之后,无论是修改 title 还是 desc ,都会为 post 对象赋一个新值。而 Vue 的 computed 通过依赖收集机制,将 this.post 作为了依赖。一旦 post 对象改变,就会重新触发 computed 生成新的 mutableParams 对象,进而触发 watch 的逻辑。


那么我们该如何解决这个问题呢?

一个显而易见的想法是,既然问题出在每次编辑都会产生一个新的 post 对象,那么我们只要让编辑前后的 post 对象保持不变就可以了。基于这种思路,可做出如下改动:

<!-- PostForm.vue -->
...
  methods: {
    emit(key, value) {
-     this.$emit('update:modelValue', { ...this.modelValue, [key]: value })
+     this.$emit('update:modelValue', Object.assign(this.modelValue, { [key]: value }))
    }
  }
...

虽然这样解决了问题,但这并不是种好做法。该方法本质上是直接修改了组件 prop 的值,而这是官方文档中明确不推荐的,会让数据流变得混乱。这种场景下我们把对象作为值类型,还是使用不可变数据结构更好一些。

另一个问题是,一个合理的组件设计,调用者只需关注它对外暴露的接口,而无需关心内部实现。但这种情况下不同的内部实现却会影响到外部逻辑的正确性,这显然是不合理的。更何况很多时候我们根本无法控制某个第三方组件的内部实现。


还有个比较简单粗暴的想法是,既然是 watch computed value 引发的问题,那干脆回归到最原始的模式,只 watch primitive value,这样就不用考虑引用变化的问题。在这种做法上 Vue3 有着绝对的优势,因为 Vue3 的 watch API 支持传入多个值:

<!-- App.vue -->
<script setup>
import PostForm from './PostForm.vue'
import {watch, ref} from 'vue'
  
const id = ref(1)
const post = ref({ title: 'hello world', desc: 'Lorem ipsum' })
  
watch([() => id.value, () => post.value.title], () => {
  console.log('triggered')
})
</script>

在老项目中,如果要一个一个写 watch option 也太蠢了。可以利用 computed + 循环 + $watch 来模拟类似的效果:

  mounted() {
    Object.keys(this.mutableParams).forEach(key => {
      this.$watch(() => this.mutableParams[key], () => {
        console.log('triggered')
      })
    })
  }

姑且不提这种做法很不优雅,即使它可以解决示例的这一个问题,但也难以成为一种通用的解决方案。如果我们的 mutableParams 需可动态配置、会增减字段,或是存在更深的嵌套层次等,就很难继续按照这个思路写下去了。


我们还是需要循其本。当我们使用 watch 时,我们期望的效果是当 watch 的目标值变化时触发监听。但 watch 的实现原理是,当目标的依赖变化时触发监听。虽然在绝大多数的情况下两者的效果是相等的,但它们并不是彼此的充要条件。

如果我们监听的目标值发生了变化,那么一定是它的依赖发生了变化,但反过来,当它的依赖发生变化时,并不能推出目标值最终也一定变化了。而这个例外,最容易出现的情况就是在 watch 一个 computed value 时。

严格来说,问题的根源是我们期望的“变化”与代码层面的“变化”定义不同。因此,如果我们能够自定义判断是否“变化”的方法(类似重写 JavaBean 的 equals 方法),这个问题就迎刃而解了。

与 Vue 响应式原理类似的状态管理库 MobX 就内置了类似的方法。在 MobX 中,可以在定义 computedwatch 时提供一个自定义的比较函数,如下例所示:

const data = observable({
  id: 1,
  post: {
    title: 'hello world',
    desc: 'Lorem ipsum'
  }
})

const mutableParams = computed(() => ({
  id: data.id,
  title: data.post.title
}))

// 相当于 Vue 中的 watch
reaction(
  () => mutableParams.get(), 
  () => console.log('triggered'),
  // 对前后的值做一次浅比较,结果不同时才触发监听器逻辑
  // 也可以换成深比较,或任何自定义的比较逻辑
  { equals: comparer.shallow }
)

runInAction(() => {
  // 不会触发 console.log
  data.post = {
    title: 'hello world',
    desc: 'something else'
  }
})

Vue 并没有提供这种开箱即用的内置选项,不过在有了思路之后也很容易自己实现。考虑到无论哪种比较方式的必要条件都是依赖发生变化,我们只需在 watch 内部额外做一层判断即可。

<!-- App.vue -->
...
  watch: {
    mutableParams: {
      handler(newValue, oldValue) {
        // equals 是任意的判断相等性的方法
        if (!equals(newValue, oldValue)) {
          console.log('triggered')
        }
      }
    }
  }
...


总的来说不是个很难的问题,不过在复杂项目中偶然遇到一次还是挺搞人心态的。不知为何网上也都找不到相关的讨论,故在此抛砖引玉一下。如果大家有更好的想法,欢迎一起交流~

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

推荐阅读更多精彩内容

  • watchEffect 执行监听 watchEffect比较奇特,它跟Vue 2的watch有所区别,它的写法是:...
    microkof阅读 5,924评论 3 12
  • 在传统的 Web 开发过程中,当你需要实现多个站内页面时,以前你需要写很多个 html 页面,然后通过 a 标签来...
    硅谷干货阅读 2,179评论 0 1
  • (掌握)简单说下setTimeout(fn, 0)中的0代表的是什么?如果我想在vue实现此功能可以用什么方法代替...
    Enginner_XZ阅读 5,606评论 0 40
  • (掌握)简单说下setTimeout(fn, 0)中的0代表的是什么?如果我想在vue实现此功能可以用什么方法代替...
    Grit_1024阅读 1,408评论 0 22
  • 目录结构保持一致,使得多人合作容易理解与管理,提高工作效率。Vue标准项目 #简要说明 main.js主入口,ro...
    Zxinli阅读 867评论 3 1