util.js 13.9 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 12 13 14 15 16 17
export const PAGE_EVENT_HOOKS = [
  'onPullDownRefresh',
  'onReachBottom',
  'onShareAppMessage',
  'onPageScroll',
  'onResize',
  'onTabItemTap'
]
18

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

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

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

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

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

  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) {
61
  hooks.forEach(hook => {
fxy060608's avatar
fxy060608 已提交
62
    if (hasHook(hook, vueOptions)) {
fxy060608's avatar
fxy060608 已提交
63 64 65
      mpOptions[hook] = function (args) {
        return this.$vm && this.$vm.__call_hook(hook, args)
      }
66 67
    }
  })
fxy060608's avatar
fxy060608 已提交
68
}
69

fxy060608's avatar
fxy060608 已提交
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
export function initVueComponent (Vue, vueOptions) {
  vueOptions = vueOptions.default || vueOptions
  let VueComponent
  if (isFn(vueOptions)) {
    VueComponent = vueOptions
    vueOptions = VueComponent.extendOptions
  } else {
    VueComponent = Vue.extend(vueOptions)
  }
  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 已提交
105 106
  let data = vueOptions.data || {}
  const methods = vueOptions.methods || {}
107 108 109

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

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

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

  return data
134 135 136 137
}

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

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

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

fxy060608's avatar
fxy060608 已提交
151
  let vueProps = vueOptions.props
fxy060608's avatar
fxy060608 已提交
152 153

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

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

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

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

260
        opts.type = parsePropType(key, opts.type, value, file)
261

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

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

285 286 287 288
  event.stopPropagation = noop
  event.preventDefault = noop

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

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

294 295 296 297
  if (!('markerId' in event.detail) && 'markerId' in event) {
    event.detail.markerId = event.markerId
  }

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

fxy060608's avatar
fxy060608 已提交
308 309 310 311
  if (isPlainObject(event.detail)) {
    event.target = Object.assign({}, event.target, event.detail)
  }

312 313 314
  return event
}

fxy060608's avatar
fxy060608 已提交
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
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]

      const vFor = dataPath ? vm.__get_value(dataPath, context) : context

      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
}

