util.js 14.5 KB
Newer Older
fxy060608's avatar
fxy060608 已提交
1 2
import Vue from 'vue'

3 4 5
import {
  isFn,
  noop,
6
  hasOwn,
7 8 9
  isPlainObject
} from 'uni-shared'

fxy060608's avatar
fxy060608 已提交
10 11
export const PAGE_EVENT_HOOKS = [
  'onPullDownRefresh',
12 13 14
  'onReachBottom',
  'onAddToFavorites',
  'onShareTimeline',
fxy060608's avatar
fxy060608 已提交
15 16 17 18 19
  'onShareAppMessage',
  'onPageScroll',
  'onResize',
  'onTabItemTap'
]
20

fxy060608's avatar
fxy060608 已提交
21
export function initMocks (vm, mocks) {
22
  const mpInstance = vm.$mp[vm.mpType]
fxy060608's avatar
fxy060608 已提交
23
  mocks.forEach(mock => {
24 25 26 27 28 29
    if (hasOwn(mpInstance, mock)) {
      vm[mock] = mpInstance[mock]
    }
  })
}

fxy060608's avatar
fxy060608 已提交
30 31 32
function hasHook (hook, vueOptions) {
  if (!vueOptions) {
    return true
fxy060608's avatar
fxy060608 已提交
33 34
  }

fxy060608's avatar
fxy060608 已提交
35 36 37 38
  if (Vue.options && Array.isArray(Vue.options[hook])) {
    return true
  }

fxy060608's avatar
fxy060608 已提交
39 40 41 42 43 44 45
  vueOptions = vueOptions.default || vueOptions

  if (isFn(vueOptions)) {
    if (isFn(vueOptions.extendOptions[hook])) {
      return true
    }
    if (vueOptions.super &&
fxy060608's avatar
fxy060608 已提交
46 47
      vueOptions.super.options &&
      Array.isArray(vueOptions.super.options[hook])) {
fxy060608's avatar
fxy060608 已提交
48 49 50 51
      return true
    }
    return false
  }
fxy060608's avatar
fxy060608 已提交
52 53 54 55 56 57 58 59 60 61 62

  if (isFn(vueOptions[hook])) {
    return true
  }
  const mixins = vueOptions.mixins
  if (Array.isArray(mixins)) {
    return !!mixins.find(mixin => hasHook(hook, mixin))
  }
}

export function initHooks (mpOptions, hooks, vueOptions) {
63
  hooks.forEach(hook => {
fxy060608's avatar
fxy060608 已提交
64
    if (hasHook(hook, vueOptions)) {
fxy060608's avatar
fxy060608 已提交
65 66 67
      mpOptions[hook] = function (args) {
        return this.$vm && this.$vm.__call_hook(hook, args)
      }
68 69
    }
  })
fxy060608's avatar
fxy060608 已提交
70
}
71

fxy060608's avatar
fxy060608 已提交
72 73 74 75 76 77 78 79
export function initVueComponent (Vue, vueOptions) {
  vueOptions = vueOptions.default || vueOptions
  let VueComponent
  if (isFn(vueOptions)) {
    VueComponent = vueOptions
  } else {
    VueComponent = Vue.extend(vueOptions)
  }
D
Danny 已提交
80
  vueOptions = VueComponent.options
fxy060608's avatar
fxy060608 已提交
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
  return [VueComponent, vueOptions]
}

export function initSlots (vm, vueSlots) {
  if (Array.isArray(vueSlots) && vueSlots.length) {
    const $slots = Object.create(null)
    vueSlots.forEach(slotName => {
      $slots[slotName] = true
    })
    vm.$scopedSlots = vm.$slots = $slots
  }
}

export function initVueIds (vueIds, mpInstance) {
  vueIds = (vueIds || '').split(',')
  const len = vueIds.length

  if (len === 1) {
    mpInstance._$vueId = vueIds[0]
  } else if (len === 2) {
    mpInstance._$vueId = vueIds[0]
    mpInstance._$vuePid = vueIds[1]
  }
}

