util.js 11.8 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]
    }
  })
}

26
export function initHooks (mpOptions, hooks) {
27 28
  hooks.forEach(hook => {
    mpOptions[hook] = function (args) {
fxy060608's avatar
fxy060608 已提交
29
      return this.$vm && this.$vm.__call_hook(hook, args)
30 31 32 33
    }
  })
}

fxy060608's avatar
fxy060608 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
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 已提交
69 70
  let data = vueOptions.data || {}
  const methods = vueOptions.methods || {}
71 72 73

  if (typeof data === 'function') {
    try {
fxy060608's avatar
fxy060608 已提交
74
      data = data.call(context) // 支持 Vue.prototype 上挂的数据
75
    } catch (e) {
76 77 78
      if (process.env.VUE_APP_DEBUG) {
        console.warn('根据 Vue 的 data 函数初始化小程序 data 失败,请尽量确保 data 函数中不访问 vm 对象,否则可能影响首次数据渲染速度。', data)
      }
79
    }
80 81 82 83 84
  } else {
    try {
      // 对 data 格式化
      data = JSON.parse(JSON.stringify(data))
    } catch (e) {}
85 86 87 88
  }

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

91
  Object.keys(methods).forEach(methodName => {
fxy060608's avatar
fxy060608 已提交
92
    if (context.__lifecycle_hooks__.indexOf(methodName) === -1 && !hasOwn(data, methodName)) {
93 94 95 96 97
      data[methodName] = methods[methodName]
    }
  })

  return data
98 99 100 101
}

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

fxy060608's avatar
fxy060608 已提交
102 103 104 105 106 107 108 109
function createObserver (name) {
  return function observer (newVal, oldVal) {
    if (this.$vm) {
      this.$vm[name] = newVal // 为了触发其他非 render watcher
    }
  }
}

fxy060608's avatar
fxy060608 已提交
110
export function initBehaviors (vueOptions, initBehavior) {
fxy060608's avatar
fxy060608 已提交
111 112 113 114 115 116 117 118 119 120
  const vueBehaviors = vueOptions['behaviors']
  const vueExtends = vueOptions['extends']
  const vueMixins = vueOptions['mixins']

  let vueProps = vueOptions['props']

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

121
  const behaviors = []
fxy060608's avatar
fxy060608 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135
  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 {
          vueProps['name'] = String
          vueProps['value'] = null
        }
      }
    })
  }
136 137
  if (isPlainObject(vueExtends) && vueExtends.props) {
    behaviors.push(
138
      initBehavior({
fxy060608's avatar
fxy060608 已提交
139
        properties: initProperties(vueExtends.props, true)
140 141 142 143 144 145 146
      })
    )
  }
  if (Array.isArray(vueMixins)) {
    vueMixins.forEach(vueMixin => {
      if (isPlainObject(vueMixin) && vueMixin.props) {
        behaviors.push(
147
          initBehavior({
fxy060608's avatar
fxy060608 已提交
148
            properties: initProperties(vueMixin.props, true)
149 150 151 152 153 154 155 156
          })
        )
      }
    })
  }
  return behaviors
}

157
function parsePropType (key, type, defaultValue, file) {
158 159 160 161 162 163
  // [String]=>String
  if (Array.isArray(type) && type.length === 1) {
    return type[0]
  }
  if (__PLATFORM__ === 'mp-baidu') {
    if (
164 165
      defaultValue === false &&
            Array.isArray(type) &&
166
            type.length === 2 &&
167 168
            type.indexOf(String) !== -1 &&
            type.indexOf(Boolean) !== -1
169
    ) { // [String,Boolean]=>Boolean
170 171 172 173
      if (file) {
        console.warn(
          `props.${key}.type should use Boolean instead of [String,Boolean] at ${file}`
        )
174
      }
175
      return Boolean
176 177 178 179 180
    }
  }
  return type
}

fxy060608's avatar
fxy060608 已提交
181
export function initProperties (props, isBehavior = false, file = '') {
182 183
  const properties = {}
  if (!isBehavior) {
fxy060608's avatar
fxy060608 已提交
184 185 186 187
    properties.vueId = {
      type: String,
      value: ''
    }
188
    properties.vueSlots = { // 小程序不能直接定义 $slots 的 props,所以通过 vueSlots 转换到 $slots
189 190 191 192 193 194 195 196 197 198 199 200 201
      type: null,
      value: [],
      observer: function (newVal, oldVal) {
        const $slots = Object.create(null)
        newVal.forEach(slotName => {
          $slots[slotName] = true
        })
        this.setData({
          $slots
        })
      }
    }
  }
202 203
  if (Array.isArray(props)) { // ['title']
    props.forEach(key => {
fxy060608's avatar
fxy060608 已提交
204 205 206 207
      properties[key] = {
        type: null,
        observer: createObserver(key)
      }
208 209 210 211 212 213 214 215 216
    })
  } 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()
        }
217

218
        opts.type = parsePropType(key, opts.type, value, file)
219

