首頁 > web前端 > Vue.js > 主體

聊聊Vue3 shared模組下38個工具函數(原始碼閱讀)

青灯夜游
發布: 2022-12-12 20:21:24
轉載
2838 人瀏覽過

聊聊Vue3 shared模組下38個工具函數(原始碼閱讀)

Vue3的工具函數對比於Vue2的工具函數變化還是很大的,個人感覺主要還是體現在語法上,已經全面擁抱es6了;【相關推薦:vuejs影片教學#web前端開發

對比於工具類別的功能變化並沒有多少,大多數基本上都是一樣的,只是語法上和實作上有略微的區別;

原始碼位址:

  • ##vue-next
  • vue-next/packages/shared/src/index.ts
#之前介紹了許多閱讀方式,這次就直接跳過了,直接開始閱讀原始碼;

所有工具函數

  • makeMap: 產生一個類似Set的對象,用於判斷是否存在某個值
  • EMPTY_OBJ: 空物件
  • EMPTY_ARR: 空數組
  • #NOOP: 空函數
  • NO: 傳回false的函數
  • isOn: 判斷是否是on 開頭的事件
  • isModelListener: 判斷onUpdate開頭的字串
  • ##extend
  • : 合併物件
  • remove
  • : 移除陣列中的某個值
  • #hasOwn
  • : 判斷物件是否有某個屬性
  • isArray
  • : 判斷是否是陣列
  • isMap
  • : 判斷是否是Map
  • isSet
  • : 判斷是否是Set
  • isDate
  • : 判斷是否為Date
  • isRegExp
  • : 判斷是否為RegExp
  • isFunction
  • : 判斷是否是函數
  • isString
  • : 判斷是否是字串
  • isSymbol
  • : 判斷是否為Symbol
  • isObject
  • : 判斷是否為物件
  • isPromise
  • #: 判斷是否是Promise
  • objectToString
  • : Object.prototype.toString##toTypeString
  • #:
  • Object.prototype.toString的簡寫toRawType
  • : 取得物件的類型
  • isPlainObject
  • : 判斷是否為普通物件
  • isIntegerKey
  • : 判斷是否為整數
  • key#isReservedProp
  • : 判斷是否為保留屬性
  • # isBuiltInDirective
  • : 判斷是否為內建指令
  • camelize
  • : 將字串轉換為駝峰
  • hyphenate
  • #: 將字串轉換為連字元
  • capitalize
  • : 將字串首字母大寫
  • #toHandlerKey
  • : 將字串轉換為事件處理的
  • key#hasChanged
  • : 判斷兩個值是否相等
  • invokeArrayFns
  • : 呼叫陣列中的函數
  • #def
  • : 定義物件的屬性
  • looseToNumber
  • : 將字串轉換為數字
  • toNumber
  • : 將字串轉換為數字
  • getGlobalThis
  • : 取得全域物件
  • genPropsAccessExp
  • : 產生
  • props的存取運算式這其中有大部分和
  • Vue2
的工具函數是一樣的,還有資料類型的判斷,使用的是同一種方式,因為有了先前

Vue2的閱讀經驗,所以這次快速閱讀;如果想要詳細的可以看我之前寫的文章:【原始碼共讀】Vue2原始碼shared 模組中的36個實用工具函數分析

;

#而且這次是直接原始碼,ts

版本的,不再處理成

js,所以直接閱讀ts原始碼;#正式開始

makeMap

