util.js 13.2 KB
Newer Older
1 2 3
import {
  isFn,
  noop,
4
  hasOwn,
5 6 7
  isPlainObject
} from 'uni-shared'

fxy060608's avatar
fxy060608 已提交
8 9 10 11 12 13 14 15
export const PAGE_EVENT_HOOKS = [
  'onPullDownRefresh',
  'onReachBottom',
  'onShareAppMessage',
  'onPageScroll',
  'onResize',
  'onTabItemTap'
]
16

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

fxy060608's avatar
fxy060608 已提交
26 27 28
function hasHook (hook, vueOptions) {
  if (!vueOptions) {
    return true
fxy060608's avatar
fxy060608 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
  }

  vueOptions = vueOptions.default || vueOptions

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

  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) {
55
  hooks.forEach(hook => {
fxy060608's avatar
fxy060608 已提交
56
    if (hasHook(hook, vueOptions)) {
fxy060608's avatar
fxy060608 已提交
57 58 59
      mpOptions[hook] = function (args) {
        return this.$vm && this.$vm.__call_hook(hook, args)
      }
60 61
    }
  })
fxy060608's avatar
fxy060608 已提交
62
}
63

fxy060608's avatar
fxy060608 已提交
64 65 66 67 68 69 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
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 已提交
99 100
  let data = vueOptions.data || {}
  const methods = vueOptions.methods || {}
101 102 103

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

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

121
  Object.keys(methods).forEach(methodName => {
fxy060608's avatar
fxy060608 已提交
122
    if (context.__lifecycle_hooks__.indexOf(methodName) === -1 && !hasOwn(data, methodName)) {
123 124 125 126 127
      data[methodName] = methods[methodName]
    }
  })

  return data
128 129 130 131
}

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

fxy060608's avatar
fxy060608 已提交
132 133 134 135 136 137 138 139
function createObserver (name) {
  return function observer (newVal, oldVal) {
    if (this.$vm) {
      this.$vm[name] = newVal // 为了触发其他非 render watcher
    }
  }
}

fxy060608's avatar
fxy060608 已提交
140
export function initBehaviors (vueOptions, initBehavior) {
fxy060608's avatar
fxy060608 已提交
141 142 143 144 145 146 147 148 149 150
  const vueBehaviors = vueOptions['behaviors']
  const vueExtends = vueOptions['extends']
  const vueMixins = vueOptions['mixins']

  let vueProps = vueOptions['props']

  if (!vueProps) {
    vueOptions['props'] = vueProps = []
  }

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

193
function parsePropType (key, type, defaultValue, file) {
194 195 196 197 198 199
  // [String]=>String
  if (Array.isArray(type) && type.length === 1) {
    return type[0]
  }
  if (__PLATFORM__ === 'mp-baidu') {
    if (
200 201
      defaultValue === false &&
            Array.isArray(type) &&
202
            type.length === 2 &&
203 204
            type.indexOf(String) !== -1 &&
            type.indexOf(Boolean) !== -1
205
    ) { // [String,Boolean]=>Boolean
206 207 208 209
      if (file) {
        console.warn(
          `props.${key}.type should use Boolean instead of [String,Boolean] at ${file}`
        )
210
      }
211
      return Boolean
212 213 214 215 216
    }
  }
  return type
}

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

254
        opts.type = parsePropType(key, opts.type, value, file)
255

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

function wrapper (event) {
fxy060608's avatar
fxy060608 已提交
274 275 276 277 278
  // TODO 又得兼容 mpvue 的 mp 对象
  try {
    event.mp = JSON.parse(JSON.stringify(event))
  } catch (e) {}

279 280 281 282
  event.stopPropagation = noop
  event.preventDefault = noop

  event.target = event.target || {}
fxy060608's avatar
fxy060608 已提交
283 284 285 286

  if (!hasOwn(event, 'detail')) {
    event.detail = {}
  }
fxy060608's avatar
fxy060608 已提交
287 288

  if (__PLATFORM__ === 'mp-baidu') { // mp-baidu,checked=>value
fxy060608's avatar
fxy060608 已提交
289 290 291 292 293
    if (
      isPlainObject(event.detail) &&
            hasOwn(event.detail, 'checked') &&
            !hasOwn(event.detail, 'value')
    ) {
fxy060608's avatar
fxy060608 已提交
294 295 296 297
      event.detail.value = event.detail.checked
    }
  }

fxy060608's avatar
fxy060608 已提交
298 299 300 301
  if (isPlainObject(event.detail)) {
    event.target = Object.assign({}, event.target, event.detail)
  }

302 303 304
  return event
}

fxy060608's avatar
fxy060608 已提交
305 306 307 308 309 310 311 312 313 314 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
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
}

