一劳永逸的点击约束解决方案

研发背景，解决什么问题

• 点击约束：某个按钮触发一次点击后，待接口调用有结果都才能再次触发。避免用户屡次点击，触发屡次接口调用。
• 常规解决方案：为每一个按钮，定义一个变量记录其点击状态，经过变量控制按钮的可点击状态。如 element 库中的<el-button type="primary" :loading="true">加载中</el-button>。经过 loading 变量控制。

• 常规方案存在的问题：

  • 变量冗余，须要为每一个按钮定义一个变量记录其状态，使用成本和维护成本都比较高。

  • 兼容性不强，依赖 element 组件库，使用方法不通用。

• 本文章解决方案可解决以上问题，具备如下特色：

  • 使用成本低，代码粘贴复制便可，无需安装 npm 包，仅 180 行代码（包含 css 样式及 js）。
  • 兼容性强，不依赖第三方库，vue 技术盏项目都可接入。
  • 实现原理简单，代码无加密，无混淆。根据业务需求能够进行定制化样式调整。

  • 除点击约束外，还可实现内容区的 loading 遮罩效果。

在线示例

• 页面源码，经过控制台查看便可

使用方式（仅需两步）

• 注册全局自定义指令（代码量较少，且应对样式进行定制性调整。故不提供 npm 包，直接拷贝代码便可）

  Vue.directive('waiting', {
    bind: (targetDom, binding) => {
      // 注入全局方法
      (function() {
        if (window.hadResetAjaxForWaiting) { // 若是已经重置过，则再也不进入。解决开发时局部刷新致使从新加载问题
          return
        }
        window.hadResetAjaxForWaiting = true
        window.waitingAjaxMap = {} // 接口映射
  
        let OriginXHR = window.XMLHttpRequest
        let originOpen = OriginXHR.prototype.open
  
        // 重置 XMLHttpRequest
        window.XMLHttpRequest = function() {
          let targetDomList = [] // 存储本 ajax 请求，影响到的 dom 元素
          let realXHR = new OriginXHR() // 重置操做函数，获取请求数据
  
          realXHR.open = function(method, url, asyn) {
            Object.keys(window.waitingAjaxMap).forEach(key => {
              let [targetMethod, type, targetUrl] = key.split('::')
              if (!targetUrl) { // 设置默认类型
                targetUrl = type
                type = 'v-waiting-waiting'
              } else { // 指定类型
                type = `v-waiting-${type}`
              }
              if (targetMethod.toLocaleLowerCase() === method.toLocaleLowerCase() && url.indexOf(targetUrl) > -1) {
                targetDomList = [...window.waitingAjaxMap[key], ...targetDomList]
                window.waitingAjaxMap[key].forEach(dom => {
                  if (!dom.classList.contains(type)) {
                    dom.classList.add('v-waiting', type)
                    if (window.getComputedStyle(dom).position === 'static') { // 若是是 static 定位，则修改成 relative，为伪类的绝对定位作准备
                      dom.style.position = 'relative'
                    }
                  }
                  dom.waitingAjaxNum = dom.waitingAjaxNum || 0 // 不使用 dataset，是应为 dataset 并不实时，在同一个时间内，上一次存储的值不能被保存
                  dom.waitingAjaxNum++
                })
              }
            })
            originOpen.call(realXHR, method, url, asyn)
          }
  
          // 监听加载完成，清除 waiting
          realXHR.addEventListener('loadend', () => {
            targetDomList.forEach(dom => {
              dom.waitingAjaxNum--
              dom.waitingAjaxNum === 0 && dom.classList.remove(
                'v-waiting',
                'v-waiting-loading',
                'v-waiting-waiting',
                'v-waiting-disable',
              )
            })
          }, false)
          return realXHR
        }
      })();
  
      // 注入全局 css
      (() => {
        if (!document.getElementById('v-waiting')) {
          let code = `
         .v-waiting {
      pointer-events: none;
      /*cursor: not-allowed; 与 pointer-events: none 互斥，设置 pointer-events: none 后，设置鼠标样式无效 */
    }
    .v-waiting::before {
      position: absolute;
      content: '';
      left: 0;
      top: 0;
      width: 100%;
      height: 100%;
      opacity: 0.7;
      z-index: 9999;
      background-color: #ffffff;
    }
    .v-waiting-waiting::after {
      position: absolute;
      content: '数据加载中';
      top: 50%;
      left: 0;
      width: 100%;
      max-width: 100vw;
      color: #666666;
      font-size: 20px;
      text-align: center;
      transform: translateY(-50%);
      z-index: 9999;
      animation: v-waiting-v-waiting-keyframes 1.8s infinite linear;
    }
     @-webkit-keyframes v-waiting-v-waiting-keyframes {
      20% {
        content: '数据加载中.';
      }
      40% {
        content: '数据加载中..';
      }
      60% {
        content: '数据加载中...';
      }
      80% {
        content: '数据加载中...';
      }
    }
    .v-waiting-loading::after {
      position: absolute;
      content: '';
      left: 50%;
      top: 50%;
      width: 30px;
      height: 30px;
      z-index: 9999;
      cursor: not-allowed;
      animation: v-waiting-v-loading-keyframes 1.1s infinite linear;
      background-position: center;
      background-size: 30px 30px;
      background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAMAAABg3Am1AAAAWlBMVEUAAABmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZJqDNWAAAAHXRSTlMAgOKKPykV1K5JDbIf9OzNvGHGpZ5lNi8Hl3RVbc989bAAAAE8SURBVEjH5ZRZcsMgEEQR2li0WbuXvv81k5ARTllAQZV/Un5fAnWbYdwj9iaKXM9Zgr7EDzxav9cw5LGGB4gq0iBArEFZtTb0lIEoQ3oNoN/MoyQ93wP62lb9rOnil9sqxO9y4YCW9mXfnxo2gVC0sannyxZoq9MN/PdsXPs56WtPm8dTT8lwYy5W6YiPadOdxbM/RL6x/4sqk+SNBupb0jxS0sLITNp5NJhlOJ4ZJSVmgiub/gLEENKTrPh7QvjaqgPQmcyPMLSBXFDYaup+fZwWRhXKNmDsppJ9InLu9JKgzwL/9jLPp2iu8Gf2jm+ml80rGbg7ducPygCi8MQOmfuEznuCfLkXGa40tTkf7E/mVKuzJtLT4nBw7piuS9/abXGUHQuHQaQapmiDTiyJWt8rFu8YWy4q9g6+AGYbJ4l/4YQUAAAAAElFTkSuQmCC);
    }
    @-webkit-keyframes v-waiting-v-loading-keyframes {
      from {
        transform: translate(-50%, -50%) rotate(0deg);
      }
      to {
        transform: translate(-50%, -50%) rotate(360deg);
      }
    }        `
          let style = document.createElement('style')
          style.id = 'v-waiting'
          style.type = 'text/css'
          style.rel = 'stylesheet'
          style.appendChild(document.createTextNode(code))
          let head = document.getElementsByTagName('head')[0]
          head.appendChild(style)
        }
      })()
  
      // 添加须要监听的接口，注入对应的 dom
      const targetUrlList = Array.isArray(binding.value) ? binding.value : [binding.value]
      targetUrlList.forEach(targetUrl => {
        window.waitingAjaxMap[targetUrl] = [targetDom, ...(window.waitingAjaxMap[targetUrl] || [])]
      })
    },
  
    // 参数变化
    update: (targetDom, binding) => {
      if (binding.oldValue !== binding.value) {
        const preTargetUrlList = Array.isArray(binding.oldValue) ? binding.oldValue : [binding.oldValue]
        preTargetUrlList.forEach(targetUrl => {
          const index = (window.waitingAjaxMap[targetUrl] || []).indexOf(targetDom)
          index > -1 && window.waitingAjaxMap[targetUrl].splice(index, 1)
        })
  
        // 添加须要监听的接口，注入对应的 dom
        const targetUrlList = Array.isArray(binding.value) ? binding.value : [binding.value]
        targetUrlList.forEach(targetUrl => {
          window.waitingAjaxMap[targetUrl] = [targetDom, ...(window.waitingAjaxMap[targetUrl] || [])]
        })
      }
    },
  
    // 指令被卸载，消除消息监听
    unbind: (targetDom, binding) => {
      const targetUrlList = typeof binding.value === 'object' ? binding.value : [binding.value]
      targetUrlList.forEach(targetUrl => {
        const index = window.waitingAjaxMap[targetUrl].indexOf(targetDom)
        index > -1 && window.waitingAjaxMap[targetUrl].splice(index, 1)
        if (window.waitingAjaxMap[targetUrl].length === 0) {
          delete window.waitingAjaxMap[targetUrl]
        }
      })
    }
  })