export function makeMap(
  str: string,
  expectsLowerCase?: boolean
): (key: string) => boolean {
  const map: Record<string, boolean> = Object.create(null)
  const list: Array<string> = str.split(&#39;,&#39;)
  for (let i = 0; i < list.length; i++) {
    map[list[i]] = true
  }
  return expectsLowerCase ? val => !!map[val.toLowerCase()] : val => !!map[val]
}
登入後複製
makeMap

的原始碼在同級目錄下的

makeMap.ts檔案中,引入進來之後直接使用export關鍵字匯出,實作方式和Vue2的實作方式相同;

EMPTY_OBJ & EMPTY_ARR

export const EMPTY_OBJ: { readonly [key: string]: any } = __DEV__
  ? Object.freeze({})
  : {}
export const EMPTY_ARR = __DEV__ ? Object.freeze([]) : []
登入後複製

EMPTY_OBJEMPTY_ARR的实现方式和Vue2emptyObject相同,都是使用Object.freeze冻结对象,防止对象被修改;

NOOP

export const NOOP = () => {}
登入後複製

Vue2noop实现方式相同,都是一个空函数,移除了入参;

NO

/**
 * Always return false.
 */
export const NO = () => false
登入後複製

Vue2no实现方式相同,都是一个返回false的函数,移除了入参;

isOn

const onRE = /^on[^a-z]/
export const isOn = (key: string) => onRE.test(key)
登入後複製

判断是否是on开头的事件,并且on后面的第一个字符不是小写字母;

isModelListener

export const isModelListener = (key: string) => key.startsWith(&#39;onUpdate:&#39;)
登入後複製

判断是否是onUpdate:开头的字符串;

参考:startWith

extend

export const extend = Object.assign
登入後複製

直接拥抱es6Object.assignVue2的实现方式是使用for in循环;

remove

export const remove = <T>(arr: T[], el: T) => {
  const i = arr.indexOf(el)
  if (i > -1) {
    arr.splice(i, 1)
  }
}
登入後複製

对比于Vue2删除了一些代码,之前的快速删除最后一个元素的判断不见了;

猜测可能是因为有bug,因为大家都知道Vue2的数组响应式必须使用Arrayapi,那样操作可能会导致数组响应式失效;

hasOwn

const hasOwnProperty = Object.prototype.hasOwnProperty
export const hasOwn = (
  val: object,
  key: string | symbol
): key is keyof typeof val => hasOwnProperty.call(val, key)
登入後複製

使用的是Object.prototype.hasOwnProperty,和Vue2相同;

isArray

export const isArray = Array.isArray
登入後複製

使用的是Array.isArray,和Vue2相同;

isMap & isSet & isDate & isRegExp

export const isMap = (val: unknown): val is Map<any, any> =>
  toTypeString(val) === &#39;[object Map]&#39;
export const isSet = (val: unknown): val is Set<any> =>
  toTypeString(val) === &#39;[object Set]&#39;

export const isDate = (val: unknown): val is Date =>
  toTypeString(val) === &#39;[object Date]&#39;
export const isRegExp = (val: unknown): val is RegExp =>
  toTypeString(val) === &#39;[object RegExp]&#39;
登入後複製

都是使用Object.toString来判断类型,对比于Vue2新增了isMapisSetisDate,实现方式没变;

isFunction & isString & isSymbol & isObject

export const isFunction = (val: unknown): val is Function =>
  typeof val === &#39;function&#39;
export const isString = (val: unknown): val is string => typeof val === &#39;string&#39;
export const isSymbol = (val: unknown): val is symbol => typeof val === &#39;symbol&#39;
export const isObject = (val: unknown): val is Record<any, any> =>
  val !== null && typeof val === &#39;object&#39;
登入後複製

Vue2的实现方式相同,都是使用typeof来判断类型,新增了isSymbol

isPromise

export const isPromise = <T = any>(val: unknown): val is Promise<T> => {
  return isObject(val) && isFunction(val.then) && isFunction(val.catch)
}
登入後複製

Vue2对比修改了实现方式,但是判断逻辑没变;

objectToString

export const objectToString = Object.prototype.toString
登入後複製

直接是Object.prototype.toString

toTypeString

export const toTypeString = (value: unknown): string =>
  objectToString.call(value)
登入後複製

对入参执行Object.prototype.toString

toRawType

export const toRawType = (value: unknown): string => {
  // extract "RawType" from strings like "[object RawType]"
  return toTypeString(value).slice(8, -1)
}
登入後複製

Vue2的实现方式相同;

isPlainObject

export const isPlainObject = (val: unknown): val is object =>
  toTypeString(val) === &#39;[object Object]&#39;
登入後複製

Vue2的实现方式相同;

isIntegerKey

export const isIntegerKey = (key: unknown) =>
  isString(key) &&
  key !== &#39;NaN&#39; &&
  key[0] !== &#39;-&#39; &&
  &#39;&#39; + parseInt(key, 10) === key
登入後複製

判断一个字符串是不是由一个整数组成的;

isReservedProp

export const isReservedProp = /*#__PURE__*/ makeMap(
  // the leading comma is intentional so empty string "" is also included
  &#39;,key,ref,ref_for,ref_key,&#39; +
    &#39;onVnodeBeforeMount,onVnodeMounted,&#39; +
    &#39;onVnodeBeforeUpdate,onVnodeUpdated,&#39; +
    &#39;onVnodeBeforeUnmount,onVnodeUnmounted&#39;
)
登入後複製

使用makeMap生成一个对象,用于判断入参是否是内部保留的属性;

isBuiltInDirective

export const isBuiltInDirective = /*#__PURE__*/ makeMap(
  &#39;bind,cloak,else-if,else,for,html,if,model,on,once,pre,show,slot,text,memo&#39;
)
登入後複製

使用makeMap生成一个对象,用于判断入参是否是内置的指令;

cacheStringFunction

const cacheStringFunction = <T extends (str: string) => string>(fn: T): T => {
  const cache: Record<string, string> = Object.create(null)
  return ((str: string) => {
    const hit = cache[str]
    return hit || (cache[str] = fn(str))
  }) as T
}
登入後複製

Vue2cached相同,用于缓存字符串;

camelize

const camelizeRE = /-(\w)/g
/**
 * @private
 */
export const camelize = cacheStringFunction((str: string): string => {
  return str.replace(camelizeRE, (_, c) => (c ? c.toUpperCase() : &#39;&#39;))
})
登入後複製

-连接的字符串转换为驼峰式,同Vue2camelize相同;

capitalize

const hyphenateRE = /\B([A-Z])/g
/**
 * @private
 */
export const hyphenate = cacheStringFunction((str: string) =>
  str.replace(hyphenateRE, &#39;-$1&#39;).toLowerCase()
)
登入後複製

将驼峰式字符串转换为-连接的字符串,同Vue2hyphenate相同;

capitalize

/**
 * @private
 */
export const capitalize = cacheStringFunction(
  (str: string) => str.charAt(0).toUpperCase() + str.slice(1)
)
登入後複製

将字符串首字母大写,同Vue2capitalize相同;

toHandlerKey

/**
 * @private
 */
export const toHandlerKey = cacheStringFunction((str: string) =>
  str ? `on${capitalize(str)}` : ``
)
登入後複製

将字符串首字母大写并在前面加上on

hasChanged

// compare whether a value has changed, accounting for NaN.
export const hasChanged = (value: any, oldValue: any): boolean =>
  !Object.is(value, oldValue)
登入後複製

Vue2相比,移除了polyfill,直接使用Object.is

invokeArrayFns

export const invokeArrayFns = (fns: Function[], arg?: any) => {
  for (let i = 0; i < fns.length; i++) {
    fns[i](arg)
  }
}
登入後複製

批量调用传递过来的函数列表,如果有参数,会将参数传递给每个函数;

def

export const def = (obj: object, key: string | symbol, value: any) => {
  Object.defineProperty(obj, key, {
    configurable: true,
    enumerable: false,
    value
  })
}
登入後複製

使用Object.defineProperty定义一个属性,并使这个属性不可枚举;

looseToNumber

/**
 * "123-foo" will be parsed to 123
 * This is used for the .number modifier in v-model
 */
export const looseToNumber = (val: any): any => {
  const n = parseFloat(val)
  return isNaN(n) ? val : n
}
登入後複製

将字符串转换为数字,如果转换失败,返回原字符串;

通过注释知道主要用于v-model.number修饰符;

toNumber

/**
 * Only conerces number-like strings
 * "123-foo" will be returned as-is
 */
export const toNumber = (val: any): any => {
  const n = isString(val) ? Number(val) : NaN
  return isNaN(n) ? val : n
}
登入後複製

将字符串转换为数字,如果转换失败,返回原数据;

getGlobalThis

let _globalThis: any
export const getGlobalThis = (): any => {
  return (
    _globalThis ||
    (_globalThis =
      typeof globalThis !== &#39;undefined&#39;
        ? globalThis
        : typeof self !== &#39;undefined&#39;
        ? self
        : typeof window !== &#39;undefined&#39;
        ? window
        : typeof global !== &#39;undefined&#39;
        ? global
        : {})
  )
}
登入後複製

获取全局对象,根据环境不同返回的对象也不同;

genPropsAccessExp

const identRE = /^[_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*$/

export function genPropsAccessExp(name: string) {
  return identRE.test(name)
    ? `__props.${name}`
    : `__props[${JSON.stringify(name)}]`
}
登入後複製

生成props的访问表达式,如果name是合法的标识符,直接返回__props.name,否则返回通过JSON.stringify转换后的__props[name]

总结

通过这次的源码阅读,我们巩固了一些基础知识,通过对比Vue2的工具函数,我们也了解了Vue3的一些变化;

这些变化个人感觉主要集中在拥抱es6,可以看到放弃ie是多么自由而奔放;

话外题,不知道大家有没有发现MDN上面的浏览器兼容性表格,已经没有了ie的相关信息。

(学习视频分享:vuejs入门教程编程基础视频

以上是聊聊Vue3 shared模組下38個工具函數(原始碼閱讀)的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:juejin.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板