Vue 使用中的小技巧

SHERlocked93發表於2019-03-04

在vue的使用過程中會遇到各種場景,當普通使用時覺得沒什麼,但是或許優化一下可以更高效更優美的進行開發。下面有一些我在日常開發的時候用到的小技巧,在下將不定期更新~

1. 多圖表resize事件去中心化

1.1 一般情況

有時候我們會遇到這樣的場景,一個元件中有幾個圖表,在瀏覽器resize的時候我們希望圖表也進行resize,因此我們會在父容器元件中寫:

mounted() {
  setTimeout(() => window.onresize = () => {
    this.$refs.chart1.chartWrapperDom.resize()
    this.$refs.chart2.chartWrapperDom.resize()
    // ... 
  }, 200)
destroyed() { window.onresize = null }
複製程式碼

這樣子圖表元件如果跟父容器元件不在一個頁面,子元件的狀態就被放到父元件進行管理,為了維護方便,我們自然希望子元件的事件和狀態由自己來維護,這樣在新增刪除元件的時候就不需要去父元件挨個修改

1.2 優化

這裡使用了lodash的節流throttle函式,也可以自己實現,這篇文章也有節流的實現可以參考一下。
以Echarts為例,在每個圖表元件中:

computed: {
  /**
   * 圖表DOM
   */
  chartWrapperDom() {
    const dom = document.getElementById(`consume-analy-chart-wrapper`)
    return dom && Echarts.init(dom)
  },
  /**
   * 圖表resize節流,這裡使用了lodash,也可以自己使用setTimout實現節流
   */
  chartResize() {
    return _.throttle(() => this.chartWrapperDom && this.chartWrapperDom.resize(), 400)
  }
},
mounted() {
  window.addEventListener(`resize`, this.chartResize)
},
destroyed() {
  window.removeEventListener(`resize`, this.chartResize)
}
複製程式碼

1.3 再次優化

感謝 @JserWang 的提醒,這裡因為多個 chart 例項都使用同一套初始化邏輯,可以使用 extends 來考慮複用,因此我想到了 Vue 提供的 Mixins,所以我在這裡做了點優化,可以讓每個同型別的 chart 元件更優雅一點:
新建一個 mixin.js 檔案:

import Echarts from `echarts`
import _ from `lodash`

export default {
  computed: {
    /* 圖表DOM */
    $_chartMixin_chartWrapperDom() {
      const dom = document.getElementById(this.thisDomId)
      return dom && Echarts.init(dom)
    },
    
    /** 圖表resize節流,這裡使用了lodash,也可以自己使用setTimout實現節流 */
    $_chartMixin_chartResize() {
      return _.throttle(() => this.$_chartMixin_chartWrapperDom.resize(), 400)
    }
  },
  
  methods: {
    /* 圖表初始化 */
    $_chartMixin_initChart() {
      this.$_chartMixin_chartWrapperDom.setOption({ /* options */ }
  },
  
  mounted() {
    this.$_chartMixin_initChart()
    window.addEventListener(`resize`, this.$_chartMixin_chartResize)
  },
  
  destroyed() {
    window.removeEventListener(`resize`, this.$_chartMixin_chartResize)
  }
}
複製程式碼

然後在每個 chart 元件中:

<script type=`text/javascript`>
import ChartMixin from `./mixin`
export default {
  mixins: [ChartMixin],
  data() {
    return {
      thisDomId: `consume-analy-chart-wrapper`
    }
  }
}
</script>
複製程式碼

這樣就可以在每個圖表元件中混入之前在 mixin.js 中定義的 resize 事件邏輯,且自動初始化,並在 destroyed 的時候自動銷燬事件~

2. 全域性過濾器註冊

2.1 一般情況

官方註冊過濾器的方式:

export default {
  data () { return {} },
  filters:{
    orderBy (){
      // doSomething
    },
    uppercase () {
      // doSomething
    }
  }
}
複製程式碼

但是我們做專案來說,大部分的過濾器是要全域性使用的,不會每每用到就在元件裡面去寫,抽成全域性的會更好些。
官方註冊全域性的方式:

// 註冊
Vue.filter(`my-filter`, function (value) {
  // 返回處理後的值
})
// getter,返回已註冊的過濾器
var myFilter = Vue.filter(`my-filter`)
複製程式碼

但是分散寫的話不美觀,因此可以抽出成單獨檔案。

2.2 優化

我們可以抽出到獨立檔案,然後使用Object.keys在main.js入口統一註冊

/src/common/filters.js

let dateServer = value => value.replace(/(d{4})(d{2})(d{2})/g, `$1-$2-$3`) 

export { dateServer }
複製程式碼

/src/main.js

import * as custom from `./common/filters/custom`
Object.keys(custom).forEach(key => Vue.filter(key, custom[key]))
複製程式碼

然後在其他的.vue 檔案中就可愉快地使用這些我們定義好的全域性過濾器了

<template>
  <section class="content">
    <p>{{ time | dateServer }}</p> <!-- 2016-01-01 -->
  </section>
</template>
<script>
  export default {
    data () {
      return {
        time: 20160101
      }
    }
  }
</script>
複製程式碼

3. 全域性元件註冊

3.1 一般情況

需要使用元件的場景:

<template>
    <BaseInput  v-model="searchText"  @keydown.enter="search"/>
    <BaseButton @click="search">
        <BaseIcon name="search"/>
    </BaseButton>
</template>
<script>
    import BaseButton from `./baseButton`
    import BaseIcon from `./baseIcon`
    import BaseInput from `./baseInput`
    export default {
      components: { BaseButton, BaseIcon, BaseInput }
    }
</script>
複製程式碼

我們寫了一堆基礎UI元件,然後每次我們需要使用這些元件的時候,都得先import,然後宣告components,很繁瑣,這裡可以使用統一註冊的形式

3.2 優化

我們需要藉助一下神器webpack,使用 require.context() 方法來建立自己的模組上下文,從而實現自動動態require元件。這個方法需要3個引數:要搜尋的資料夾目錄、是否還應該搜尋它的子目錄、以及一個匹配檔案的正規表示式。
我們在components資料夾新增一個叫componentRegister.js的檔案,在這個檔案裡藉助webpack動態將需要的基礎元件統統打包進來。

/src/components/componentRegister.js

import Vue from `vue`

/**
 * 首字母大寫
 * @param str 字串
 * @example heheHaha
 * @return {string} HeheHaha
 */
function capitalizeFirstLetter(str) {
  return str.charAt(0).toUpperCase() + str.slice(1)
}

/**
 * 對符合`xx/xx.vue`元件格式的元件取元件名
 * @param str fileName
 * @example abc/bcd/def/basicTable.vue
 * @return {string} BasicTable
 */
function validateFileName(str) {
  return /^S+.vue$/.test(str) &&
    str.replace(/^S+/(w+).vue$/, (rs, $1) => capitalizeFirstLetter($1))
}

const requireComponent = require.context(`./`, true, /.vue$/)

// 找到元件資料夾下以.vue命名的檔案,如果檔名為index,那麼取元件中的name作為註冊的元件名
requireComponent.keys().forEach(filePath => {
  const componentConfig = requireComponent(filePath)
  const fileName = validateFileName(filePath)
  const componentName = fileName.toLowerCase() === `index`
    ? capitalizeFirstLetter(componentConfig.default.name)
    : fileName
  Vue.component(componentName, componentConfig.default || componentConfig)
})
複製程式碼

這裡資料夾結構:

components
│ componentRegister.js
├─BasicTable
│ BasicTable.vue
├─MultiCondition
│ index.vue
複製程式碼

這裡對元件名做了判斷,如果是index的話就取元件中的name屬性處理後作為註冊元件名,所以最後註冊的元件為:multi-conditionbasic-table
最後我們在main.js中import `components/componentRegister.js`,然後我們就可以隨時隨地使用這些基礎元件,無需手動引入了~

4. 不同路由的元件複用

4.1 場景還原

當某個場景中vue-router從/post-page/a,跳轉到/post-page/b。然後我們驚人的發現,頁面跳轉後資料竟然沒更新?!原因是vue-router”智慧地”發現這是同一個元件,然後它就決定要複用這個元件,所以你在created函式裡寫的方法壓根就沒執行。通常的解決方案是監聽$route的變化來初始化資料,如下:

data() {
  return {
    loading: false,
    error: null,
    post: null
  }
},
watch: {
  `$route`: {        // 使用watch來監控是否是同一個路由
    handler: `resetData`,
    immediate: true
  }
},
methods: {
  resetData() {
    this.loading = false
    this.error = null
    this.post = null
    this.getPost(this.$route.params.id)
  },
  getPost(id){ }
}
複製程式碼

4.2 優化

為了實現這樣的效果可以給router-view新增一個不同的key,這樣即使是公用元件,只要url變化了,就一定會重新建立這個元件。

<router-view :key="$route.fullpath"></router-view>
複製程式碼

還可以在其後加+ +new Date()時間戳,保證獨一無二

感謝網友 @rolitter 的提醒,如果元件被放在<keep-alive>中的話,可以把獲取新資料的方法放在activated鉤子,代替原來在created、mounted鉤子中獲取資料的任務。

5. 元件事件屬性穿透

5.1 一般情況

// 父元件
<BaseInput :value="value"
           label="密碼"
           placeholder="請填寫密碼"
           @input="handleInput"
           @focus="handleFocus">
</BaseInput>

// 子元件
<template>
  <label>
    {{ label }}
    <input :value=" value"
           :placeholder="placeholder"
           @focus="$emit(`focus`, $event)"
           @input="$emit(`input`, $event.target.value)">
  </label>
</template>
複製程式碼

5.2 優化

vue的元件例項中的$props$attrs給我們提供了很大的便利,特別是父子元件傳值的時候。
1、 每一個從父元件傳到子元件的props,我們都得在子元件的Props中顯式的宣告才能使用。這樣一來,我們的子元件每次都需要申明一大堆props,這裡我們知道v-bind 是可以傳物件的,可以在 vm.$props 中拿到所有父元件props的值 v-bind="$props"

<input  v-bind="$props" 
       @input="$emit(`input`, $event.target.value)">
複製程式碼

2、 類似placeholer這種dom原生的property可以使用$attrs直接從父傳到子,無需宣告。方法如下:

<input :value="value"
       v-bind="$attrs"
       @input="$emit(`input`, $event.target.value)">
複製程式碼

$attrs包含了父作用域中不作為 prop 被識別 (且獲取) 的特性繫結 (class 和 style 除外)。當一個元件沒有宣告任何 prop 時,這裡會包含所有父作用域的繫結,並且可以通過 v-bind="$attrs" 傳入內部元件。

3、 注意到子元件的@focus="$emit(`focus`, $event)"其實什麼都沒做,只是把event傳回給父元件而已,那其實和上面類似,完全沒必要顯式地申明:

<input :value="value"
       v-bind="$attrs"
       v-on="listeners"/>

computed: {
  listeners() {
    return {
      ...this.$listeners,
      input: event =>
        this.$emit(`input`, event.target.value)
    }
  }
}
複製程式碼

$listeners包含了父作用域中的 (不含 .native 修飾器的) v-on 事件監聽器。它可以通過 v-on="$listeners" 傳入內部元件——在建立更高層次的元件時非常有用。

需要注意的是,由於我們input並不是BaseInput這個元件的根節點,而預設情況下父作用域的不被認作 props 的特性繫結將會“回退”且作為普通的 HTML 特性應用在子元件的根元素上。所以我們需要設定 inheritAttrs: false,這些預設行為將會被去掉,上面優化才能成功。

6. 路由根據開發狀態懶載入

6.1 一般情況

一般我們在路由中載入元件的時候:

import Login from `@/views/login.vue`

export default new Router({
  routes: [{ path: `/login`, name: `登陸`, component: Login}]
})
複製程式碼

當你需要懶載入 lazy-loading 的時候,需要一個個把routes的component改為() => import(`@/views/login.vue`),甚為麻煩。

當你的專案頁面越來越多之後,在開發環境之中使用 lazy-loading 會變得不太合適,每次更改程式碼觸發熱更新都會變得非常的慢。所以建議只在生成環境之中使用路由懶載入功能。

6.2 優化

根據Vue的非同步元件和Webpack的程式碼分割功能可以輕鬆實現元件的懶載入,如:

const Foo = () => import(`./Foo.vue`)
複製程式碼

在區分開發環境與生產環境時,可以在路由資料夾下分別新建兩個檔案:

_import_production.js

module.exports = file => () => import(`@/views/` + file + `.vue`)
複製程式碼

_import_development.js (這種寫法vue-loader版本至少v13.0.0以上)

module.exports = file => require(`@/views/` + file + `.vue`).default
複製程式碼

而在設定路由的router/index.js檔案中:

const _import = require(`./_import_` + process.env.NODE_ENV)

export default new Router({
  routes: [{ path: `/login`, name: `登陸`, component: _import(`login/index`) }]
})
複製程式碼

這樣元件在開發環境下就是非懶載入,生產環境下就是懶載入的了

7 vue-loader小技巧

vue-loader 是處理 *.vue 檔案的 webpack loader。它本身提供了豐富的 API,有些 API 很實用但很少被人熟知。例如接下來要介紹的 preserveWhitespacetransformToRequire

7.1 用 preserveWhitespace 減少檔案體積

有些時候我們在寫模板時不想讓元素和元素之間有空格,可能會寫成這樣:

<ul>
  <li>1111</li><li>2222</li><li>333</li>
</ul>
複製程式碼

當然還有其他方式,比如設定字型的font-size: 0,然後給需要的內容單獨設定字型大小,目的是為了去掉元素間的空格。其實我們完全可以通過配置 vue-loader 實現這一需求。

{
  vue: {
    preserveWhitespace: false
  }
}
複製程式碼

它的作用是阻止元素間生成空白內容,在 Vue 模板編譯後使用 _v(" ") 表示。如果專案中模板內容多的話,它們還是會佔用一些檔案體積的。例如 Element 配置該屬性後,未壓縮情況下檔案體積減少了近 30Kb。

7.2 使用 transformToRequire 再也不用把圖片寫成變數了

以前在寫 Vue 的時候經常會寫到這樣的程式碼:把圖片提前 require 傳給一個變數再傳給元件。

<template>
  <div>
    <avatar :default-src="DEFAULT_AVATAR"></avatar>
  </div>
</template>
<script>
  export default {
    created () {
      this.DEFAULT_AVATAR = require(`./assets/default-avatar.png`)
    }
  }
</script>
複製程式碼

其實通過配置 transformToRequire 後,就可以直接配置,這樣vue-loader會把對應的屬性自動 require 之後傳給元件

{
  vue: {
    transformToRequire: {
      avatar: [`default-src`]
    }
  }
}
複製程式碼

於是我們程式碼就可以簡化不少

<template>
  <div>
    <avatar default-src="./assets/default-avatar.png"></avatar>
  </div>
</template>
複製程式碼

在 vue-cli 的 webpack 模板下,預設配置是:

transformToRequire: {
  video: [`src`, `poster`],
  source: `src`,
  img: `src`,
  image: `xlink:href`
}
複製程式碼

可以舉一反三進行一下類似的配置

vue-loader 還有很多實用的 API 例如最近加入的 自定義塊,感興趣的各位可以去文件裡找找看。

8. render 函式

在某些場景下你可能需要 render 渲染函式帶來的完全程式設計能力來解決不太容易解決的問題,特別是要動態選擇生成標籤和元件型別的場景。

8.1 動態標籤

1. 一般情況

比如根據props來生成標籤的場景

<template>
  <div>
    <div v-if="level === 1"> <slot></slot> </div>
    <p v-else-if="level === 2"> <slot></slot> </p>
    <h1 v-else-if="level === 3"> <slot></slot> </h1>
    <h2 v-else-if="level === 4"> <slot></slot> </h2>
    <strong v-else-if="level === 5"> <slot></slot> </stong>
    <textarea v-else-if="level === 6"> <slot></slot> </textarea>
  </div>
</template>
複製程式碼

其中level是data中的變數,可以看到這裡有大量重複程式碼,如果邏輯複雜點,加上一些繫結和判斷就更復雜了,這裡可以利用 render 函式來對要生成的標籤加以判斷。

2. 優化

使用 render 方法根據引數來生成對應標籤可以避免上面的情況。

<template>
  <div>
    <child :level="level">Hello world!</child>
  </div>
</template>

<script type=`text/javascript`>
  import Vue from `vue`
  Vue.component(`child`, {
    render(h) {
      const tag = [`div`, `p`, `strong`, `h1`, `h2`, `textarea`][this.level]
      return h(tag, this.$slots.default)
    },
    props: {
      level: {  type: Number,  required: true  } 
    }
  })   
  export default {
    name: `hehe`,
    data() { return { level: 3 } }
  }
</script>
複製程式碼

示例可以檢視 CodePen

8.2 動態元件

當然render函式還有很多用法,比如要使用動態元件,除了使用 :is 之外也可以使用render函式

<template>
  <div>
    <button @click=`level = 0`>嘻嘻</button>
    <button @click=`level = 1`>哈哈</button>
    <hr>
    <child :level="level"></child>
  </div>
</template>

<script type=`text/javascript`>
  import Vue from `vue`
  import Xixi from `./Xixi`
  import Haha from `./Haha`
  Vue.component(`child`, {
    render(h) {
      const tag = [`xixi`, `haha`][this.level]
      return h(tag, this.$slots.default)
    },
    props: { level: { type: Number, required: true } },
    components: { Xixi, Haha }
  })
  export default {
    name: `hehe`,
    data() { return { level: 0 } }
  }
</script>
複製程式碼

示例可以檢視 CodePen


@20180702 新增 @JserWang 提醒的多圖示事件去中心化優化方法


網上的帖子大多深淺不一,甚至有些前後矛盾,在下的文章都是學習過程中的總結,如果發現錯誤,歡迎留言指出~

參考:

  1. Vue2 全域性過濾器(vue-cli)
  2. Vue.js最佳實踐
  3. webpack文件 – require.context
  4. 使用webpack的require.context實現路由“去中心化”管理
  5. vue-element-admin 文件
  6. Vue.js 的實用技巧
  7. 優化頁面的開啟速度,要不要了解一下~
Vue 使用中的小技巧

相關文章