mdebug 基于React开发的web调试工具

2021年09月02日 11:31 · 阅读 4548

TNTWeb - 全称腾讯新闻中台前端团队，组内小伙伴在Web前端、NodeJS开发、UI设计、移动APP等大前端领域都有所实践和积累。

目前团队主要支持腾讯新闻各业务的前端开发，业务开发之余也积累沉淀了一些前端基础设施，赋能业务提效和产品创新。

团队倡导开源共建，拥有各种技术大牛，团队Github地址：github.com/tnfe

本文作者云峰项目地址: github.com/tnfe/mdebug

1615550396_20_w2880_h2154 (2).png

mdebug是腾讯新闻TNTWEB团队推出的基于React开发的web调试工具, 沉淀自腾讯新闻微信手q双插件多年的移动web开发实践中。相比vconsole, eruda等调试工具, 使用现代框架进行编写。整合network监控能力,提供了更丰富的调试能力和api, 拥有更强大的网络捕获能力,接入和使用简单。本文将从背景, 架构,功能, 实现原理, 未来扩展点等角度全面介绍这款工具。

一.背景

调试一直是移动web开发的疼点，业界也在调试工具上不断寻找更好的解决方案。从真机联调，js模拟，Nodejs代理, 代理软件等方面提出移动web调试解决方案。mdebug是一款通过js模拟来实现移动web调试的轻量化工具，无需依赖任何插件，使用简单，功能强大。

git地址: github.com/tnfe/mdebug

快速体验: tnfe.github.io/mdebug

二、功能介绍

mdebug提供了系统，日志，网络，元素，存储，代理，性能七大实用功能。下面我们逐一介绍这些功能:

1.系统

系统功能提供了当前访问地址，UA,视窗大小，用户标示等信息，并支持点击复制，可以让你快速了解当前系统情况。

2.元素

呈现了当前页面的dom元素，可以快速了解当前页面的dom元素情况，支持展开和折叠，体验接近chrome devtools elements。

3. 日志

支持多种日志展现，支持日志分类，全局过滤，日志导出，执行js命令,支持长日志折叠展开，提升大日志量展示性能等功能。

4.网络

支持多种网络请求查看，包括静态资源，接口，websocket请求等，并支持模糊查找。

5.存储和Cookie

支持多种存储展现,支持增删存储，支持模糊查找，支持长日志折叠展开，提升大日志量展示性能等功能。

6. 前端代理proxy

简单版的本地host，支持通过面板快速修改域名代理，将页面请求转发到另外一个域名

7.性能performance

参考业界性能监控常用指标，输出页面当前性能情况

三、快速使用

1. ES6

 import mdebug from 'mdebug';
 mdebug.init();
复制代码

2. CDN

(function() {
    var scp = document.createElement('script');
    // 加载最新的mdebug版本
    scp.src = 'https://unpkg.com/mdebug@latest/dist/index.js';
    scp.async = true;
    scp.charset = 'utf-8';
    // 加载成功并初始化
    scp.onload = function() {
        mdebug.init();
    };
    // 加载状态切换回调
    scp.onreadystate = function() {};
    // 加载失败回调 
    scp.onerror = function() {};
    document.getElementsByTagName('head')[0].appendChild(scp);
})();
复制代码

四. API介绍

1. init

mdebug.init({
    containerId: '' // mdebug挂载容器id, 如果传空, 内部会自动生成一个不重复的id,
    plugins: [], // 传入mdebug插件
    hideToolbar: [], // 传入需要隐藏的tab id
});
复制代码

2. addPlugin

mdebug.addPlugin({
    id: '', // tab id
    name: '', // tab对应的中文title,
    enName: '', // tab对应的英文title
    component: () => {}, // tab对应的react组件
});
复制代码

3. removePlugin

// 支持移除的panel对应的id
/*
System => system;
Elements => elements;
Console => console
Application => application
NetWork => network
Performance => performance
Settings => settings
*/
mdebug.removePlugin([]);
复制代码

4. exportLog

/*
@returned {
  type: '' // 日志类型
  source: [], // 原始日志
}
@params type
// type等于log, 返回所有的console日志
// type等于net, 返回所有的net日志
*/
mdebug.exportLog(type);

复制代码

5. on

mdebug.on(eventName, callback);
复制代码

6. emit

mdebug.emit(eventName, data);
复制代码

五、事件列表

事件名称	数据	触发时机
ready	object	mdebug加载完毕
addTab	object	增加面板
removeTab	array	移除面板
changeTab	object	面板切换

六.业界主流调试工具介绍

七、业界方案对比

和业界js模拟调试工具相比，mdebug在扩展性，用户体验上做了更多思考和探索。

八、整体架构

mdebug基于react框架编写，充分利用组件化思想，简化实现逻辑。可以和现有react组件充分结合提升扩展性。并通过事件机制来降低mdebug和外部的业务逻辑代码通信负担。

九、实现原理

1. 拦截console 相关源码

通过hook console api来将console输出的日志，传输到mdebug中进行格式化展现。并支持对日志进行检索，导出等功能

2. Hook Fetch Ajax 相关源码

mdebug在底层拦截网络请求，将网络请求相关信息，存储在内存队列中，并派发相关事件给mdebug进行展现。同时支持对网络请求日志进行全局检索，导出等

3. Performance API

通过performance api我们能够获取到浏览器页面加载性能，静态资源加载等情况。

(1) 页面性能

mdebug使用window.performance.timing来获取页面性能加载数据，并参考业界常用性能指标计算方式，为业务提供简单直观的性能数据。

(2) 静态资源加载

通过performance.getEntries来获取页面静态资源加载情况，并通过事件机制通知到mdebug network面板。

4. 使用redux来进行状态管理

5. 调用原生存储api来获取，设置，删除存储

6. 除了redux状态管理外，通过eventbus事件机制来进行日志，网络数据的派发通知，以及mdebug和外部业务逻辑代码的通信

十、未来拓展点

mdebug作为移动web调试工具的一个新的探索，未来可以结合业务实践沉淀更多的功能。通过插件的机制来供业务自由组合使用。另外我们也在探索多前端框架支持，插件编写上可以支持vue，react，原生js等。另外作为一个react入门学习项目，也是一个很好的实践项目。