一篇学会如何使用Vite重构Vue3项目

截止发文时间，vite正式版已经发布快2年时间了，vue3也发布到3.2版本了，它的周边设施基本上已经齐活了。也是时候再次重构下我那个vue3.0的开源项目了。,本篇文章就记录下我的重构过程，欢迎各位感兴趣的开发者阅读本文。,1年多前，我用Vue Cli 4.5构建的此项目，有关此项目的更多细节请移步我的另一篇文章使用Vue3重构Vue2项目。同样的，从CLI迁移到Vite仍然是在package.json中添加vite的依赖项，在项目中添加它的配置文件。,此次项目构建还加入了volta的相关配置，对此感兴趣的开发者请移步：强大的JavaScript工具管理器Volta,我们打开package.json，找到devDependencies字段，移除CLI相关的依赖，添加vite相关的依赖，如下所示：,随后，我们找到scripts字段，修改项目的运行与构建命令。,vite3.x版本要求node版本必须大于14.18.0，因此我们需要在engines字段中做一下提示，如下所示：,除了上述配置外，我们还需要在项目的根目录创建.npmrc文件，写入下述内容：,配置完成后，我们执行在终端执行yarn install安装依赖即可。,在上述配置中，我们还强制设置了yarn作为项目的包管理工具，如果项目开发成员使用了npm install则不会开始安装依赖并提示其使用yarn来安装依赖。,在vite中，index.html已经从public文件夹迁移到项目的根目录下了，官方文档对此的解释为：在开发期间 Vite 是一个服务器，而 index.html 是该 Vite 项目的入口文件。,有关此变更的详细解释请移步：index.html 与项目根目录,接下来，我们在项目的根目录创建index.html文件（将public目录下的文件删除）,注意：如果你的项目比较复杂，有多个入口，那么就将index.html文件放到对应入口的根目录下。,最后，我们创建vite.config.ts文件，配置代码如下所示：,注意：我的项目配置比较简单，它只有一个入口，打包后只会部署到生产环境。如果你的项目较为复杂，也不必太过担心，你的应用场景vite也是支持的，按照文档进行相关的配置就好，如下所示：,当你的项目有多个入口时，期望通过不同命令来启动不同项目时，你可以使用yarn的--cwd指令来指定其运行时的工作目录。,例如：你有两个入口，那么就在src目录下创建两个文件夹：**A、B **。A和B中分别有自己的index.html、main.ts以及package.json文件（配置start、build命令，传入不同的参数来启动/构建不同入口的项目）,根目录的package.json中你就可以配置启动/构建命令为：,最后，我们以A入口为例，列举下package.json文件中的配置：,vue3.2的单文件组件引入了setup规范，它可以让代码变得更简洁，可以使用纯 TypeScript 声明 props 和抛出事件，有着更好的运行时性能。这些优点让我有了升级vue版本的动力，之前的3.0版本写起来很臃肿，需要return一大堆东西，甚是麻烦。,打开package.json文件作出下述变动：,最后执行yarn install即可完成整个环境的搭建，本章节重构完成后的完整文件请移步：,本章节就跟大家分享下，我切到新环境后做的一些优化点以及遇到的问题和解决方案。,本章节修改到的文件，完整文件代码如下：,一切准备就绪后，按下了项目启动按钮，很快啊，651ms项目就启动了，不愧是vite速度就是快，嘴角疯狂上扬。,,浏览器加载完项目后，我傻眼了，我的登陆界面呢？顺势打开控制台，发现报错require is not defined。,打开Login.vue文件后，发现我用require导入了一些图片文件，在VueCLI环境下的require会交给webpack处理。在vite中是不存在的，那么我们就需要查看vite是怎么处理静态文件了。,翻了下文档后，在静态资源处理章节发现他有两种处理方法：,我打算将所有组件都重构为setup形式，因此直接使用import方式来导入图片可以保持组件的一致性，可以大大提升可读性。,我们写个简单的demo来尝试下，如下所示：,已经可以正确解析出图片的路径了。,,注意：本文不会过多讲解setup的语法，对此不了解的开发者请移步：单文件组件 - script setup,new URL方式可以用来引入一个动态资源，例如：你有一份json配置文件，里面描述了图片的文件名，这些图片是放在项目中的，他们的访问前缀都一样，此时你就可以通过遍历json文件通过此方式来引入这些图片。,我试图从vue的包中导入shallowRef时，编辑器报错: TS2305: Module 'xxx' has no exported member 'shallowRef'. 。,,经过一番排查后，是因为项目typescript版本是3.x，跟3.2版本的vue不兼容，需要将其升级至4.x版本。,打开package.json文件，作出如下所示的修改，重新执行yarn install命令即可。,setup中的变量警告未被使用,当我在setup中声明了一个函数或者导入了一个文件，在template中已经使用了，但是他却报错ESLint: 'xx' is assigned a value but never used.(@typescript-eslint/no-unused-vars),,在 eslint-plugin-vue 插件的Issues中看到有人遇到了跟我同样的问题，在v9.0.0: regression in unused variables in script setup中我找到了解决方案。,我们需要升级下@vue/eslint-config-typescript和eslint-plugin-vue的版本号，如下所示：,随后在eslint的配置文件中，添加parser属性，重新执行yarn install命令即可。,Vite 使用 esbuild 来转译 TypeScript，并受限于单文件转译的限制，因此需要在ts的配置文件中将isolatedModules属性设置为true。,在路由配置文件中，我们需要从process中获取BASE_URL，此时编辑器报错: TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try npm i --save-dev @types/node and then add 'node' to the types field in your tsconfig.,,由于vite中已经没有process了，需要用import.meta来代替，那么上述的路由配置文件就应该改为：,在表情面板模块，我将每个表情都放入了json文件中。在vite中引入文件需要使用import，改了写法后，发现它报错：Cannot find module 'xx.json'. Consider using '--resolveJsonModule' to import module with '.json' extension.,,我们需要在ts的配置文件中添加resolveJsonModule属性，如下所示：,当我想使用vite所提供的glob属性时，发现编辑器报错: TS2339: Property 'glob' does not exist on type 'ImportMeta'.,解决方案也很简单，我们只需要在ts的配置文件中添加vite/client即可，如下所示：,当我们使用一些第三方库的时候它会在globalProperties挂载一些方法，当在ts+setup环境下使用时，会出现类型无法推导问题，如下所示：,第三方库提供了一个$connect方法,我们通过proxy来访问,他会出现报错: TS2339: Property 'xx' does not exist on type 'ComponentPublicInstance{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase >'.,,我们可以在type目录下新建一个global文件夹，在这里存放一些我们扩展出来的全局方法。,如下所示，我们：,我们在组件中使用暴露出来的proxy即可，如下所示：,我们在给setinterval和setTimeout指定类型时，会用到NodeJS模块，会出现报错：ESLint: 'NodeJS' is not defined.(no-undef)。,这个问题的解决方案是：打开eslint的配置文件在globals对象中添加NodeJS选项，如下所示：,除了将类型声明为NodeJS.Timeout外，我们还可以将其声明为number类型，但是需要携带window前缀（window.setinterval/window.setTimeout）,当我们在组件中使用import导入很多静态资源时，组件看起来会很杂乱。此时我们可以将其按照功能类型进行拆分。我的做法如下：,,我的项目中有一个很复杂的组件，有上千行代码，去年我用CompositionAPI优化了一版，将组件中所有的方法都拆分成了一个个独立的ts文件，做到了逻辑代码与模版代码分离，模版需要什么方法我就通过import导入进来，最后return给模版。,在拆分出来的文件中，是没有办法访问vue提供的一些内置属性的，比如：defineProps、defineEmits、getCurrentInstance。因此我想了一个奇妙的方法：将这些无法访问的属性都存起来。具体的做法请移步我另一篇文章：使用Vue3的CompositionAPI来优化代码量-创建InitData.ts文件,vue3.2的setup语法糖支持import进来的方法都能在模版中直接使用，那我们的组件又可以精简下了，我花了亿点点时间对其进行了适配。,之前我们想获取组件的emit需要从context中拿，props声明并从setup函数的参数中获取，如下所示：,现在我们就不用这么麻烦了，直接通过defineProps、defineEmits获取即可，如下所示：,此组件重构后的完整代码请移步：,至此，项目的重构工作就结束了。本文重构好的项目代码地址：