342
function processEventExtra (vm, extra, event) {
fxy060608's avatar
fxy060608 已提交
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
  const extraObj = {}

  if (Array.isArray(extra) && extra.length) {
    /**
         *[
         *    ['data.items', 'data.id', item.data.id],
         *    ['metas', 'id', meta.id]
         *],
         *[
         *    ['data.items', 'data.id', item.data.id],
         *    ['metas', 'id', meta.id]
         *],
         *'test'
         */
    extra.forEach((dataPath, index) => {
      if (typeof dataPath === 'string') {
        if (!dataPath) { // model,prop.sync
          extraObj['$' + index] = vm
        } else {
362 363 364 365 366 367 368
          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 已提交
369 370 371 372 373 374 375 376 377 378
        }
      } else {
        extraObj['$' + index] = getExtraValue(vm, dataPath)
      }
    })
  }

  return extraObj
}

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

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

404 405 406
  const ret = []
  args.forEach(arg => {
    if (arg === '$event') {
fxy060608's avatar
fxy060608 已提交
407 408 409
      if (methodName === '__set_model' && !isCustom) { // input v-model value
        ret.push(event.target.value)
      } else {
fxy060608's avatar
fxy060608 已提交
410
        if (isCustom && !isCustomMPEvent) {
fxy060608's avatar
fxy060608 已提交
411
          ret.push(event.detail.__args__[0])
fxy060608's avatar
fxy060608 已提交
412 413 414
        } else { // wxcomponent 组件或内置组件
          ret.push(event)
        }
fxy060608's avatar
fxy060608 已提交
415
      }
416
    } else {
fxy060608's avatar
fxy060608 已提交
417 418 419
      if (Array.isArray(arg) && arg[0] === 'o') {
        ret.push(getObjByArray(arg))
      } else if (typeof arg === 'string' && hasOwn(extraObj, arg)) {
fxy060608's avatar
fxy060608 已提交
420 421 422 423
        ret.push(extraObj[arg])
      } else {
        ret.push(arg)
      }
424 425 426 427 428 429 430 431 432
    }
  })

  return ret
}

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

fxy060608's avatar
fxy060608 已提交
433 434 435 436 437 438 439 440 441 442 443
function isMatchEventType (eventType, optType) {
  return (eventType === optType) ||
        (
          optType === 'regionchange' &&
            (
              eventType === 'begin' ||
                eventType === 'end'
            )
        )
}

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
export function handleEvent (event) {
  event = wrapper(event)

  // [['tap',[['handle',[1,2,a]],['handle1',[1,2,a]]]]]
  const eventOpts = (event.currentTarget || event.target).dataset.eventOpts
  if (!eventOpts) {
    return console.warn(`事件信息不存在`)
  }

  // [['handle',[1,2,a]],['handle1',[1,2,a]]]
  const eventType = event.type
  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 已提交
464
    if (eventsArray && isMatchEventType(eventType, type)) {
465
      eventsArray.forEach(eventArray => {
466
        const methodName = eventArray[0]
fxy060608's avatar
fxy060608 已提交
467
        if (methodName) {
fxy060608's avatar
fxy060608 已提交
468 469 470 471 472 473 474 475 476
          let handlerCtx = this.$vm
          if (
            handlerCtx.$options.generic &&
                        handlerCtx.$parent &&
                        handlerCtx.$parent.$parent
          ) { // mp-weixin,mp-toutiao 抽象节点模拟 scoped slots
            handlerCtx = handlerCtx.$parent.$parent
          }
          const handler = handlerCtx[methodName]
fxy060608's avatar
fxy060608 已提交
477 478 479 480 481 482 483 484
          if (!isFn(handler)) {
            throw new Error(` _vm.${methodName} is not a function`)
          }
          if (isOnce) {
            if (handler.once) {
              return
            }
            handler.once = true
485
          }
fxy060608's avatar
fxy060608 已提交
486
          handler.apply(handlerCtx, processEventArgs(
fxy060608's avatar
fxy060608 已提交
487 488 489 490 491 492 493
            this.$vm,
            event,
            eventArray[1],
            eventArray[2],
            isCustom,
            methodName
          ))
494 495 496 497 498
        }
      })
    }
  })
}