小程序调试新方案——使用WeConsole监控console/network/api/component/storage
发布于 3 年前 作者 xiuyinglong 2049 次浏览 来自 分享

一、背景与简介

在传统的 PC Web 前端开发中，浏览器为开发者提供了体验良好、功能丰富且强大的开发调试工具，比如常见的 Chrome devtools 等，这些调试工具极大的方便了开发者，它们普遍提供查看页面结构、监听网络请求、管理本地数据存储、debugger 代码、使用 Console 快速显示数据等功能。

但是在近几年兴起的微信小程序的前端开发中，却少有类似的体验和功能对标的开发调试工具出现。当然微信小程序的官方也提供了类似的工具，那就是 vConsole，但是相比 PC 端提供的工具来说确实无论是功能和体验都有所欠缺，所以我们开发了 weconsole 来提供更加全面的功能和更好的体验。

基于上述背景，我们想开发一款运行在微信小程序环境上，无论在用户体验还是功能等方面都能媲美 PC 端的前端开发调试工具，当然某些（如 debugger 代码等）受限于技术在当前时期无法实现的功能我们暂且忽略。

我们将这款工具命名为Weimob Console，简写为WeConsole。

项目主页：https://github.com/weimobGroup/WeConsole

二、安装与使用

1、通过 npm 安装

npm i weconsole -S

2、普通方式安装

可将 npm 包下载到本地，然后将其中的dist/full文件夹拷贝至项目目录中；

3、引用

WeConsole 分为核心和组件两部分，使用时需要全部引用后方可使用，核心负责重写系统变量或方法，以达到全局监控的目的；组件负责将监控的数据显示出来。

在app.js文件中引用核心：

// NPM方式引用
import 'weconsole/init';

// 普通方式引用
import 'xxx/weconsole/init';

引入weconsole/init后，就是默认将 App、Page、Component、Api、Console 全部重写监控！如果想按需重写，可以使用如下方式进行：

import { replace, restore, showWeConsole, hideWeConsole } from 'weconsole'; // scope可选值：App/Page/Component/Console/Api
// 按需替换系统变量或函数以达到监控
replace(scope); // 可还原
restore(scope);

// 通过show/hide方法控制显示入口图标
showWeConsole();

如果没有显式调用过showWeConsole/hideWeConsole方法，组件第一次初始化时，会根据小程序是否开启调试模式来决定入口图标的显示性。

在需要的地方引用组件，需要先将组件注册进app/page/component.json中：

// NPM方式引用
"usingComponents": {
    "weconsole": "weconsole/components/main/index"
}

// 普通方式引用
"usingComponents": {
    "weconsole": "xxx/weconsole/components/main/index"
}

然后在wxml中使用<weconsole>标签进行初始化：

<!-- page/component.wxml -->
<weconsole />

&lt;weconsole&gt;标签支持传入以下属性：

properties: {
    // 组件全屏化后，距离窗口顶部距离
    fullTop: String,
    // 刘海屏机型（如iphone12等）下组件全屏化后，距离窗口顶部距离
    adapFullTop: String,
}

4、建议

如果不想将 weconsole 放置在主包中，建议将组件放在分包内使用，利用小程序的 分包异步化 的特性，减少主包大小

三、功能

1、Console

  • 界面如图 1

  • 实时显示console.log/info/warn/error记录；

  • Filter框输入关键字已进行记录筛选；

  • 使用分类标签All, Mark, Log, Errors, Warnings...等进行记录分类显示，分类列表中All, Mark, Log, Errors, Warnings为固定项，其他可由配置项consoleCategoryGetter产生

  • 点击🚫按钮清空记录（不会清除留存的记录）

  • 长按记录可弹出操作项（如图 2）：

    • 复制：将记录数据执行复制操作，具体形式可使用配置项copyPolicy指定，未指定时，将使用JSON.stringify序列化数据，将其复制到剪切板
    • 取消置顶/置顶显示：将记录取消置顶/置顶显示，最多可置顶三条（置顶无非是想快速找到重要的数据，当重要的数据过多时，就不宜用置顶了，可以使用标记功能，然后在使用筛选栏中的Mark分类进行筛选显示）
    • 取消留存/留存：留存是指将记录保留下来，使其不受清除，即点击🚫按钮不被清除
    • 取消全部留存：取消所有留存的记录
    • 取消标记/标记：标记就是将数据添加一个Mark的分类，可以通过筛选栏快速分类显示
    • 取消全部标记：取消所有标记的记录