export function initData (vueOptions, context) {
fxy060608's avatar
fxy060608 已提交
107 108
  let data = vueOptions.data || {}
  const methods = vueOptions.methods || {}
109 110 111

  if (typeof data === 'function') {
    try {
fxy060608's avatar
fxy060608 已提交
112
      data = data.call(context) // 支持 Vue.prototype 上挂的数据
113
    } catch (e) {
114 115 116
      if (process.env.VUE_APP_DEBUG) {
        console.warn('根据 Vue 的 data 函数初始化小程序 data 失败,请尽量确保 data 函数中不访问 vm 对象,否则可能影响首次数据渲染速度。', data)
      }
117
    }
118 119 120 121 122
  } else {
    try {
      // 对 data 格式化
      data = JSON.parse(JSON.stringify(data))
    } catch (e) {}
123 124 125 126
  }

  if (!isPlainObject(data)) {
    data = {}
127
  }
fxy060608's avatar
fxy060608 已提交
128

129
  Object.keys(methods).forEach(methodName => {
fxy060608's avatar
fxy060608 已提交
130
    if (context.__lifecycle_hooks__.indexOf(methodName) === -1 && !hasOwn(data, methodName)) {
131 132 133 134 135
      data[methodName] = methods[methodName]
    }
  })

  return data
136 137 138 139
}

const PROP_TYPES = [String, Number, Boolean, Object, Array, null]

fxy060608's avatar
fxy060608 已提交
140 141 142 143 144 145 146 147
function createObserver (name) {
  return function observer (newVal, oldVal) {
    if (this.$vm) {
      this.$vm[name] = newVal // 为了触发其他非 render watcher
    }
  }
}

fxy060608's avatar
fxy060608 已提交
148
export function initBehaviors (vueOptions, initBehavior) {
fxy060608's avatar
fxy060608 已提交
149 150 151
  const vueBehaviors = vueOptions.behaviors
  const vueExtends = vueOptions.extends
  const vueMixins = vueOptions.mixins
fxy060608's avatar
fxy060608 已提交
152

fxy060608's avatar
fxy060608 已提交
153
  let vueProps = vueOptions.props
fxy060608's avatar
fxy060608 已提交
154 155

  if (!vueProps) {
fxy060608's avatar
fxy060608 已提交
156
    vueOptions.props = vueProps = []
fxy060608's avatar
fxy060608 已提交
157 158
  }

159
  const behaviors = []
fxy060608's avatar
fxy060608 已提交
160 161 162 163 164 165 166 167
  if (Array.isArray(vueBehaviors)) {
    vueBehaviors.forEach(behavior => {
      behaviors.push(behavior.replace('uni://', `${__PLATFORM_PREFIX__}://`))
      if (behavior === 'uni://form-field') {
        if (Array.isArray(vueProps)) {
          vueProps.push('name')
          vueProps.push('value')
        } else {
fxy060608's avatar
fxy060608 已提交
168
          vueProps.name = {
169 170 171
            type: String,
            default: ''
          }
fxy060608's avatar
fxy060608 已提交
172
          vueProps.value = {
173 174 175
            type: [String, Number, Boolean, Array, Object, Date],
            default: ''
          }
fxy060608's avatar
fxy060608 已提交
176 177 178 179
        }
      }
    })
  }
180 181
  if (isPlainObject(vueExtends) && vueExtends.props) {
    behaviors.push(
182
      initBehavior({
fxy060608's avatar
fxy060608 已提交
183
        properties: initProperties(vueExtends.props, true)
184 185 186 187 188 189 190
      })
    )
  }
  if (Array.isArray(vueMixins)) {
    vueMixins.forEach(vueMixin => {
      if (isPlainObject(vueMixin) && vueMixin.props) {
        behaviors.push(
191
          initBehavior({
fxy060608's avatar
fxy060608 已提交
192
            properties: initProperties(vueMixin.props, true)
193 194 195 196 197 198 199 200
          })
        )
      }
    })
  }
  return behaviors
}

201
function parsePropType (key, type, defaultValue, file) {
202 203 204 205 206 207
  // [String]=>String
  if (Array.isArray(type) && type.length === 1) {
    return type[0]
  }
  if (__PLATFORM__ === 'mp-baidu') {
    if (
208
      defaultValue === false &&
fxy060608's avatar
fxy060608 已提交
209 210 211 212
      Array.isArray(type) &&
      type.length === 2 &&
      type.indexOf(String) !== -1 &&
      type.indexOf(Boolean) !== -1
213
    ) { // [String,Boolean]=>Boolean
214 215 216 217
      if (file) {
        console.warn(
          `props.${key}.type should use Boolean instead of [String,Boolean] at ${file}`
        )
218
      }
219
      return Boolean
220 221 222 223 224
    }
  }
  return type
}

