Vue项目中怎么引入jQuery或Lodash等第三方JS库

作者:望舒

时间:2026-11-17

浏览:646

详细讲解在Vue 2与Vue 3项目中引入Lodash纯函数库与jQuery DOM操作库的多种方案,涵盖npm模块化按需引入、全局挂载、构建工具自动注入、CDN外部化配置以及生命周期避坑指南。

文章目录

在基于 Vue 的前端工程中引入第三方 JavaScript 库,其核心分水岭取决于库本身的运行模式:以 Lodash 为代表的纯函数计算库,不触碰任何 DOM 节点,引入的重点在于按需导入与打包摇树(Tree-shaking)优化;而以 jQuery 为代表的直接 DOM 操作库,强依赖实际渲染出的 HTML 节点,引入的关键则在于与 Vue 组件生命周期协同,避免与虚拟 DOM 产生渲染冲突及内存泄漏。本文将针对这两类具有典型代表意义的库,深入解析模块化局部引入、全局挂载与构建注入、以及 CDN 外部化引入的具体做法与工程考量。

Vue项目中怎么引入jQuery或Lodash等第三方JS库
图 0:Vue 项目集成第三方 JS 库的全景架构与核心途径

一、区分两种第三方库的本质差异

很多开发者在 Vue 中引入库时容易遇到“明明引入了却报错”或“构建出来的产物体积异常庞大”的问题,其根源往往是没有厘清所引入库的底层运作机制:

  • 无状态纯函数库(如 Lodash、Day.js、Big.js):输入确定参数,返回确定结果。它们没有内部副作用,完全脱离浏览器的具体 DOM 树运作。在 Vue 2 或 Vue 3(无论是 Composition API 还是 Options API)中,都可以随时随地作为普通 JS 工具函数调用。对于这类库,首要任务是选用具备 ES Module 规范的版本(如 lodash-es),保证构建工具能够剔除未使用的死代码。
  • DOM 操作与 UI 增强库(如 jQuery、Swiper、ECharts):这类库需要挂载或绑定到真实的 DOM 容器上。由于 Vue 采用虚拟 DOM(Virtual DOM)机制,在组件刚初始化的 setup 执行期,页面元素根本尚未生成;若此时执行选择器查询,必将返回 null 或空数组。此外,若用 jQuery 直接对 DOM 节点进行增删改,可能会打乱 Vue 内部的 Diff 算法更新追踪。
Vue项目中怎么引入jQuery或Lodash等第三方JS库
图 1:Lodash 工具库与 jQuery DOM 库在 Vue 响应式架构下的运行特征对比

二、方案一:模块化局部引入(官方推荐的标准方案)

在现代模块化工程中,单文件组件(SFC)内按需局部引入是绝大多数场景下的第一选择。这种方案能够保持代码依赖清晰、天然支持构建工具的代码分割与摇树优化,避免全局命名空间污染。

1. 安装依赖包

在项目根目录下通过包管理器安装目标库。对于 Lodash,强烈建议直接安装 ESM 版本的 lodash-es;若项目使用 TypeScript,可同时补充类型定义文件:

# 安装 Lodash 模块化版本(推荐)
npm install lodash-es

# 若使用 TypeScript,安装类型包
npm install -D @types/lodash-es

# 安装 jQuery 及其类型定义
npm install jquery
npm install -D @types/jquery

2. 在组件中局部使用 Lodash

在 Vue 3 的 <script setup> 中,直接解构导入所需的单一功能函数即可:

<template>
  <div class="search-box">
    <input type="text" @input="onSearchInput" placeholder="输入搜索内容..." />
  </div>
</template>

<script setup>
// 精确按需解构引入,仅将 debounce 打包进当前 chunk
import { debounce } from 'lodash-es'

const onSearchInput = debounce((event) => {
  console.log('触发搜索请求,关键词:', event.target.value)
}, 300)
</script>
重点解释:不要使用 import _ from 'lodash' 这种全量导入写法。即使后续构建时开启了摇树优化,由于原始 lodash 主要是 CommonJS 导出规范,打包器(Rollup/Vite/Webpack)往往很难将其静态解构,容易导致 70KB 以上的完整库代码全量打包进 vendor 文件中。

3. 在组件中局部安全使用 jQuery

如果在某些历史遗留业务或复杂 jQuery 插件中必须使用 jQuery,务必牢记两项基本规范:使用 template ref 限制选择器范围,以及在 onMounted 钩子中初始化并在 onUnmounted 钩子中清理。

<template>
  <div class="chart-wrapper">
    <!-- 通过 ref 绑定根节点,避免在全局范围执行选择器 -->
    <div ref="containerRef" class="custom-panel">
      <button class="action-btn">点击触发插件交互</button>
    </div>
  </div>