• 在目标 dom 上，添加 v-waiting 属性
  <div class="btn" v-waiting="'get::loading::http://yapi.luckly-mjw.cn/mock/50/test/users?pageIndex=1'" @click="ajaxSingleTest">发送单个请求 loading</div>

  • v-waiting 参数格式介绍

    • v-waiting="'get::loading::/mock/50/test/users'"
    • 其中「get」表示监听的接口请求类型
    • 「loading」 标识点击约束时的 loading 样式。一种有三种，分别是「loading」「waiting」「disabled」。能够不填，默认为「waiting」。
    • 「/mock/50/test/users」标识须要监听的接口名，本质是经过url.indexOf(targetUrl)，indexOf 来进行字符串匹配。

  • 监听多个请求

    • <div v-waiting="['get::waiting::/test/users?pageIndex=2', 'get::/test/users?pageIndex=1']" @click="test"></div>
    • 经过数组形式，传入多个须要监听的请求。
    • loading 样式将在接口调用时显示，直到发起请求的全部接口请求均调用完成，才消除。
    • 未发起请求的接口，即便写在数组里面，也不会影响。

    • 数组的第二条数据，没有指定第二个参数的 loading 样式，该参数是可选的，默认样式为「waiting」

实现原理

• 重写 「XMLHttpRequest」，实现 ajax 的底层通用性监听，在接口发起时添加样式，返回结果后消除。

  • 屏蔽工具层的差别，不管使用的是 axios，仍是 jquery-ajax，仍是原生 XMLHttpRequest 都可实现监听。
  • 经过字符串匹配来监听不一样的请求，url.indexOf(targetUrl) > -1。
  • 经实际应用经验，暂不考虑同名接口冲突状况。
  • 有需求的同窗，能够提「issues」，做者会及时反馈。

