Vue自定义指令意外生效之谜：深入探讨

本文探讨一个常见的Vue.js开发问题：自定义指令在未绑定目标元素上生效的原因。我们分析一个案例，解释这种现象背后的机制，并提供解决方案。

案例描述

我们创建了一个全局自定义指令 validateNumber，用于限制输入框只能输入数字：

Vue.directive('validateNumber', {
 bind(el, binding, vnode) {
  let lastData = null;
  el.onkeyup = (e) => {
if (String.fromCharCode(e.keyCode) === 'E' || String.fromCharCode(e.keyCode) === 'KeyE') {
 e.target.value = lastData;
 return false;
} else {
 lastData = e.target.value;
}
e.target.value = e.target.value.replace(/[^\d]/ig, '');

let _this = vnode.context;
_this.accessNestedObject(_this, vnode.data.model.expression, e.target.value);

if (binding.expression && e.target.value) {
 let obj = (new Function("return " + binding.expression))();
 let keys = Object.keys(obj);
 let values = Object.values(obj);
 if (keys[0] === 'min') {
  if (parseInt(e.target.value) < parseInt(values[1])) {
e.target.value = values[1];
  }
 }
}

el.dispatchEvent(new Event('input'));
  };
 }
});

在Vue模板中，我们仅在一个输入框上使用了该指令：

<el-form-item label="等待时间" prop="timeInterval">
  <el-input id="alarm-rule-time-interval" style="width:100%" type="number" v-model="alertRulesForm.timeInterval" v-validateNumber>
 <template slot="append">秒</template>
  </el-input>
</el-form-item>
<el-form-item label="空间间隔" prop="distanceInterval">
  <el-input id="alarm-rule-distance-interval" type="number" v-model="alertRulesForm.distanceInterval">
 <template slot="append">米</template>
  </el-input>
</el-form-item>

然而，第二个输入框（distanceInterval），尽管未应用 v-validateNumber 指令，却也表现出相同的数字校验行为。

立即学习“前端免费学习笔记（深入）”；

问题分析

关键在于 el.onkeyup 事件监听器。该监听器绑定在 el 元素上，而 el 指的是所有应用了 validateNumber 指令的元素。 由于指令的绑定机制，事件监听器可能会意外地捕获到其他元素的 keyup 事件，特别是当这些元素在 DOM 结构上与已绑定指令的元素存在父子或兄弟关系时。 type="number" 属性虽然限制了输入，但这并不能解释为什么第二个输入框会触发 validateNumber 指令的逻辑。

解决方案

为了避免这种意外的指令生效，我们需要改进指令的实现：

1. 更精确的事件监听: 不要直接监听 el.onkeyup，而是利用更精确的事件委托机制，例如，将事件监听器绑定到父元素，并使用 e.target 判断事件源是否为目标元素。

2. 指令范围限制: 在指令的 bind 或 inserted 方法中，可以检查 el 是否为目标元素，如果不是，则不执行指令逻辑。

修改后的指令：

Vue.directive('validateNumber', {
 bind(el, binding, vnode) {
  // 添加判断，确保指令只在目标元素上生效
  if (el.id !== 'alarm-rule-time-interval') return;

  let lastData = null;
  el.onkeyup = (e) => {
// ... (其余逻辑保持不变)
  };
 }
});

或者，使用事件委托：

Vue.directive('validateNumber', {
 bind(el, binding, vnode) {
  const parent = el.parentElement; // 获取父元素
  parent.addEventListener('keyup', (e) => {
if (e.target === el) { // 检查事件源是否为目标元素
 // ... (指令逻辑)
}
  });
 }
});

通过以上改进，我们可以确保自定义指令只在目标元素上生效，避免了意外的干扰。 记住，在编写自定义指令时，要格外注意事件监听器的作用范围和事件委托的正确使用，以确保指令的可靠性和可预测性。