</template>

<script setup>
import { ref, onMounted, onUnmounted } from 'vue'
import $ from 'jquery'

const containerRef = ref(null)

onMounted(() => {
  // 此时真实的 DOM 已经挂载完成,且通过 ref 锁定当前组件的作用域
  const $container = $(containerRef.value)

  // 监听内部事件或初始化旧版 jQuery 插件
  $container.find('.action-btn').on('click', function() {
    console.log('按钮在 jQuery 作用域中被点击')
  })
})

onUnmounted(() => {
  // 组件销毁时必须解绑事件,避免内存泄漏
  if (containerRef.value) {
    $(containerRef.value).find('.action-btn').off('click')
    $(containerRef.value).off()
  }
})
</script>
Vue项目中怎么引入jQuery或Lodash等第三方JS库
图 2:在 Vue 中引入并安全使用第三方库的标准 4 步流程

三、方案二:全局挂载与构建工具注入(高频调用场景)

如果项目中数十个页面、数百个组件都需要极其频繁地调用某个工具函数(例如数组深拷贝、金额格式化),在每个文件中反复书写 import 可能会显得较为繁琐。此时可以考虑应用级全局挂载或构建期自动注入。

1. Vue 3 应用级挂载 (globalProperties)

在应用入口文件 main.js(或 main.ts)中,将实例挂载到 app.config.globalProperties 上:

// main.js (Vue 3)
import { createApp } from 'vue'
import App from './App.vue'
import lodash from 'lodash-es'

const app = createApp(App)

// 挂载到全局属性,通常前缀以 $ 区分
app.config.globalProperties.$_ = lodash

app.mount('#app')

在组件中调用时:

  • 在模板(template)中可以直接使用:<span>{ $_.capitalize(username) }</span>
  • 在 Options API 中通过 this.$_ 访问。
  • 在 Composition API 的 setup 中,建议通过 getCurrentInstance() 获取,或者更规范地采用 app.provide('$_', lodash) 并在组件内使用 inject('$_')。

2. Vue 2 应用级挂载 (Vue.prototype)

在 Vue 2 项目中,全局挂载通过原型链实现:

// main.js (Vue 2)
import Vue from 'vue'
import App from './App.vue'
import _ from 'lodash'

Vue.prototype.$_ = _

new Vue({
  render: h => h(App)
}).$mount('#app')

3. 构建工具自动化注入 (ProvidePlugin / unplugin-auto-import)

全局属性挂载仍然要求在代码中使用特定前缀(如 this.$_ 或 proxy.$_)。有些老插件要求源码中直接出现裸变量 $ 或 jQuery。对于这种情况,可以在构建工具中配置变量提供器:

Webpack (Vue CLI / vue.config.js) 配置:

// vue.config.js
const webpack = require('webpack')

module.exports = {
  configureWebpack: {
    plugins: [
      new webpack.ProvidePlugin({
        $: 'jquery',
        jQuery: 'jquery',
        'window.jQuery': 'jquery'
      })
    ]
  }
}

Vite (vite.config.js) 现代自动化导入:

在 Vite 中,推荐使用 unplugin-auto-import 插件,既能自动引入,又不会丧失摇树优化:

// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import AutoImport from 'unplugin-auto-import/vite'

export default defineConfig({
  plugins: [
    vue(),
    AutoImport({
      imports: [
        'vue',
        {
          'lodash-es': [
            ['debounce', 'debounce'],
            ['cloneDeep', 'cloneDeep']
          ]
        }
      ],
      dts: 'src/auto-imports.d.ts'
    })
  ]
})
Vue项目中怎么引入jQuery或Lodash等第三方JS库
图 3:运行时全局挂载与构建期自动注入机制深度对比

四、方案三:通过 CDN 外部化引入(降低构建包体积)

当项目需要极大缩减 vendor.js 的打包体积,或者多个内部系统共用同一公共 CDN 节点缓存时,外部化(Externals)是一种高效的做法。

1. 在 index.html 中引入 CDN 资源

在公共模板文件的 <head> 或 <body> 底部注入脚本标签:

<!-- public/index.html -->
<!DOCTYPE html>
<html lang="zh-CN">
  <head>
    <meta charset="UTF-8" />
    <title>Vue App</title>
    <!-- 引入线上 CDN 库资源 -->
    <script src="https://cdn.jsdelivr.net/npm/jquery@3.7.1/dist/jquery.min.js"></script>
  </head>
  <body>
    <div id="app"></div>
  </body>
</html>

2. 配置构建工具排除打包(Externals)

通过配置告知构建工具:当代码中遇到 import $ from 'jquery' 时,不要从 node_modules 打包进产物,而是直接在运行时映射到 window.jQuery 全局变量。

