weconsole

v1.6.0

Published

8 months ago

功能全面、界面与体验对标 Chrome devtools 的可定制化的跨平台小程序开发调试面板

Downloads

0High
0Medium
0Low

weimob-group

weconsole 小程序调试工具 mpdebugger console debug debug devtools 小程序 miniprogram

WeConsole——功能全面、界面与体验对标 Chrome devtools 的可定制化的跨平台小程序开发调试面板

组件效果

主要功能特性

✅ 展示 Console 日志
✅ 展示小程序组件节点树
✅ 展示网络请求
✅ 展示小程序 API 调用记录
✅ 展示数据缓存
✅ 支持自定义扩展
✅ 跨平台
- ✅ 微信小程序
- ✅ 支付宝小程序
- ✅ 百度小程序
- 🚫 QQ 小程序
- 🚫 字节跳动小程序
- 🚫 快手小程序
- ✅ 小红书小程序

一、背景与简介

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

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

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

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

二、安装与使用

1、通过 npm 安装

npm i weconsole -S

2、普通方式安装

此方式会将WeConsole依赖的所有 npm 代码包都自动引入，无需再通过开发者工具进行 npm 编译。

可将 npm 包下载到本地，然后：

微信小程序：请将dist/full目录中的文件拷贝至项目目录中；
支付宝小程序：请将dist/alipay/full目录中的文件拷贝至项目目录中；
小红书小程序：请将dist/xhs/full目录中的文件拷贝至项目目录中；
百度小程序：请将dist/swan/full目录中的文件拷贝至项目目录中；

3、引用

WeConsole 分为核心和组件两部分，使用时需要全部引用后方可使用：

核心负责重写系统变量或方法，以达到全局监控的目的；
组件负责将监控的数据显示出来。

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

微信小程序引用方式：

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

// 普通方式引用
import '{复制后的【dist/full】的路径}/main/init';

支付宝小程序引用方式：

// NPM方式引用
import 'weconsole/dist/alipay/npm/main/init';

// 普通方式引用
import '{复制后的【dist/alipay/full】的路径}/main/init';

小红书小程序引用方式：

// NPM方式引用
import 'weconsole/dist/xhs/npm/main/init';

// 普通方式引用
import '{复制后的【dist/xhs/full】的路径}/main/init';

百度小程序引用方式：

// NPM方式引用
import 'weconsole/dist/swan/npm/main/init';

// 普通方式引用
import '{复制后的【dist/swan/full】的路径}/main/init';

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

import { replace, restore, showWeConsole, hideWeConsole } from '{NPM或复制后的【dist/full】的路径}/main/index';

// scope可选值：App/Page/Component/Console/Api
// 按需替换系统变量或函数以达到监控
replace(scope);

// 可还原
restore(scope);

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

如果没有显式调用过showWeConsole/hideWeConsole方法，组件第一次初始化时，会根据根据小程序当前状态综合判断入口图标的显示性，这些规则包括：

当调试模式开启时，显示
当处于开发者工具环境时，显示
当处于预览版时，显示
当处于体验版时，显示
当处于正式版时，不显示

3.2 在需要的地方引用`组件`：

微信小程序引用方式：

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

// 普通方式引用
"usingComponents": {
    "weconsole": "{复制后的【dist/full】的路径}/subpackage/components/main/index"
}

支付宝小程序引用方式：

// NPM方式引用
"usingComponents": {
    "weconsole": "weconsole/dist/alipay/npm/subpackage/components/main/index"
}

// 普通方式引用
"usingComponents": {
    "weconsole": "{复制后的【dist/alipay/full】的路径}/subpackage/components/main/index"
}

小红书小程序引用方式：

// NPM方式引用
"usingComponents": {
    "weconsole": "weconsole/dist/xhs/npm/subpackage/components/main/index"
}

// 普通方式引用
"usingComponents": {
    "weconsole": "{复制后的【dist/xhs/full】的路径}/subpackage/components/main/index"
}

百度小程序引用方式：

// NPM方式引用
"usingComponents": {
    "weconsole": "weconsole/dist/swan/npm/subpackage/components/main/index"
}

// 普通方式引用
"usingComponents": {
    "weconsole": "{复制后的【dist/swan/full】的路径}/subpackage/components/main/index"
}

然后在小程序视图层的xml文件中使用<weconsole>标签进行初始化：

可以使用 weconsole 提供的命令行工具一键批量插入标签，参考 【5、一键注入】

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

<weconsole>标签支持传入以下属性：

properties: {
    // 组件全屏化后，距离窗口顶部距离
    fullTop: String,
    // 刘海屏机型（如iphone12等）下组件全屏化后，距离窗口顶部距离
    adapFullTop: String,
    // v1.1.0 支持，代表weconsole组件的z-index值
    zIndex: Number,
    // v1.1.0 支持，自定义weconsole图标，传递图片URL
    icon: String,
    // v1.1.0 支持，支持自定义图标样式，传true时同时设置slot="hand"的插槽内容，可定制
    customHand: Boolean
}

4、建议

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