fxy060608's avatar
fxy060608 已提交
225
export function initProperties (props, isBehavior = false, file = '') {
226 227
  const properties = {}
  if (!isBehavior) {
fxy060608's avatar
fxy060608 已提交
228 229 230 231
    properties.vueId = {
      type: String,
      value: ''
    }
232
    properties.vueSlots = { // 小程序不能直接定义 $slots 的 props,所以通过 vueSlots 转换到 $slots
233 234 235 236 237 238 239 240 241 242 243 244 245
      type: null,
      value: [],
      observer: function (newVal, oldVal) {
        const $slots = Object.create(null)
        newVal.forEach(slotName => {
          $slots[slotName] = true
        })
        this.setData({
          $slots
        })
      }
    }
  }
246 247
  if (Array.isArray(props)) { // ['title']
    props.forEach(key => {
fxy060608's avatar
fxy060608 已提交
248 249 250 251
      properties[key] = {
        type: null,
        observer: createObserver(key)
      }
252 253 254 255 256
    })
  } else if (isPlainObject(props)) { // {title:{type:String,default:''},content:String}
    Object.keys(props).forEach(key => {
      const opts = props[key]
      if (isPlainObject(opts)) { // title:{type:String,default:''}
fxy060608's avatar
fxy060608 已提交
257
        let value = opts.default
258 259 260
        if (isFn(value)) {
          value = value()
        }
261

262
        opts.type = parsePropType(key, opts.type, value, file)
263

264
        properties[key] = {
265
          type: PROP_TYPES.indexOf(opts.type) !== -1 ? opts.type : null,
fxy060608's avatar
fxy060608 已提交
266 267
          value,
          observer: createObserver(key)
268 269
        }
      } else { // content:String
270
        const type = parsePropType(key, opts, null, file)
fxy060608's avatar
fxy060608 已提交
271
        properties[key] = {
272
          type: PROP_TYPES.indexOf(type) !== -1 ? type : null,
fxy060608's avatar
fxy060608 已提交
273 274
          observer: createObserver(key)
        }
275 276 277 278 279 280 281
      }
    })
  }
  return properties
}

function wrapper (event) {
fxy060608's avatar
fxy060608 已提交
282 283 284 285 286
  // TODO 又得兼容 mpvue 的 mp 对象
  try {
    event.mp = JSON.parse(JSON.stringify(event))
  } catch (e) {}

287 288 289 290
  event.stopPropagation = noop
  event.preventDefault = noop

  event.target = event.target || {}
fxy060608's avatar
fxy060608 已提交
291

292
  if (!hasOwn(event, 'detail')) {
fxy060608's avatar
fxy060608 已提交
293 294
    event.detail = {}
  }
fxy060608's avatar
fxy060608 已提交
295

296 297
  if (hasOwn(event, 'markerId')) {
    event.detail = typeof event.detail === 'object' ? event.detail : {}
298 299 300
    event.detail.markerId = event.markerId
  }

fxy060608's avatar
fxy060608 已提交
301
  if (__PLATFORM__ === 'mp-baidu') { // mp-baidu,checked=>value
fxy060608's avatar
fxy060608 已提交
302 303
    if (
      isPlainObject(event.detail) &&
fxy060608's avatar
fxy060608 已提交
304 305
      hasOwn(event.detail, 'checked') &&
      !hasOwn(event.detail, 'value')
fxy060608's avatar
fxy060608 已提交
306
    ) {
fxy060608's avatar
fxy060608 已提交
307 308 309 310
      event.detail.value = event.detail.checked
    }
  }

fxy060608's avatar
fxy060608 已提交
311 312 313 314
  if (isPlainObject(event.detail)) {
    event.target = Object.assign({}, event.target, event.detail)
  }

315 316 317
  return event
}

fxy060608's avatar
fxy060608 已提交
318 319 320 321 322 323 324 325 326
function getExtraValue (vm, dataPathsArray) {
  let context = vm
  dataPathsArray.forEach(dataPathArray => {
    const dataPath = dataPathArray[0]
    const value = dataPathArray[2]
    if (dataPath || typeof value !== 'undefined') { // ['','',index,'disable']
      const propPath = dataPathArray[1]
      const valuePath = dataPathArray[3]

327 328 329 330 331 332 333 334 335 336 337 338
      let vFor
      if (Number.isInteger(dataPath)) {
        vFor = dataPath
      } else if (!dataPath) {
        vFor = context
      } else if (typeof dataPath === 'string' && dataPath) {
        if (dataPath.indexOf('#s#') === 0) {
          vFor = dataPath.substr(3)
        } else {
          vFor = vm.__get_value(dataPath, context)
        }
      }
fxy060608's avatar
fxy060608 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

      if (Number.isInteger(vFor)) {
        context = value
      } else if (!propPath) {
        context = vFor[value]
      } else {
        if (Array.isArray(vFor)) {
          context = vFor.find(vForItem => {
            return vm.__get_value(propPath, vForItem) === value
          })
        } else if (isPlainObject(vFor)) {
          context = Object.keys(vFor).find(vForKey => {
            return vm.__get_value(propPath, vFor[vForKey]) === value
          })
        } else {
          console.error('v-for 暂不支持循环数据:', vFor)
        }
      }

      if (valuePath) {
        context = vm.__get_value(valuePath, context)
      }
    }
  })
  return context
}