图 1

图 2

2、Api

  • 界面如图 3

  • 实时显示wx对象下的相关 api 执行记录

  • Filter框输入关键字已进行记录筛选

  • 使用分类标签All, Mark, Cloud, xhr...等进行记录分类显示，分类列表由配置项apiCategoryList与apiCategoryGetter产生

  • 点击🚫按钮清空记录（不会清除留存的记录）

  • 长按记录可弹出操作项（如图 4）：

    • 复制：将记录数据执行复制操作，具体形式可使用配置项copyPolicy置顶，未指定时，将使用系统默认方式序列化数据（具体看实际效果），将其复制到剪切板
    • 其他操作项含义与Console功能类似
  • 点击条目可展示详情，如图 5

图 3

图 4

图 5

3、Component

  • 界面如图 6

  • 树结构显示组件实例列表

    • 根是App
    • 二级固定为getCurrentPages返回的页面实例
    • 三级及更深通过this.selectOwnerComponent()进行父实例定位，进而确定层级
  • 点击节点名称（带有下划虚线），可显示组件实例详情，以 JSON 树的方式查看组件的所有数据，如图 7

图 6

图 7

4、Storage

  • 界面如图 8
  • 显示 Storage 记录
  • Filter框输入关键字已进行记录筛选
  • 点击🚫按钮清空记录（不会清除留存的记录）
  • 长按操作项含义与Console功能类似
  • 点击条目后，再点击❌按钮可将其删除
  • 点击Filter框左侧的刷新按钮可刷新全部数据
  • 点击条目显示详情，如图 9

图 8

图 9

5、其他

  • 界面如图 10
  • 默认显示 系统信息
  • 可通过customActions配置项进行界面功能快速定制，也可通过addCustomAction/removeCustomAction添加/删除定制项目
  • 几个简单的定制案例如下，效果如图 11：
import { setUIRunConfig } from 'xxx/weconsole/index.js';

setUIRunConfig({
    customActions: [
        {
            id: 'test1',
            title: '显示文本',
            autoCase: 'show',
            cases: [
                {
                    id: 'show',
                    button: '查看',
                    showMode: WcCustomActionShowMode.text,
                    handler(): string {
                        return '测试文本';
                    }
                },
                {
                    id: 'show2',
                    button: '查看2',
                    showMode: WcCustomActionShowMode.text,
                    handler(): string {
                        return '测试文本2';
                    }
                }
            ]
        },
        {
            id: 'test2',
            title: '显示JSON',
            autoCase: 'show',
            cases: [
                {
                    id: 'show',
                    button: '查看',
                    showMode: WcCustomActionShowMode.json,
                    handler() {
                        return wx;
                    }
                }
            ]
        },
        {
            id: 'test3',
            title: '显示表格',
            autoCase: 'show',
            cases: [
                {
                    id: 'show',
                    button: '查看',
                    showMode: WcCustomActionShowMode.grid,
                    handler(): WcCustomActionGrid {
                        return {
                            cols: [
                                {
                                    title: 'Id',
                                    field: 'id',
                                    width: 30
                                },
                                {
                                    title: 'Name',
                                    field: 'name',
                                    width: 70
                                }
                            ],
                            data: [
                                {
                                    id: 1,
                                    name: 'Tom'
                                },
                                {
                                    id: 2,
                                    name: 'Alice'
                                }
                            ]
                        };
                    }
                }
            ]
        }
    ]
});

图 10

图 10

四、API

通过以下方式使用 API

import { showWeConsole, ... } from 'weconsole';
showWeConsole();

replace(scope:‘App’|‘Page’|‘Component’|‘Api’|‘Console’)

替换系统变量或函数以达到监控，底层控制全局仅替换一次

restore(scope:‘App’|‘Page’|‘Component’|‘Api’|‘Console’)

还原被替换的系统变量或函数，还原后界面将不在显示相关数据

showWeConsole()

显示WeConsole入口图标

hideWeConsole()

隐藏WeConsole入口图标

setUIConfig(config: Partial<MpUIConfig>)

设置WeConsole组件内的相关配置，可接受的配置项及含义如下：

