v-model原理问题

v-model的原理

很多同学在理解Vue的时候都把Vue的数据响应原理理解为双向绑定，但实际上这是不准确的，我们之前提到的数据响应，都是通过数据的改变去驱动DOM重新的变化，而双向绑定已有数据驱动DOM外，DOM的变化反过来影响数据，是一个双向关系，在Vue中，我们可以通过v-model来实现双向绑定。

v-model即可以作用在普通表单元素上，又可以作用在组件上，它实际上是一个语法糖，接下来我们就来分析v-model的实现原理。

表单元素

为了更加直观，我们还是结合示例来分析：

let vm = new Vue({
  el: '#app',
  template: '<div>'
  + '<input v-model="message" placeholder="edit me">' +
  '<p>Message is: {{ message }}</p>' +
  '</div>',
  data() {
    return {
      message: ''
    }
  }
})

这是一个非常简单的演示，我们在input元素上设置了v-model属性，绑定了message，当我们在input上输入了内容，message也会同步变化。接下来我们就来分析Vue是如何实现这一效果的，其实非常简单。

也是先从编译阶段分析，首先是parse阶段，v-model被当做普通的指令解析到el.directives中，然后在codegen阶段，执行genData的时候，会执行const dirs = genDirectives(el, state)，它的定义在src/compiler/codegen/index.js中：

function genDirectives (el: ASTElement, state: CodegenState): string | void {
  const dirs = el.directives
  if (!dirs) return
  let res = 'directives:['
  let hasRuntime = false
  let i, l, dir, needRuntime
  for (i = 0, l = dirs.length; i < l; i++) {
    dir = dirs[i]
    needRuntime = true
    const gen: DirectiveFunction = state.directives[dir.name]
    if (gen) {
      // compile-time directive that manipulates AST.
      // returns true if it also needs a runtime counterpart.
      needRuntime = !!gen(el, dir, state.warn)
    }
    if (needRuntime) {
      hasRuntime = true
      res += `{name:"${dir.name}",rawName:"${dir.rawName}"${
        dir.value ? `,value:(${dir.value}),expression:${JSON.stringify(dir.value)}` : ''
      }${
        dir.arg ? `,arg:"${dir.arg}"` : ''
      }${
        dir.modifiers ? `,modifiers:${JSON.stringify(dir.modifiers)}` : ''
      }},`
    }
  }
  if (hasRuntime) {
    return res.slice(0, -1) + ']'
  }
}

 

genDrirectives方法就是遍历el.directives，然后获取每一个指令对应的方法const gen: DirectiveFunction = state.directives[dir.name]，这个指令方法实际上是在实例化CodegenState的时候通过option 引用的，这个option就是编译相关的配置，它在不同的平台下配置不同，在web环境下的定义在src/platforms/web/compiler/options.js下：

export const baseOptions: CompilerOptions = {
  expectHTML: true,
  modules,
  directives,
  isPreTag,
  isUnaryTag,
  mustUseProp,
  canBeLeftOpenTag,
  isReservedTag,
  getTagNamespace,
  staticKeys: genStaticKeys(modules)
}
directives定义在src/platforms/web/compiler/directives/index.js中：


export default {
  model,
  text,
  html
}
// 那么对于v-model而言，对应的directive函数是在src/platforms/web/compiler/directives/model.js中定义的model函数：

export default function model (
  el: ASTElement,
  dir: ASTDirective,
  _warn: Function
): ?boolean {
  warn = _warn
  const value = dir.value
  const modifiers = dir.modifiers
  const tag = el.tag
  const type = el.attrsMap.type
​
  if (process.env.NODE_ENV !== 'production') {
    // inputs with type="file" are read only and setting the input's
    // value will throw an error.
    if (tag === 'input' && type === 'file') {
      warn(
        `<${el.tag} v-model="${value}" type="file">:\n` +
        `File inputs are read only. Use a v-on:change listener instead.`
      )
    }
  }
​
  if (el.component) {
    genComponentModel(el, value, modifiers)
    // component v-model doesn't need extra runtime
    return false
  } else if (tag === 'select') {
    genSelect(el, value, modifiers)
  } else if (tag === 'input' && type === 'checkbox') {
    genCheckboxModel(el, value, modifiers)
  } else if (tag === 'input' && type === 'radio') {
    genRadioModel(el, value, modifiers)
  } else if (tag === 'input' || tag === 'textarea') {
    genDefaultModel(el, value, modifiers)
  } else if (!config.isReservedTag(tag)) {
    genComponentModel(el, value, modifiers)
    // component v-model doesn't need extra runtime
    return false
  } else if (process.env.NODE_ENV !== 'production') {
    warn(
      `<${el.tag} v-model="${value}">: ` +
      `v-model is not supported on this element type. ` +
      'If you are working with contenteditable, it\'s recommended to ' +
      'wrap a library dedicated for that purpose inside a custom component.'
    )
  }
​
  // ensure runtime directive metadata
  return true
}