366
function processEventExtra (vm, extra, event) {
fxy060608's avatar
fxy060608 已提交
367 368 369 370
  const extraObj = {}

  if (Array.isArray(extra) && extra.length) {
    /**
fxy060608's avatar
fxy060608 已提交
371 372 373 374 375 376 377 378 379 380
     *[
     *    ['data.items', 'data.id', item.data.id],
     *    ['metas', 'id', meta.id]
     *],
     *[
     *    ['data.items', 'data.id', item.data.id],
     *    ['metas', 'id', meta.id]
     *],
     *'test'
     */
fxy060608's avatar
fxy060608 已提交
381 382 383 384 385
    extra.forEach((dataPath, index) => {
      if (typeof dataPath === 'string') {
        if (!dataPath) { // model,prop.sync
          extraObj['$' + index] = vm
        } else {
386 387
          if (dataPath === '$event') { // $event
            extraObj['$' + index] = event
388 389 390 391 392 393
          } else if (dataPath === 'arguments') {
            if (event.detail && event.detail.__args__) {
              extraObj['$' + index] = event.detail.__args__
            } else {
              extraObj['$' + index] = [event]
            }
394 395 396 397 398
          } else if (dataPath.indexOf('$event.') === 0) { // $event.target.value
            extraObj['$' + index] = vm.__get_value(dataPath.replace('$event.', ''), event)
          } else {
            extraObj['$' + index] = vm.__get_value(dataPath)
          }
fxy060608's avatar
fxy060608 已提交
399 400 401 402 403 404 405 406 407 408
        }
      } else {
        extraObj['$' + index] = getExtraValue(vm, dataPath)
      }
    })
  }

  return extraObj
}

fxy060608's avatar
fxy060608 已提交
409 410 411 412 413 414 415 416 417
function getObjByArray (arr) {
  const obj = {}
  for (let i = 1; i < arr.length; i++) {
    const element = arr[i]
    obj[element[0]] = element[1]
  }
  return obj
}

fxy060608's avatar
fxy060608 已提交
418
function processEventArgs (vm, event, args = [], extra = [], isCustom, methodName) {
fxy060608's avatar
fxy060608 已提交
419
  let isCustomMPEvent = false // wxcomponent 组件,传递原始 event 对象
420
  if (isCustom) { // 自定义事件
fxy060608's avatar
fxy060608 已提交
421
    isCustomMPEvent = event.currentTarget &&
fxy060608's avatar
fxy060608 已提交
422 423
      event.currentTarget.dataset &&
      event.currentTarget.dataset.comType === 'wx'
fxy060608's avatar
fxy060608 已提交
424 425 426 427
    if (!args.length) { // 无参数,直接传入 event 或 detail 数组
      if (isCustomMPEvent) {
        return [event]
      }
fxy060608's avatar
fxy060608 已提交
428
      return event.detail.__args__ || event.detail
429
    }
430
  }
fxy060608's avatar
fxy060608 已提交
431

432
  const extraObj = processEventExtra(vm, extra, event)
fxy060608's avatar
fxy060608 已提交
433

434 435 436
  const ret = []
  args.forEach(arg => {
    if (arg === '$event') {
fxy060608's avatar
fxy060608 已提交
437 438 439
      if (methodName === '__set_model' && !isCustom) { // input v-model value
        ret.push(event.target.value)
      } else {
fxy060608's avatar
fxy060608 已提交
440
        if (isCustom && !isCustomMPEvent) {
fxy060608's avatar
fxy060608 已提交
441
          ret.push(event.detail.__args__[0])
fxy060608's avatar
fxy060608 已提交
442 443 444
        } else { // wxcomponent 组件或内置组件
          ret.push(event)
        }
fxy060608's avatar
fxy060608 已提交
445
      }
446
    } else {
fxy060608's avatar
fxy060608 已提交
447 448 449
      if (Array.isArray(arg) && arg[0] === 'o') {
        ret.push(getObjByArray(arg))
      } else if (typeof arg === 'string' && hasOwn(extraObj, arg)) {
fxy060608's avatar
fxy060608 已提交
450 451 452 453
        ret.push(extraObj[arg])
      } else {
        ret.push(arg)
      }
454 455 456 457 458 459 460 461 462
    }
  })

  return ret
}