220
        properties[key] = {
221
          type: PROP_TYPES.indexOf(opts.type) !== -1 ? opts.type : null,
fxy060608's avatar
fxy060608 已提交
222 223
          value,
          observer: createObserver(key)
224 225
        }
      } else { // content:String
226
        const type = parsePropType(key, opts, null, file)
fxy060608's avatar
fxy060608 已提交
227
        properties[key] = {
228
          type: PROP_TYPES.indexOf(type) !== -1 ? type : null,
fxy060608's avatar
fxy060608 已提交
229 230
          observer: createObserver(key)
        }
231 232 233 234 235 236 237
      }
    })
  }
  return properties
}

function wrapper (event) {
fxy060608's avatar
fxy060608 已提交
238 239 240 241 242
  // TODO 又得兼容 mpvue 的 mp 对象
  try {
    event.mp = JSON.parse(JSON.stringify(event))
  } catch (e) {}

243 244 245 246
  event.stopPropagation = noop
  event.preventDefault = noop

  event.target = event.target || {}
fxy060608's avatar
fxy060608 已提交
247 248 249 250

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

  if (__PLATFORM__ === 'mp-baidu') { // mp-baidu,checked=>value
fxy060608's avatar
fxy060608 已提交
253 254 255 256 257
    if (
      isPlainObject(event.detail) &&
            hasOwn(event.detail, 'checked') &&
            !hasOwn(event.detail, 'value')
    ) {
fxy060608's avatar
fxy060608 已提交
258 259 260 261
      event.detail.value = event.detail.checked
    }
  }

fxy060608's avatar
fxy060608 已提交
262 263 264 265
  if (isPlainObject(event.detail)) {
    event.target = Object.assign({}, event.target, event.detail)
  }

266 267 268
  return event
}

fxy060608's avatar
fxy060608 已提交
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
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
}

306
function processEventExtra (vm, extra, event) {
fxy060608's avatar
fxy060608 已提交
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  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 {
326 327 328 329 330 331 332
          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 已提交
333 334 335 336 337 338 339 340 341 342
        }
      } else {
        extraObj['$' + index] = getExtraValue(vm, dataPath)
      }
    })
  }

  return extraObj
}

fxy060608's avatar
fxy060608 已提交
343 344 345 346 347 348 349 350 351
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 已提交
352
function processEventArgs (vm, event, args = [], extra = [], isCustom, methodName) {
fxy060608's avatar
fxy060608 已提交
353
  let isCustomMPEvent = false // wxcomponent 组件,传递原始 event 对象
354
  if (isCustom) { // 自定义事件
fxy060608's avatar
fxy060608 已提交
355
    isCustomMPEvent = event.currentTarget &&
356
            event.currentTarget.dataset &&
357
            event.currentTarget.dataset.comType === 'wx'
fxy060608's avatar
fxy060608 已提交
358 359 360 361
    if (!args.length) { // 无参数,直接传入 event 或 detail 数组
      if (isCustomMPEvent) {
        return [event]
      }
fxy060608's avatar
fxy060608 已提交
362
      return event.detail.__args__ || event.detail
363
    }
364
  }
fxy060608's avatar
fxy060608 已提交
365

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

368 369 370
  const ret = []
  args.forEach(arg => {
    if (arg === '$event') {
fxy060608's avatar
fxy060608 已提交
371 372 373
      if (methodName === '__set_model' && !isCustom) { // input v-model value
        ret.push(event.target.value)
      } else {
fxy060608's avatar
fxy060608 已提交
374
        if (isCustom && !isCustomMPEvent) {
fxy060608's avatar
fxy060608 已提交
375
          ret.push(event.detail.__args__[0])
fxy060608's avatar
fxy060608 已提交
376 377 378
        } else { // wxcomponent 组件或内置组件
          ret.push(event)
        }
fxy060608's avatar
fxy060608 已提交
379
      }
380
    } else {
fxy060608's avatar
fxy060608 已提交
381 382 383
      if (Array.isArray(arg) && arg[0] === 'o') {
        ret.push(getObjByArray(arg))
      } else if (typeof arg === 'string' && hasOwn(extraObj, arg)) {
fxy060608's avatar
fxy060608 已提交
384 385 386 387
        ret.push(extraObj[arg])
      } else {
        ret.push(arg)
      }
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
    }
  })

  return ret
}

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

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

    if (eventsArray && eventType === type) {
      eventsArray.forEach(eventArray => {
419
        const methodName = eventArray[0]
fxy060608's avatar
fxy060608 已提交
420 421 422 423 424 425 426 427 428 429
        if (methodName) {
          const handler = this.$vm[methodName]
          if (!isFn(handler)) {
            throw new Error(` _vm.${methodName} is not a function`)
          }
          if (isOnce) {
            if (handler.once) {
              return
            }
            handler.once = true
430
          }
fxy060608's avatar
fxy060608 已提交
431 432 433 434 435 436 437 438
          handler.apply(this.$vm, processEventArgs(
            this.$vm,
            event,
            eventArray[1],
            eventArray[2],
            isCustom,
            methodName
          ))
439 440 441 442 443
        }
      })
    }
  })
}