interface MpUIConfig {
    /**监控小程序API数据后，使用该选项进行该数据的分类值计算，计算后的结果显示在界面上 */
    apiCategoryGetter?: MpProductCategoryMap | MpProductCategoryGetter;
    /**监控Console数据后，使用该选项进行该数据的分类值计算，计算后的结果显示在界面上 */
    consoleCategoryGetter?: MpProductCategoryMap | MpProductCategoryGetter;
    /**API选项卡下显示的数据分类列表，all、mark、other 分类固定存在 */
    apiCategoryList?: Array<string | MpNameValue<string>>;
    /**复制策略，传入复制数据，可通过数据的type字段判断数据哪种类型，比如api/console */
    copyPolicy?: MpProductCopyPolicy;
    /**定制化列表 */
    customActions?: WcCustomAction[];
}

/**取数据的category字段值对应的prop */
interface MpProductCategoryMap {
    [prop: string]: string | MpProductCategoryGetter;
}
interface MpProductCategoryGetter {
    (product: Partial<MpProduct>): string | string[];
}
interface MpProductCopyPolicy {
    (product: Partial<MpProduct>);
}
/**定制化 */
interface WcCustomAction {
    /**标识，需要保持唯一 */
    id: string;
    /**标题 */
    title: string;
    /**默认执行哪个case？ */
    autoCase?: string;
    /**该定制化有哪些情况 */
    cases: WcCustomActionCase[];
}

const enum WcCustomActionShowMode {
    /**显示JSON树 */
    json = 'json',
    /**显示数据表格 */
    grid = 'grid',
    /** 固定显示<weconsole-customer>组件，该组件需要在app.json中注册，同时需要支持传入data属性，属性值就是case handler执行后的结果 */
    component = 'component',
    /**显示一段文本 */
    text = 'text',
    /**什么都不做 */
    none = 'none'
}

interface WcCustomActionCase {
    id: string;
    /**按钮文案 */
    button?: string;
    /**执行逻辑 */
    handler: Function;
    /**显示方式 */
    showMode?: WcCustomActionShowMode;
}

interface WcCustomActionGrid {
    cols: DataGridCol[];
    data: any;
}

addCustomAction(action: WcCustomAction)

添加一个定制化项目；当你添加的项目中需要显示你自己的组件时：

  • 请将 case 的showMode值设置为component
  • 在app.json中注册名称为weconsole-customer的组件
  • 定制化项目的 case 被执行时，会将执行结果传递给weconsole-customer的data属性
  • 开发者根据data属性中的数据自行判断内部显示逻辑

removeCustomAction(actionId: string)

根据 ID 删除一个定制化项目

getWcControlMpViewInstances():any[]

获取小程序内 weconsole 已经监控到的所有的 App/Page/Component 实例

log(type = “log”, …args)

因为 console 被重写，当你想使用最原始的 console 方法时，可以通过该方式，type 就是 console 的方法名

on/once/off/emit

提供一个事件总线功能，全局事件及相关函数定义如下：

const enum WeConsoleEvents {
    /**UIConfig对象发生变化时 */
    WcUIConfigChange = 'WcUIConfigChange',
    /**入口图标显示性发生变化时 */
    WcVisableChange = 'WcVisableChange',
    /**CanvasContext准备好时，CanvasContext用于JSON树组件的界面文字宽度计算 */
    WcCanvasContextReady = 'WcCanvasContextReady',
    /**CanvasContext销毁时 */
    WcCanvasContextDestory = 'WcCanvasContextDestory',
    /**主组件的宽高发生变化时 */
    WcMainComponentSizeChange = 'WcMainComponentSizeChange'
}

interface IEventEmitter<T = any> {
    on(type: string, handler: EventHandler<T>);
    once(type: string, handler: EventHandler<T>);
    off(type: string, handler?: EventHandler<T>);
    emit(type: string, data?: T);
}

五、后续规划

  • 优化包大小
  • 单元测试
  • 体验优化
  • 定制化升级
  • 基于网络通信的界面化 weconsole
  • 标准化
  • 支持 H5
  • 支持其他小程序平台（支付宝/百度/字节跳动）

六、License

WeConsole 使用 MIT 协议.

七、声明

生产环境请谨慎使用。

8 回复

感觉好高端的样子，请告诉我目前的小程序官方调试工具在调试的时候哪里不满足咱们的要求，造轮子很好，不过价值不大嘛

awesome！

YYDS

666

这个🐂🍺了

helpful!

蛮实用的

大佬666

回到顶部