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

2022-12-12 22:01:54

前端(vue)入門到精通課程,老師線上輔導:聯絡老師
Apipost = Postman + Swagger + Mock + Jmeter 超好用的API偵錯工具:

Vue3的工具函數對比於Vue2的工具函數變化還是很大的,個人感覺主要還是體現在語法上,已經全面擁抱es6了;【相關推薦:、】

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

原始碼地址:

之前介紹了很多閱讀方式,這次就直接跳過了,直接開始閱讀原始碼;

所有工具函數

  • 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的閱讀經驗,所以這次快速閱讀;

如果想要詳細的可以看我之前寫的文章:;

而且這次是直接原始碼,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(',')
  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('onUpdate:')
登入後複製

判斷是否是onUpdate:開頭的字串;

參考:

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) === '[object Map]'
export const isSet = (val: unknown): val is Set<any> =>
  toTypeString(val) === '[object Set]'

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

都是使用Object.toString來判斷型別,對比於Vue2新增了isMapisSetisDate,實現方式沒變;

isFunction & isString & isSymbol & isObject

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

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) === '[object Object]'
登入後複製

Vue2的實現方式相同;

isIntegerKey

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

判斷一個字串是不是由一個整陣列成的;

isReservedProp

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

使用makeMap生成一個物件,用於判斷入參是否是內部保留的屬性;

isBuiltInDirective

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

使用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() : ''))
})
登入後複製

-連線的字串轉換為駝峰式,同Vue2camelize相同;

capitalize

const hyphenateRE = /\B([A-Z])/g
/**
 * @private
 */
export const hyphenate = cacheStringFunction((str: string) =>
  str.replace(hyphenateRE, '-$1').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 !== 'undefined'
        ? globalThis
        : typeof self !== 'undefined'
        ? self
        : typeof window !== 'undefined'
        ? window
        : typeof global !== 'undefined'
        ? 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的相關資訊。

(學習視訊分享:、)

以上就是聊聊Vue3 shared模組下38個工具函數(原始碼閱讀)的詳細內容,更多請關注TW511.COM其它相關文章!