• loading 内容的展现，经过伪类元素「::before」及「::after」来显示。

  • 其中「::before」实现遮罩层效果，
  • 使用「::after」元素的 content 来实现「加载中...」「旋转 loading icon」 的显示
  • 无需插入新的 dom 元素
  • 减小对 dom 布局的影响

源码以下

Vue.directive('waiting', {
  bind: (targetDom, binding) => {
    // 注入全局方法
    (function() {
      if (window.hadResetAjaxForWaiting) { // 若是已经重置过，则再也不进入。解决开发时局部刷新致使从新加载问题
        return
      }
      window.hadResetAjaxForWaiting = true
      window.waitingAjaxMap = {} // 接口映射 'get::http://yapi.luckly-mjw.cn/mock/50/test/users?pageIndex=1': dom

      let OriginXHR = window.XMLHttpRequest
      let originOpen = OriginXHR.prototype.open

      // 重置 XMLHttpRequest
      window.XMLHttpRequest = function() {
        let targetDomList = [] // 存储本 ajax 请求，影响到的 dom 元素
        let realXHR = new OriginXHR() // 重置操做函数，获取请求数据

        realXHR.open = function(method, url, asyn) {
          Object.keys(window.waitingAjaxMap).forEach(key => {
            let [targetMethod, type, targetUrl] = key.split('::')
            if (!targetUrl) { // 设置默认类型
              targetUrl = type
              type = 'v-waiting-waiting'
            } else { // 指定类型
              type = `v-waiting-${type}`
            }
            if (targetMethod.toLocaleLowerCase() === method.toLocaleLowerCase() && url.indexOf(targetUrl) > -1) {
              targetDomList = [...window.waitingAjaxMap[key], ...targetDomList]
              window.waitingAjaxMap[key].forEach(dom => {
                if (!dom.classList.contains(type)) {
                  dom.classList.add('v-waiting', type)
                  if (window.getComputedStyle(dom).position === 'static') { // 若是是 static 定位，则修改成 relative，为伪类的绝对定位作准备
                    dom.style.position = 'relative'
                  }
                }
                dom.waitingAjaxNum = dom.waitingAjaxNum || 0 // 不使用 dataset，是应为 dataset 并不实时，在同一个时间内，上一次存储的值不能被保存
                dom.waitingAjaxNum++
              })
            }
          })
          originOpen.call(realXHR, method, url, asyn)
        }

        // 监听加载完成，清除 waiting
        realXHR.addEventListener('loadend', () => {
          targetDomList.forEach(dom => {
            dom.waitingAjaxNum--
            dom.waitingAjaxNum === 0 && dom.classList.remove(
              'v-waiting',
              'v-waiting-loading',
              'v-waiting-waiting',
              'v-waiting-disable',
            )
          })
        }, false)
        return realXHR
      }
    })();

    // 注入全局 css
    (() => {
      if (!document.getElementById('v-waiting')) {
        let code = `
       .v-waiting {
    pointer-events: none;
    /*cursor: not-allowed; 与 pointer-events: none 互斥，设置 pointer-events: none 后，设置鼠标样式无效 */
  }
  .v-waiting::before {
    position: absolute;
    content: '';
    left: 0;
    top: 0;
    width: 100%;
    height: 100%;
    opacity: 0.7;
    z-index: 9999;
    background-color: #ffffff;
  }
  .v-waiting-waiting::after {
    position: absolute;
    content: '数据加载中';
    top: 50%;
    left: 0;
    width: 100%;
    max-width: 100vw;
    color: #666666;
    font-size: 20px;
    text-align: center;
    transform: translateY(-50%);
    z-index: 9999;
    animation: v-waiting-v-waiting-keyframes 1.8s infinite linear;
  }
   @-webkit-keyframes v-waiting-v-waiting-keyframes {
    20% {
      content: '数据加载中.';
    }
    40% {
      content: '数据加载中..';
    }
    60% {
      content: '数据加载中...';
    }
    80% {
      content: '数据加载中...';
    }
  }
  .v-waiting-loading::after {
    position: absolute;
    content: '';
    left: 50%;
    top: 50%;
    width: 30px;
    height: 30px;
    z-index: 9999;
    cursor: not-allowed;
    animation: v-waiting-v-loading-keyframes 1.1s infinite linear;
    background-position: center;
    background-size: 30px 30px;
    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAMAAABg3Am1AAAAWlBMVEUAAABmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZJqDNWAAAAHXRSTlMAgOKKPykV1K5JDbIf9OzNvGHGpZ5lNi8Hl3RVbc989bAAAAE8SURBVEjH5ZRZcsMgEEQR2li0WbuXvv81k5ARTllAQZV/Un5fAnWbYdwj9iaKXM9Zgr7EDzxav9cw5LGGB4gq0iBArEFZtTb0lIEoQ3oNoN/MoyQ93wP62lb9rOnil9sqxO9y4YCW9mXfnxo2gVC0sannyxZoq9MN/PdsXPs56WtPm8dTT8lwYy5W6YiPadOdxbM/RL6x/4sqk+SNBupb0jxS0sLITNp5NJhlOJ4ZJSVmgiub/gLEENKTrPh7QvjaqgPQmcyPMLSBXFDYaup+fZwWRhXKNmDsppJ9InLu9JKgzwL/9jLPp2iu8Gf2jm+ml80rGbg7ducPygCi8MQOmfuEznuCfLkXGa40tTkf7E/mVKuzJtLT4nBw7piuS9/abXGUHQuHQaQapmiDTiyJWt8rFu8YWy4q9g6+AGYbJ4l/4YQUAAAAAElFTkSuQmCC);
  }
  @-webkit-keyframes v-waiting-v-loading-keyframes {
    from {
      transform: translate(-50%, -50%) rotate(0deg);
    }
    to {
      transform: translate(-50%, -50%) rotate(360deg);
    }
  }        `
        let style = document.createElement('style')
        style.id = 'v-waiting'
        style.type = 'text/css'
        style.rel = 'stylesheet'
        style.appendChild(document.createTextNode(code))
        let head = document.getElementsByTagName('head')[0]
        head.appendChild(style)
      }
    })()

    // 添加须要监听的接口，注入对应的 dom
    const targetUrlList = Array.isArray(binding.value) ? binding.value : [binding.value]
    targetUrlList.forEach(targetUrl => {
      window.waitingAjaxMap[targetUrl] = [targetDom, ...(window.waitingAjaxMap[targetUrl] || [])]
    })
  },

  // 参数变化
  update: (targetDom, binding) => {
    if (binding.oldValue !== binding.value) {
      const preTargetUrlList = Array.isArray(binding.oldValue) ? binding.oldValue : [binding.oldValue]
      preTargetUrlList.forEach(targetUrl => {
        const index = (window.waitingAjaxMap[targetUrl] || []).indexOf(targetDom)
        index > -1 && window.waitingAjaxMap[targetUrl].splice(index, 1)
      })

      // 添加须要监听的接口，注入对应的 dom
      const targetUrlList = Array.isArray(binding.value) ? binding.value : [binding.value]
      targetUrlList.forEach(targetUrl => {
        window.waitingAjaxMap[targetUrl] = [targetDom, ...(window.waitingAjaxMap[targetUrl] || [])]
      })
    }
  },

  // 指令被卸载，消除消息监听
  unbind: (targetDom, binding) => {
    const targetUrlList = typeof binding.value === 'object' ? binding.value : [binding.value]
    targetUrlList.forEach(targetUrl => {
      const index = window.waitingAjaxMap[targetUrl].indexOf(targetDom)
      index > -1 && window.waitingAjaxMap[targetUrl].splice(index, 1)
      if (window.waitingAjaxMap[targetUrl].length === 0) {
        delete window.waitingAjaxMap[targetUrl]
      }
    })
  }
})

注意事项

• 因为底层是经过伪类「::after」「::before」来填充元素的，故将会覆盖使用 v-waiting 自定义指令的 dom 元素本来的 「::after」「::before」
• 本文仅实现 「XMLHttpRequest」 的重载，未对「fetch」方法进行监听，有这方面需求的同窗，欢迎提「issues」。

完结撒花，感谢阅读。