const ONCE = '~'
const CUSTOM = '^'

fxy060608's avatar
fxy060608 已提交
463 464
function isMatchEventType (eventType, optType) {
  return (eventType === optType) ||
fxy060608's avatar
fxy060608 已提交
465 466 467 468 469 470 471
    (
      optType === 'regionchange' &&
      (
        eventType === 'begin' ||
        eventType === 'end'
      )
    )
fxy060608's avatar
fxy060608 已提交
472 473
}

474 475 476
export function handleEvent (event) {
  event = wrapper(event)

fxy060608's avatar
fxy060608 已提交
477 478 479
  // [['tap',[['handle',[1,2,a]],['handle1',[1,2,a]]]]]
  const dataset = (event.currentTarget || event.target).dataset
  if (!dataset) {
fxy060608's avatar
fxy060608 已提交
480
    return console.warn('事件信息不存在')
481
  }
fxy060608's avatar
fxy060608 已提交
482
  const eventOpts = dataset.eventOpts || dataset['event-opts'] // 支付宝 web-view 组件 dataset 非驼峰
483
  if (!eventOpts) {
fxy060608's avatar
fxy060608 已提交
484
    return console.warn('事件信息不存在')
485 486 487 488
  }

  // [['handle',[1,2,a]],['handle1',[1,2,a]]]
  const eventType = event.type
fxy060608's avatar
fxy060608 已提交
489 490 491

  const ret = []

492 493 494 495 496 497 498 499 500
  eventOpts.forEach(eventOpt => {
    let type = eventOpt[0]
    const eventsArray = eventOpt[1]

    const isCustom = type.charAt(0) === CUSTOM
    type = isCustom ? type.slice(1) : type
    const isOnce = type.charAt(0) === ONCE
    type = isOnce ? type.slice(1) : type

fxy060608's avatar
fxy060608 已提交
501
    if (eventsArray && isMatchEventType(eventType, type)) {
502
      eventsArray.forEach(eventArray => {
503
        const methodName = eventArray[0]
fxy060608's avatar
fxy060608 已提交
504
        if (methodName) {
fxy060608's avatar
fxy060608 已提交
505 506 507
          let handlerCtx = this.$vm
          if (
            handlerCtx.$options.generic &&
fxy060608's avatar
fxy060608 已提交
508 509
            handlerCtx.$parent &&
            handlerCtx.$parent.$parent
fxy060608's avatar
fxy060608 已提交
510 511
          ) { // mp-weixin,mp-toutiao 抽象节点模拟 scoped slots
            handlerCtx = handlerCtx.$parent.$parent
512 513 514 515 516 517 518 519 520 521 522 523
          }
          if (methodName === '$emit') {
            handlerCtx.$emit.apply(handlerCtx,
              processEventArgs(
                this.$vm,
                event,
                eventArray[1],
                eventArray[2],
                isCustom,
                methodName
              ))
            return
fxy060608's avatar
fxy060608 已提交
524
          }
525
          const handler = handlerCtx[methodName]
fxy060608's avatar
fxy060608 已提交
526 527 528 529 530 531 532 533
          if (!isFn(handler)) {
            throw new Error(` _vm.${methodName} is not a function`)
          }
          if (isOnce) {
            if (handler.once) {
              return
            }
            handler.once = true
534
          }
fxy060608's avatar
fxy060608 已提交
535
          ret.push(handler.apply(handlerCtx, processEventArgs(
fxy060608's avatar
fxy060608 已提交
536 537 538 539 540 541
            this.$vm,
            event,
            eventArray[1],
            eventArray[2],
            isCustom,
            methodName
fxy060608's avatar
fxy060608 已提交
542
          )))
543 544 545 546
        }
      })
    }
  })
fxy060608's avatar
fxy060608 已提交
547

fxy060608's avatar
fxy060608 已提交
548 549 550 551 552
  if (
    eventType === 'input' &&
    ret.length === 1 &&
    typeof ret[0] !== 'undefined'
  ) {
fxy060608's avatar
fxy060608 已提交
553 554
    return ret[0]
  }
555
}