dokit

Description:

dokit

DoKit Flutter版 #
内测版本，目前提供了日志、method channel信息、路由信息、网络抓包、帧率、设备与内存信息查看、控件信息查看、颜色拾取、启动耗时、查看源码、查看widget的build链以及对齐标尺的功能.
支持flutter版本 #
1.17.5<=version<=1.22.4，其余版本未做过兼容性测试
Pub地址 #
DoKit For Flutter
接入 #
在pubspect.yaml文件的dependencies节点添加pub依赖
dependencies:
dokit: ^0.6.1
copied to clipboard
在main函数入口初始化。 DoKit使用runZone的方式进行日志捕获，方法通道的捕获，如果你的app需要使用同样的方式会有冲突。
void main() => {

DoKit.runApp(app:DoKitApp(MyApp()),
// 是否在release包内使用，默认release包会禁用
useInRelease: true,
releaseAction: () => {
// release模式下执行该函数，一些用到runZone之类实现的可以放到这里，该值为空则会直接调用系统的runApp(MyApp())，
})
};
}

copied to clipboard
注：谷歌提供的DevTool会折叠非主工程内实例化的widget（根据source file是否属于当前工程），DoKit需要实例化一个wrapper widget用以展示各种overlay，
如果在package内去声明这个wrapper，会导致左边树全部被折叠。故这里要求在main文件内使用DoKitApp(MyApp())的方式来初始化入口
另外提供了一个异步创建入口Widget的方式，需要异步构建widget的情况。(有些库会在异步构建Widget的时候调用WidgetFlutterBinding.ensureInitialized()，影响DoKit的method channel监控
和日志监控，需要延迟到runZone内执行)
void main() => {
DoKit.runApp(
appCreator: () async =>
DoKitApp(await crateApp())));
};

Widget crateApp() async{
// 一些初始化操作
await ...
return MyApp();
}
}
copied to clipboard
参数说明 #



参数
返回类型
说明
是否必须




app
DoKitApp
返回被DoKitApp类包装的根布局
app和appCreator至少需要设置一个同时设置时app参数生效


appCreator
DoKitAppCreator
异步返回根布局
同上


useInRelease
bool
是否在release模式下显示DoKit
x


logCallback
LogCallback
调用print方法打印日志时被回调
x


exceptionCallback
ExceptionCallback
异常回调
x


methodChannelBlackList
List
过滤方法通道的黑名单
x


releaseAction
Function
release模式下执行该函数，该值为空则会直接调用系统的runApp
x



功能简介 #
全部组件 #

当前版本DoKit支持的所有功能全览。常驻工具为显示在底部tab栏的组件，可通过拖动将组件放置或移出常驻工具。
第三方业务入口 #

添加第三方业务入口，目前只支持跳转页面，对要跳转的页面只要求是Widget即可，添加第三方业务入口的代码推荐写在main函数中，下面是添加第三方入口的示例：
// 注册新的第三方业务入口，不可重复注册，否则报错
BizKitManager.instance.addKitWith(
name: 'test1',
group: 'biz',
kitBuilder: () => Container(color: Colors.orange));
BizKitManager.instance.addKitWith(name: 'noAction', group: 'biz');
BizKitManager.instance.addKitWith(
key: 'biz1_goBizPage1',
name: 'goBizPage1',
group: 'biz1',
kitBuilder: () => TestBizPage1(),
);

// 添加业务分组的tip信息（需先注册对应的group，否则报错）
BizKitManager.instance.addKitGroupTip('biz1', 'dokit test biz1');

// 通过注册的key来手动通过代码打开一个业务入口对应的页面
Future.delayed(Duration(seconds: 1), () {
BizKitManager.instance.open('biz1_goBizPage1');
// 安全打开一个kitPage，和open的区别在于不会报错
// BizKitManager.instance.safeOpen();
});

// 隐藏kitPage，不会删除上一次的打开记录
BizKitManager.instance.hide();
// 关闭kitPage，会删除上一次的打开记录
BizKitManager.instance.close();

// 如果传入的kitBuilder中的widget层级中没有包含Navigator（MaterialApp、WidgetApp等组件默认包含Navigator），则推荐使用，否则无法关闭
Navigator.of(context).pop();
copied to clipboard
日志查看 #

查看使用print方式打印出来的日志，捕获的异常会以红色显示。超过7行的日志会自动折叠，点击可展开。长按复制日志到剪贴板。
网络请求 #

可以捕获通过flutter httpclient发出的网络请求，主流的http、dio库底层也是通过httpclient实现的，也能捕获。
Method Channel信息 #

可以展示从dart端到native和从native端到dart端的方法调用、参数、返回结果。
路由信息 #

展示当前页面的路由信息，当存在多层Navigator组件嵌套时，会展示多层的路由信息。
注：当前查找栈顶widget是通过遍历整棵widget tree的方式，如果添加了overlay，栈顶widget会始终指向overlay，导致该功能读取数据异常。
帧率 #

展示最近240帧的耗时情况，每次进入该页面刷新。debug模式下帧率会普遍偏高，profile和release模式下会比较正常。
内存 #

当前已使用的内存和最大内存；底部搜索栏可以显示指定的类的对象数量和占用内存。
注：该功能通过VMService获取数据，release模式下无法使用
基本信息 #

展示当前dart虚拟机进程、cpu、版本信息；当前app包名和dart工程构建版本信息；
注：该功能通过VMService获取数据，release模式下无法使用。flutter版本号需要flutter attach后才可获取
控件检查 #

查看当前页面上的控件信息，包含位置、大小、源码信息、对齐标尺和查看build链等。
注：源码信息只有在debug模式下才可获取到。同路由功能，在存在Overlay的情况下功能会异常
颜色拾取 #

查看当前页面任何位置对应的像素点的RGBA颜色值，方便UI的调试和获取像素点的颜色
Widget层级 #


查看当前选中widget的树层级，以及它renderObject的详细build链等信息
页面源码查看 #

查看当前所在页面的源代码，支持语法高亮显示
注：源码信息只有在debug模式下才可获取到。同路由功能，在存在Overlay的情况下功能会异常
页面启动耗时 #


获取页面的启动耗时,
框架已做无侵入的注入NavigatorObserver。但是在较复杂的App构建时可能失效，需要手动添加DokitNavigatorObserver
注：页面启动耗时信息只有在profile或release模式下才有意义