微信小程序：
- 主包文件：dist/{full|npm}/main/*
- 分包文件：dist/{full|npm}/subpackage/*
支付宝小程序：
- 主包文件：dist/alipay/{full|npm}/main/*
- 分包文件：dist/alipay/{full|npm}/subpackage/*
小红书小程序：
- 主包文件：dist/xhs/{full|npm}/main/*
- 分包文件：dist/xhs/{full|npm}/subpackage/*
百度小程序：
- 主包文件：dist/swan/{full|npm}/main/*
- 分包文件：dist/swan/{full|npm}/subpackage/*

5、一键注入

如果你不想一个个页面的插入<weconsole>标签，或者就想小程序中的所有页面全部插入，那你可以使用 weconsole 提供的命令行工具来完成：

# 安装weconsole后，可使用`weconsole inject`命令进行一键注入

npx weconsole inject ./my-mp-xxx copy replace

weconsole命令可接受的参数及可选值含义如下：

interface InjectConfig {
    /** 要注入的小程序项目目录 */
    projectDir: string;
    /** 如果项目已经被注入过了，是否本次注入要进行替换？ */
    replace?: boolean;
    /** 本次注入强行显示weconsole入口图标 */
    forceShow?: boolean;
    /** 注入方式：
     * npm: 以引用npm包的方式注入，但注入后需要开发者工具主动编译才可使用，好处是如果有重复的依赖可以减少代码体积；
     * full: 以全依赖引用的方式注入，无需开发者工具主动编译就可使用，缺点是可能存在依赖包被重复打包代码的问题；
     */
    mode?: 'npm' | 'full';
    /** 注入的小程序项目属于哪个平台？不传时，自动根据目录中的文件特征判断 */
    platform?: 'wx' | 'alipay' | 'xhs' | 'swan';
    /** 注入weconsole标签时传入的fullTop属性值 */
    fullTop?: string;
    /** 注入weconsole标签时传入的adapFullTop属性值 */
    adapFullTop?: string;
    /** 注入weconsole标签时传入的zIndex属性值 */
    zIndex?: number;
    /** 是否在注入时将weconsole的所有JS及组件文件复制到项目根目录？ */
    copy?: boolean;
}

三、功能

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/main/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

四、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;
    /** Other内置信息中获取当前页面实例时执行的方法 */
    currentPageGetter?: () => MpView;
    /** API选项卡下显示的数据分类列表，all、mark、other 分类固定存在 */
    apiCategoryList?: Array<string | MpNameValue<string>>;
    /** 复制策略，传入复制数据，可通过数据的type字段判断数据哪种类型，比如api/console */
    copyPolicy?: MpProductCopyPolicy;
    /** 定制化列表 */
    customActions?: WcCustomAction[];
    /** 默认的api分类值 */
    apiDefaultCategoryValue?: string;
    /** 默认的console分类值 */
    consoleDefaultCategoryValue?: string;
    /** 不监控这些API，也就是说这些API调用后不会在【API】选项卡中显示 */
    ignoreHookApiNames?: string[];
    /** 只监控这些API，也就是除了这些API以外的其他调用都不会在【API】选项卡中显示 */
    onlyHookApiNames?: string[];
    /** 全局对象，如果你的小程序存在沙盒环境，请务必传递一个可供全局存储数据的单例对象 */
    globalObject?: any;
}

// 配置项的详细types请参考源码目录：src/types

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 协议.

八、声明

生产环境请谨慎使用。

九、更新记录

v1.6.0
- 功能升级
  - 支持百度小程序
  - 优化Component面板
    - 组件树不在使用 group 方式进行分组显示
    - 点击样式优化
    - 整体组件数子节点查询优化
  - 一键注入
    - 支持注入百度小程序
- 修复 BUG
  - 修复支付宝组件注册时没写 created 等生命周期函数时，在组件树中看不到的问题
  - 修复支付宝组件树子节点判断问题
  - 修复 wcconsole_xy storage 拿到空值时 icon 看不到的问题
  - 修复 createSelectorQuery 调用导致 Api 面板虚拟列表方法调用死循环的问题
- 其他
  - 添加百度小程序示例代码
v1.5.0
- 功能升级
  - 支持小红书小程序
  - 优化Console面板
    - 函数类型数据样式优化
    - 非 object 类型数据直接展示，不使用json-viewer组件
  - 一键注入
    - 支持注入小红书小程序
- 其他
  - 添加小红书小程序示例代码
v1.4.1
- 功能升级
  - 支持跨平台：目前已支持微信、支付宝，后续还将支持百度、小红书、QQ 等小程序平台
  - 优化虚拟列表
  - 优化Console面板
    - 优化样式
  - 优化Api面板
    - 切换分类时重置详细页
    - 优化样式
  - 优化Component面板
    - 显示<App>环境版本和版本号
    - 调整字号
  - 提供cli工具方便向小程序项目一键注入 weconsole 代码
    - 支持注入微信小程序
    - 支持注入支付宝小程序
- 修复 BUG
  - 修复Api面板切换详情时 json 数据未变的问题
  - 修复Console面板复制对象存在循环引用情况下无法复制并报错的问题
- 重构代码
  - 自定义CustomAction组件对接table组件
  - 抽象跨平台代码到独立 npm 包
- 其他
  - 添加支付宝小程序示例代码
v1.3.0
- 功能升级
  - 更换虚拟列表底层实现
  - 优化部分api列表项标题文案
  - 优化自定义action展示
- 修复 BUG
  - 修复虚拟列表滚动白屏问题
  - 修复storage复制失败问题
  - 修复复制console等数据存在循环引用时报错的问题
- 重构代码
  - 删除data-grid组件改用底层使用虚拟列表的table组件
  - 删除无用 mixin
- 编译优化
  - 优化主包分包代码分块
- 其他
  - 添加小程序示例代码，目录：examples
v1.2.0
- 重构代码
  - 使用class方式定义组件
- 编译优化
  - 初步划分主包和分包目录
  - JS 产物文件合并
v1.1.3
- 升级依赖包
- 优化性能
  - 组件/页面实例销毁后也从 weconsole 缓存中删除
  - 点击console/api的清除按钮后，也将缓存中的数据删除
  - 优化数据存储方式
  - 组件setData使用延迟更新方式
- 修复 BUG
  - data-grid组件列宽度计算错误问题
  - 自定义action不显示按钮文案的问题
- 添加功能
  - 自定义 data-grid action支持长按复制单元格内容
  - data-grid组件支持多行文本