352
function processEventExtra (vm, extra, event) {
fxy060608's avatar
fxy060608 已提交
353 354 355 356
  const extraObj = {}

  if (Array.isArray(extra) && extra.length) {
    /**
fxy060608's avatar
fxy060608 已提交
357 358 359 360 361 362 363 364 365 366
     *[
     *    ['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 已提交
367 368 369 370 371
    extra.forEach((dataPath, index) => {
      if (typeof dataPath === 'string') {
        if (!dataPath) { // model,prop.sync
          extraObj['$' + index] = vm
        } else {
372 373 374 375 376 377 378
          if (dataPath === '$event') { // $event
            extraObj['$' + index] = event
          } 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 已提交
379 380 381 382 383 384 385 386 387 388
        }
      } else {
        extraObj['$' + index] = getExtraValue(vm, dataPath)
      }
    })
  }

  return extraObj
}

fxy060608's avatar
fxy060608 已提交
389 390 391 392 393 394 395 396 397
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 已提交
398
function processEventArgs (vm, event, args = [], extra = [], isCustom, methodName) {
fxy060608's avatar
fxy060608 已提交
399
  let isCustomMPEvent = false // wxcomponent 组件,传递原始 event 对象
400
  if (isCustom) { // 自定义事件
fxy060608's avatar
fxy060608 已提交
401
    isCustomMPEvent = event.currentTarget &&
fxy060608's avatar
fxy060608 已提交
402 403
      event.currentTarget.dataset &&
      event.currentTarget.dataset.comType === 'wx'
fxy060608's avatar
fxy060608 已提交
404 405 406 407
    if (!args.length) { // 无参数,直接传入 event 或 detail 数组
      if (isCustomMPEvent) {
        return [event]
      }
fxy060608's avatar
fxy060608 已提交
408
      return event.detail.__args__ || event.detail
409
    }
410
  }
fxy060608's avatar
fxy060608 已提交
411

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

414 415 416
  const ret = []
  args.forEach(arg => {
    if (arg === '$event') {
fxy060608's avatar
fxy060608 已提交
417 418 419
      if (methodName === '__set_model' && !isCustom) { // input v-model value
        ret.push(event.target.value)
      } else {
fxy060608's avatar
fxy060608 已提交
420
        if (isCustom && !isCustomMPEvent) {
fxy060608's avatar
fxy060608 已提交
421
          ret.push(event.detail.__args__[0])
fxy060608's avatar
fxy060608 已提交
422 423 424
        } else { // wxcomponent 组件或内置组件
          ret.push(event)
        }
fxy060608's avatar
fxy060608 已提交
425
      }
426
    } else {
fxy060608's avatar
fxy060608 已提交
427 428 429
      if (Array.isArray(arg) && arg[0] === 'o') {
        ret.push(getObjByArray(arg))
      } else if (typeof arg === 'string' && hasOwn(extraObj, arg)) {
fxy060608's avatar
fxy060608 已提交
430 431 432 433
        ret.push(extraObj[arg])
      } else {
        ret.push(arg)
      }
434 435 436 437 438 439 440 441 442
    }
  })

  return ret
}

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

fxy060608's avatar
fxy060608 已提交
443 444
function isMatchEventType (eventType, optType) {
  return (eventType === optType) ||
fxy060608's avatar
fxy060608 已提交
445 446 447 448 449 450 451
    (
      optType === 'regionchange' &&
      (
        eventType === 'begin' ||
        eventType === 'end'
      )
    )
fxy060608's avatar
fxy060608 已提交
452 453
}

454 455 456
export function handleEvent (event) {
  event = wrapper(event)

fxy060608's avatar
fxy060608 已提交
457 458 459
  // [['tap',[['handle',[1,2,a]],['handle1',[1,2,a]]]]]
  const dataset = (event.currentTarget || event.target).dataset
  if (!dataset) {
fxy060608's avatar
fxy060608 已提交
460
    return console.warn('事件信息不存在')
461
  }
fxy060608's avatar
fxy060608 已提交
462
  const eventOpts = dataset.eventOpts || dataset['event-opts'] // 支付宝 web-view 组件 dataset 非驼峰
463
  if (!eventOpts) {
fxy060608's avatar
fxy060608 已提交
464
    return console.warn('事件信息不存在')
465 466 467 468
  }

  // [['handle',[1,2,a]],['handle1',[1,2,a]]]
  const eventType = event.type
fxy060608's avatar
fxy060608 已提交
469 470 471

  const ret = []

472 473 474 475 476 477 478 479 480
  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 已提交
481
    if (eventsArray && isMatchEventType(eventType, type)) {
482
      eventsArray.forEach(eventArray => {
483
        const methodName = eventArray[0]
fxy060608's avatar
fxy060608 已提交
484
        if (methodName) {
fxy060608's avatar
fxy060608 已提交
485 486 487
          let handlerCtx = this.$vm
          if (
            handlerCtx.$options.generic &&
fxy060608's avatar
fxy060608 已提交
488 489
            handlerCtx.$parent &&
            handlerCtx.$parent.$parent
fxy060608's avatar
fxy060608 已提交
490 491
          ) { // mp-weixin,mp-toutiao 抽象节点模拟 scoped slots
            handlerCtx = handlerCtx.$parent.$parent
492 493 494 495 496 497 498 499 500 501 502 503
          }
          if (methodName === '$emit') {
            handlerCtx.$emit.apply(handlerCtx,
              processEventArgs(
                this.$vm,
                event,
                eventArray[1],
                eventArray[2],
                isCustom,
                methodName
              ))
            return
fxy060608's avatar
fxy060608 已提交
504
          }
505
          const handler = handlerCtx[methodName]
fxy060608's avatar
fxy060608 已提交
506 507 508 509 510 511 512 513
          if (!isFn(handler)) {
            throw new Error(` _vm.${methodName} is not a function`)
          }
          if (isOnce) {
            if (handler.once) {
              return
            }
            handler.once = true
514
          }
fxy060608's avatar
fxy060608 已提交
515
          ret.push(handler.apply(handlerCtx, processEventArgs(
fxy060608's avatar
fxy060608 已提交
516 517 518 519 520 521
            this.$vm,
            event,
            eventArray[1],
            eventArray[2],
            isCustom,
            methodName
fxy060608's avatar
fxy060608 已提交
522
          )))
523 524 525 526
        }
      })
    }
  })
fxy060608's avatar
fxy060608 已提交
527

fxy060608's avatar
fxy060608 已提交
528 529 530 531 532
  if (
    eventType === 'input' &&
    ret.length === 1 &&
    typeof ret[0] !== 'undefined'
  ) {
fxy060608's avatar
fxy060608 已提交
533 534
    return ret[0]
  }
535
}