Webpack (vue.config.js) 配置:

// vue.config.js
module.exports = {
  configureWebpack: {
    externals: {
      jquery: 'jQuery'
    }
  }
}

Vite (vite.config.js) 配置:

在 Vite 中可以通过 rollupOptions.external 与 output.globals 配置,或使用社区插件 vite-plugin-externals:

// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { viteExternalsPlugin } from 'vite-plugin-externals'

export default defineConfig({
  plugins: [
    vue(),
    viteExternalsPlugin({
      jquery: 'jQuery'
    })
  ]
})

完成配置后,业务组件中依然可以规范地书写 import $ from 'jquery',保持模块化代码风格与 TypeScript 静态校验完全不受影响,同时首屏构建包体积大幅缩减。

五、常见问题排查与关键避坑指南

在实际开发过程中,引入第三方库常伴随以下三大高频故障点:

1. 故障:jQuery 选择器执行结果为空(length 为 0)

  • 原因排查:直接在 <script setup> 的顶级同步代码中执行了选择器查询。此时组件处于初始创建阶段,虚拟 DOM 尚未转换为真实 DOM 节点挂载至页面。或者,目标节点被包裹在 v-if="condition" 中,初始状态下节点根本未被创建。
  • 解决办法:必须将选择与初始化逻辑移入 onMounted 回调函数中。如果是响应式数据改变后才渲染出的 DOM 元素,必须包裹在 await nextTick() 之后再执行选择。

2. 故障:生产环境构建体积剧增数十甚至上百 KB

  • 原因排查:在组件中错误书写了 import _ from 'lodash',或者 import { debounce } from 'lodash'。因为官方主包 lodash 主要是 CommonJS 构建规范,导致现代构建打包器无法进行代码消除(DCE),整个库的庞大函数集全部被打进 chunk 中。
  • 解决办法:
    1. 直接更换为基于 ES Module 开发的 lodash-es 包;
    2. 或者在原有 lodash 基础上采用具体文件路径导入:import debounce from 'lodash/debounce'。

3. 故障:单页面路由切换后出现内存泄漏或事件多次重复触发

  • 原因排查:使用 jQuery 绑定的事件(如 $(window).on('resize') 或 $(document).on(...))是挂载在全局 DOM 根上的。Vue 切换路由卸载当前组件时,虚拟 DOM 虽已移除,但挂载在外部节点上的原生事件侦听器及闭包变量仍然留在内存中,导致垃圾回收器无法回收,多次访问页面后事件被成倍重复触发。
  • 解决办法:在组件的 onUnmounted(Vue 2 为 beforeDestroy / destroyed)生命周期中,必须调用 .off() 彻底解绑事件,并调用对应第三方插件暴露的 .destroy() 方法注销插件。
Vue项目中怎么引入jQuery或Lodash等第三方JS库
图 4:第三方 JS 库引入方式决策树与常见问题排查指南

六、第三方库引入方式选型矩阵

下表归纳总结了不同引入方案的特征与适用场景,方便在实际业务项目中做出最佳选型:

引入方案 典型适用库 主要优势 潜在缺点 / 注意事项
模块化局部引入(按需) lodash-es, dayjs, 各种小体积函数库 依赖关系明确,Tree-shaking 彻底,打包体积最小 多个组件使用时需要分别 import(可用自动导入插件缓解)
应用级全局挂载 (globalProperties) 通用数据格式化工具、业务基类库 全局统一维护,组件直接通过代理实例使用 全量挂载无法摇树;TypeScript 需要扩充全局类型定义声明
构建工具全局注入 (ProvidePlugin) 传统依赖全局变量的 jQuery 插件、历史老旧包 无需改动老旧插件源码,自动注入局部变量 变量来源不够透明,代码静态分析和重构难度提升
CDN 外部化引入 (Externals) 大体积基础库(如 jquery.min.js, echarts.min.js) 极大减小构建包体积,充分利用浏览器与 CDN 缓存 强依赖外部网络环境与 CDN 稳定性;离线开发需配置备用本地源
结语与建议:在现代 Vue 3 项目中,优先推荐以 ESM 模块化局部引入为主;若涉及历史遗留的 jQuery 插件,则采用局部引入配合 ref 及 onMounted / onUnmounted 进行沙箱化封装。认清纯计算库与 DOM 库的界限,方能在保障应用性能的同时确保代码的健壮与高可维护性。

实用工具推荐

电子包浆

绿化、压缩、噪点和虚拟水印,自由调节做旧程度。

使用 ›
图片压缩

选择画质和输出格式,预览压缩前后的大小。

使用 ›
相关文章