当前位置:首页 > 技术分析 > 正文内容

如何优雅的调试 Vue 项目?(vue3调试工具)

ruisui884个月前 (02-03)技术分析32

调试准备

相关环境:

  • 编辑器:VS Code
  • Node 版本:16.20.x
  • 包管理器:pnpm

调试 Vue 项目

初始化一个 Vue 项目有两种方式,分别基于 Vite 和 Webpack 作为构建工具:

  • 使用 create-vue 脚手架工具,创建基于 Vite 的 Vue 项目;
pnpm create vue

使用 Vue CLI 的 @vue/cli 脚手架工具,创建基于 Webpack 的 Vue 项目;

# 先全局安装 @vue/cli 包
npm i -g @vue/cli
# 再使用 vue 命令创建项目
vue create vue-project

分别来看一下两种方式创建的项目如何调试;

调试基于 Vite 的 Vue 项目

  1. 使用 pnpm create vue 命令创建一个基于 Vite 的 Vue 3 项目,启动服务 pnpm dev


创建调试配置文件 launch.json,添加一个调试配置,


url 改为启动服务后对应的地址和端口,启动调试,会打开一个新的 chrome 窗口实例访问我们指定的 url;

PS:启动调试时,默认打开的浏览器是一个全新的窗口,啥都没有,可以添加 userDataDir 配置来指定用户数据目录,例如userDataDir: false 这样打开的就是使用浏览器默认登录的用户。注意浏览器的用户数据目录有个特点,只能被一个 Chrome 实例访问。

  • 在 App.vue 文件打个断点试试,刷新页面,没问题能断住。

  • PS:
    • 如果发现先打断点再启动调试,先断在了编译后的文件,可以试试先启动调试,再打断点。

    如果启动调试后,第一次能断住,后面刷新网页没断住,有可能是缓存的原因,可以禁用掉缓存,勾选 Network 面板 Disable cache。


    调试基于 Webpack 的 Vue 项目

    1. 使用 vue create vue3-webpack-debug 创建一个基于 Webpack 的 Vue 3 项目,启动服务 pnpm serve


    创建调试配置文件 launch.json,添加一个调试配置;url 改为启动服务时对应的地址和端口,启动调试;


    在 App.vue 文件打个断点,没断住,需要将 vue cli 的 devtool 默认配置
    eval-cheap-module-source-map
    改为 cheap-module-source-map

    // vue.config.js
    const { defineConfig } = require('@vue/cli-service')
    module.exports = defineConfig({
      // 修改 devtool 配置为 cheap-module-source-map
      chainWebpack: (config) => {
        config.devtool("cheap-module-source-map");
      },
      // 省略其他配置
    })

    修改 devtool 原因是,vue cli 默认配置为
    eval-cheap-module-source-map,其中的 eval 会导致映射的模块文件带有 hash 参数,无法在本地找到对应文件;如下图,我们在代码中用 debugger 打断点,发现打开的是一个 App.vue?91a0 文件,这个路径无法映射到本地文件,只能只读,应该把 hash 参数处理掉:


    1. devtool 配置详情参考文档 webpack - devtool

    调试线上代码报错

    这里我们通过关联 sourcemap 文件的方式,将打包后的代码映射回源码进行调试。关联 sourcemap 是通过在文件末尾添加一行注释,例如//# sourceMappingURL=xxx.js.map。但是,在生产部署的代码中,不会将 sourcemap 文件关联在一起,否则源码就会被暴露。

    首先,在打包时需要生成单独的 sourcemap 文件,打包工具都有相应的配置:

    • 对于 webpack,可以通过将 devtool 配置为hidden-source-map来实现。该配置的意思是生成 sourcemap 文件,但不会在代码文件末尾中添加关联注释。
    • 对于 vite,可以通过将 build.sourcemap 配置为 hidden 来实现,其效果与 webpack 配置相同。

    然后需要一个 url 来访问 sourcemap 文件。这里我们在本地 sourcemap 文件所在目录起一个服务 npx http-server . ,这样就有一个本地的 url 能访问到 sourcemap 文件了,接下来就是进行关联操作,有以下几种方式:

    方式 1:开发者工具 - Source 面板中手动关联 sourcemap

    在 Source 面板报错文件中右键添加 sourcemap 将报错文件的 sourmap url 输入,就能映射到源码文件了。但是这种方式页面刷新就得重新添加 sourcemap url。

    • 截图:未关联 sourcemap 的源文件


    截图:添加 sourcemap url 映射到源文件


    方式 2:开发者工具 - Source 面板 - Overrides 修改文件内容关联 sourcemap

    在 Network 面板中,右键报错文件请求选择 Override content,会在 Source 面板中保存一份为本地文件,页面刷新重新请求将会使用该本地文件,因此可以在该报错文件末尾添加 sourcemap url,这样就能映射到源码文件了。

    • 截图:Override content 修改内容


    方式 3:通过 Charles 等抓包工具断点修改响应内容关联 sourcemap

    在 Charles 中勾选报错文件断点,断住时修改 Response,在文件内容末尾处添加 sourcemap url。对比方式 1 的好处就是修改的内容会缓存,跟方式 2 差不多。

    总结

    有效的代码调试无疑是提高开发效率的关键一步,无论是在开发新功能的过程中,还是在定位修复现有问题。通过本文了解了如何调试 Vue 项目,包括基于 Vite 和 Webpack 的 Vue 项目的调试方法,调试其他框架项目应该也差不多。同时也介绍了如何调试线上代码报错,通过关联 sourcemap 文件的方式,将打包后的代码映射回源码进行调试。大家如果有更优的调试方案,欢迎交流!另外推荐神光的前端调试通关秘籍,学到很多。

    扫描二维码推送至手机访问。

    版权声明:本文由ruisui88发布,如需转载请注明出处。

    本文链接:http://www.ruisui88.com/post/900.html

    分享给朋友:

    “如何优雅的调试 Vue 项目?(vue3调试工具)” 的相关文章

    gitlab常用命令大全

    GitLab常用命令大全GitLab是一个基于Git的Web平台,它不仅提供代码托管,还集成了持续集成/持续交付(CI/CD)、代码审查、问题追踪等功能。在日常使用GitLab的过程中,我们常常需要使用一系列命令来管理代码仓库、处理分支和标签等。以下是GitLab常用的Git命令大全,并附上详细解释...

    Java教程:gitlab-使用入门

    1 导读本教程主要讲解了GitLab在项目的环境搭建和基本的使用,可以帮助大家在企业中能够自主搭建GitLab服务,并且可以GitLab中的组、权限、项目自主操作GitLab简介GitLab环境搭建GitLab基本使用(组、权限、用户、项目)2 GitLab简介GitLab是整个DevOps生命周期...

    Gitlab之间进行同步备份

    目前,我们公司有两个研发团队,分别在北京和武汉,考虑到访问速度的问题,原有武汉的研发环境在近端部署。也就是北京和武汉分别有两套独立的研发管理环境,虽然这解决了近端访问速度的问题,但是管理上较为分散,比如研发环境备份和恢复就是最重要的问题之一。最近,处于对安全性和合规性的考虑,希望将北京和武汉的源代码...

    编码 10000 个小时后,开发者悟了:“不要急于发布!”

    【CSDN 编者按】在软件开发的道路上,时间是最好的老师。根据“一万小时定律”,要成为某个领域的专家,通常需要大约一万小时的刻意练习。本文作者身为一名程序员,也经历了一万小时的编程,最终悟出了一个道理:慢即是快,重视架构设计和代码质量,确保每一行代码都经得起时间的考验。作者 | Sotiris Ko...

    一起学Vue:路由(vue-router)

    前言学习vue-router就要先了解路由是什么?前端路由的实现原理?vue-router如何使用?等等这些问题,就是本篇要探讨的主要问题。vue-router是什么路由是什么?大概有两种说法:从路由的用途上来解释路由就是指随着浏览器地址栏的变化,展示给用户的页面也不相同。从路由的实现原理上来解释路...

    从 Vue2.0 到 React17——React 开发入门

    作者:佚名来源:前端大全前言找工作时发现有一些公司是以React作为技术栈的,而且薪资待遇都不错,为了增加生存的筹码,所以还是得去学一下React,增加一项求生技能。因为我用Vue2.0开发项目已经四年了,故用Vue2.0开发项目的思路来学习React。前端项目是由一个个页面组成的,对于Vue来说,...