在 Vite项目中使用插件 @rollup/plugin-inject 注入全局 jQuery的过程详解

更新时间：2022年12月01日 10:31:39 作者：Never Yu

在一次项目脚手架升级的过程中，将之前基于 webpack 搭建的项目移植到 Vite 构建，这篇文章主要介绍了在 Vite项目中，使用插件 @rollup/plugin-inject 注入全局 jQuery,需要的朋友可以参考下

写在前面

在一次项目脚手架升级的过程中，将之前基于 webpack 搭建的项目移植到 Vite 构建。

一些组件库是依赖 jQuery 的，如：Bootstrap；引入这些组件的时候，需要项目中已经存在 jQuery 环境。

例如：当我们在 main.js 中使用如下方式引入 Bootstrap 时：

// main.js
/* bootstarp */
import '@/assets/css/bootstrap.min.css'
import '@/assets/js/bootstrap.min.js'

我们必须保证拥有全局的 jQuery 环境。否则，在 Bootstrap 中会报缺少 jQuery 的错误。

在原项目中，在 webpack.base.conf.js 中，有一段关于 jQuery 的配置是这样的：

module.exports = {
  ...
  plugins: [
    new webpack.ProvidePlugin({
      $: "jquery",
      jQuery: "jquery",
      "windows.jQuery": "jquery"
    })
  ],
  ...
}

使用 webpack.ProvidePlugin 插件全局注入 jQuery，这样在项目构建启动运行后，项目中就有了全局的 jQuery 环境。

那么，在 Vite 的项目中，该如何来配置或者来实现这个功能呢？

方法一、全局静态引入

全局静态引入的意思，就是在项目的主页面文件 index.html 中，使用原始引入 js 文件的方式来引入 jquery。

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Vite-Vue3</title>
    <script src="/src/jquery.min.js"></script>
  </head>
  <body>
    <div id="app"></div>
    <script type="module" src="/src/main.js"></script>
  </body>
</html>

方法二、使用插件 @rollup/plugin-inject 注入 jquery

首先，安装 jquery、@rollup/plugin-inject.

npm i jquery @rollup/plugin-inject -S

在项目的配置文件 vite.config.js 中：

import inject from '@rollup/plugin-inject'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
    inject({
      $: "jquery",  // 这里会自动载入 node_modules 中的 jquery
      jQuery: "jquery",
      "windows.jQuery": "jquery"
    })
  ],
  resolve: {
    alias: {
      '@': resolve(__dirname, './src')
    }
  }
})

这样，即可在 Vite 项目中实现 webpack.ProvidePlugin 的功能。

课外知识：

一、关于 webpack.ProvidePlugin

了解 webpack 的插件使用方式：

// webpack.base.conf.js
const HtmlWebpackPlugin = require('html-webpack-plugin')

module.exports = {
  ...
  plugins: [
    new webpack.ProvidePlugin({}),
    new webpack.IgnorePlugin('/^\.\/locale$/, /moment$/'),
    // or(或者)
    new HtmlWebpackPlugin({
      template: './src/index.html'
    })
  ]
  ...
}

这里面有两种 webpack 的插件使用方式：new webpack.ProvidePlugin() 和 new HtmlWebpackPlugin();

前者是 webpack 内置的模块，后者不是 webpack 内置的模块，需要使用 npm 先进行安装再使用。

ProvidePlugin，是 webpack 的内置模块。
使用 ProvidePlugin 加载的模块在使用时将不再需要 import 和 require 进行引入。
以 jquery 为例，用 ProvidePlugin 进行实例初始化后，jquery 就会被自动加载并导入对应的 node 模块中。

new webpack.ProvidePlugin({
  $: 'jquery',
  jQuery: 'jquery'
})

// 然后我们可以在代码中直接使用

$('#item'); // <= just works
jQuery('#item'); // <= just works
// $ is automatically set to the exports of module "jquery"

二、使用 @rollup/plugin-node-resolve 解决模块之间引用问题

使用 @rollup/plugin-node-resolve 解决模块之间引用问题。

到此这篇关于在 Vite项目中，使用插件 @rollup/plugin-inject 注入全局 jQuery的文章就介绍到这了,更多相关@rollup/plugin-inject 注入全局 jQuery内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Vite引入虚拟文件的实现
本文主要介绍了Vite引入虚拟文件的实现，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-08-08
vuex 如何动态引入 store modules
这篇文章主要介绍了vuex 如何动态引入 store modules，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
浅谈validator自定义验证及易错点
这篇文章主要介绍了validator自定义验证及易错点，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-02-02
Vue中Mustache引擎插值语法使用详解
在Vue中通过Mustache模板引擎将data中的文本数据插入到HTML中,下面这篇文章主要给大家介绍了关于Vue中Mustache模板引擎插值语法的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-12-12
解决vue-cli@3.xx安装不成功的问题及搭建ts-vue项目
这篇文章主要介绍了解决vue-cli@3.xx安装不成功的问题及搭建ts-vue项目.文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-02-02
详解uniapp的生命周期
这篇文章主要介绍了uniapp的生命周期,应用生命周期是指应用程序从启动到关闭的整个过程，包括应用程序的启动、前后台切换、退出等,需要的朋友可以参考下
2023-04-04
vue通过过滤器实现数据格式化
这篇文章主要介绍了vue通过过滤器实现数据格式化的方法，文中讲解非常细致，帮助大家更好的理解和学习，感兴趣的朋友可以了解下
2020-07-07
vue2.x集成百度UEditor富文本编辑器的方法
这篇文章主要为大家详细介绍了vue2.x集成百度UEditor富文本编辑器的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-09-09
vue+Element-ui实现登录注册表单
这篇文章主要为大家详细介绍了vue+Element-ui实现登录注册表单，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-11-11
django+vue实现跨域的示例代码
在我们的项目中需要用到django实现跨域的问题，本文通过示例代码给大家详细介绍django+vue实现跨域的方法，感兴趣的朋友跟随小编一起看看吧
2022-03-03