也就是说我们执行needRuntime = !!gen(el, dir, state.warn)就是在执行model函数，它会根据AST元素例程的不同情况去执行不同的逻辑，对于我们这个案例而言，它会命中genDefaultModel(el, value, modifiers)的逻辑，稍后我们也会介绍组件的处理，其他分开同学们可以自行去看。我们来看一下genDefaultModel的实现：

function genDefaultModel (
  el: ASTElement,
  value: string,
  modifiers: ?ASTModifiers
): ?boolean {
  const type = el.attrsMap.type
​
  // warn if v-bind:value conflicts with v-model
  // except for inputs with v-bind:type
  if (process.env.NODE_ENV !== 'production') {
    const value = el.attrsMap['v-bind:value'] || el.attrsMap[':value']
    const typeBinding = el.attrsMap['v-bind:type'] || el.attrsMap[':type']
    if (value && !typeBinding) {
      const binding = el.attrsMap['v-bind:value'] ? 'v-bind:value' : ':value'
      warn(
        `${binding}="${value}" conflicts with v-model on the same element ` +
        'because the latter already expands to a value binding internally'
      )
    }
  }
​
  const { lazy, number, trim } = modifiers || {}
  const needCompositionGuard = !lazy && type !== 'range'
  const event = lazy
    ? 'change'
    : type === 'range'
      ? RANGE_TOKEN
      : 'input'
​
  let valueExpression = '$event.target.value'
  if (trim) {
    valueExpression = `$event.target.value.trim()`
  }
  if (number) {
    valueExpression = `_n(${valueExpression})`
  }
​
  let code = genAssignmentCode(value, valueExpression)
  if (needCompositionGuard) {
    code = `if($event.target.composing)return;${code}`
  }
​
  addProp(el, 'value', `(${value})`)
  addHandler(el, event, code, null, true)
  if (trim || number) {
    addHandler(el, 'blur', '$forceUpdate()')
  }
}

 

genDefaultModel函数先处理了modifiers，它的不同主要影响的是event和valueExpression的值，对于我们的示例，event为input，valueExpression为$event.target.value。然后去执行genAssignmentCode去生成代码，它的定义在src/compiler/directives/model.js中：

/**
 * Cross-platform codegen helper for generating v-model value assignment code.
 */
export function genAssignmentCode (
  value: string,
  assignment: string
): string {
  const res = parseModel(value)
  if (res.key === null) {
    return `${value}=${assignment}`
  } else {
    return `$set(${res.exp}, ${res.key}, ${assignment})`
  }
}

 

该方法首先对对应v-model的精心解决value，它处理了非常多的情况，对我们的例子，value就是messgae，所以返回的res.key为null，然后我们就得到${value}=${assignment}，也就是message=$event.target.value。然后我们又命中了needCompositionGuard为true的逻辑，所以最终的code为if($event.target.composing)return;message=$event.target.value。

code 生成完后，又执行了2句非常关键的代码：

addProp(el, 'value', `(${value})`)
addHandler(el, event, code, null, true)

这实际上就是input实现v-model的精髓，通过修改AST元素，给el添加一个prop，相当于我们在input上动态绑定了value，又给el添加了事件处理，相当于在input上绑定了input事件，实际上转换成模板如下：

<input
  v-bind:value="message"
  v-on:input="message=$event.target.value">

 

其实就是动态绑定了input的value指向messgae变量，并且在触发input事件的时候去动态把message设置为目标值，这样实际上就完成了数据双向绑定了，所以说v-model实际上就是语法糖。

再回到genDirectives，它接下来的逻辑就是根据指令生成一些data的代码：

if (needRuntime) {
  hasRuntime = true
  res += `{name:"${dir.name}",rawName:"${dir.rawName}"${
    dir.value ? `,value:(${dir.value}),expression:${JSON.stringify(dir.value)}` : ''
  }${
    dir.arg ? `,arg:"${dir.arg}"` : ''
  }${
    dir.modifiers ? `,modifiers:${JSON.stringify(dir.modifiers)}` : ''
  }},`
}

 

对我们的例子而言，最终生成的render代码如下：

with(this) {
  return _c('div',[_c('input',{
    directives:[{
      name:"model",
      rawName:"v-model",
      value:(message),
      expression:"message"
    }],
    attrs:{"placeholder":"edit me"},
    domProps:{"value":(message)},
    on:{"input":function($event){
      if($event.target.composing)
        return;
      message=$event.target.value
    }}}),_c('p',[_v("Message is: "+_s(message))])
    ])
}

关于事件的处理我们之前的章节已经分析过了，所以对于input的v-model而言，完全就是语法糖，并且对于其他表单元素套路都是一样，区别在于生成的事件代码会略有不同。

v-model 除了作用在表单元素上，新版的Vue还把这一语法糖用在了组件上，接下来我们来分析它的实现。

 

本文转自 http://caibaojian.com/vue-analysis/extend/v-model.html