在傳統的 PC Web 前端開發中,瀏覽器爲開發者提供了體驗良好、功能豐富且強大的開發調試工具,好比常見的 Chrome devtools 等,這些調試工具極大的方便了開發者,它們廣泛提供查看頁面結構、監聽網絡請求、管理本地數據存儲、debugger 代碼、使用 Console 快速顯示數據等功能。javascript
可是在近幾年興起的微信小程序的前端開發中,卻少有相似的體驗和功能對標的開發調試工具出現。固然微信小程序的官方也提供了相似的工具,那就是 vConsole,可是相比 PC 端提供的工具來講確實不管是功能和體驗都有所欠缺,因此咱們開發了 weconsole 來提供更加全面的功能和更好的體驗。html
基於上述背景,咱們想開發一款運行在微信小程序環境上,不管在用戶體驗仍是功能等方面都能媲美 PC 端的前端開發調試工具,固然某些(如 debugger 代碼等)受限於技術在當前時期沒法實現的功能咱們暫且忽略。前端
咱們將這款工具命名爲Weimob Console
,簡寫爲WeConsole
。java
該項目屬於微盟前端開源項目之一,項目主頁:github.com/weimobGroup…git
npm i weconsole -S
複製代碼
可將 npm 包下載到本地,而後將其中的dist/full
文件夾拷貝至項目目錄中;github
WeConsole 分爲核心
和組件
兩部分,使用時須要所有引用後方可以使用,核心
負責重寫系統變量或方法,以達到全局監控的目的;組件
負責將監控的數據顯示出來。typescript
在app.js
文件中引用核心
:npm
// NPM方式引用
import 'weconsole/init';
// 普通方式引用
import 'xxx/weconsole/init';
複製代碼
引入weconsole/init
後,就是默認將 App、Page、Component、Api、Console 所有重寫監控!若是想按需重寫,可使用以下方式進行:json
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 />
複製代碼
<weconsole>
標籤支持傳入如下屬性:
properties: {
// 組件全屏化後,距離窗口頂部距離
fullTop: String,
// 劉海屏機型(如iphone12等)下組件全屏化後,距離窗口頂部距離
adapFullTop: String,
}
複製代碼
若是不想將 weconsole 放置在主包中,建議將組件放在分包內使用,利用小程序的 分包異步化 的特性,減小主包大小
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
wx
對象下的相關 api 執行記錄Filter
框輸入關鍵字已進行記錄篩選All, Mark, Cloud, xhr...
等進行記錄分類顯示,分類列表由配置項apiCategoryList
與apiCategoryGetter
產生🚫
按鈕清空記錄(不會清除留存
的記錄)長按
記錄可彈出操做項(如圖 4):
複製
:將記錄數據執行復制操做,具體形式可以使用配置項copyPolicy
置頂,未指定時,將使用系統默認方式序列化數據(具體看實際效果),將其複製到剪切板Console
功能相似圖 3
圖 4
圖 5
App
getCurrentPages
返回的頁面實例this.selectOwnerComponent()
進行父實例定位,進而肯定層級圖 6
圖 7
Filter
框輸入關鍵字已進行記錄篩選🚫
按鈕清空記錄(不會清除留存
的記錄)長按
操做項含義與Console
功能相似❌
按鈕可將其刪除Filter
框左側的刷新
按鈕可刷新所有數據圖 8
圖 9
customActions
配置項進行界面功能快速定製,也可經過addCustomAction/removeCustomAction
添加/刪除定製項目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
import { showWeConsole, ... } from 'weconsole';
showWeConsole();
複製代碼
替換系統變量或函數以達到監控,底層控制全局僅替換一次
還原被替換的系統變量或函數,還原後界面將不在顯示相關數據
顯示WeConsole
入口圖標
隱藏WeConsole
入口圖標
設置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;
}
複製代碼
添加一個定製化項目;當你添加的項目中須要顯示你本身的組件時:
showMode
值設置爲component
app.json
中註冊名稱爲weconsole-customer
的組件weconsole-customer
的data
屬性data
屬性中的數據自行判斷內部顯示邏輯根據 ID 刪除一個定製化項目
獲取小程序內 weconsole 已經監控到的全部的 App/Page/Component 實例
由於 console 被重寫,當你想使用最原始的 console 方法時,能夠經過該方式,type 就是 console 的方法名
提供一個事件總線功能,全局事件及相關函數定義以下:
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 使用 MIT 協議.
生產環境請謹慎使用。