DoraemonKit一款功能齐全的Android研发助手

开发背景

每一个稍微有点规模的 App，总会自带一些线下的测试功能代码，比如环境切换功能、帧率查看功能等等，这些功能的切换入口往往放在各式各样的入口中，比如一些特殊的手势，双击 statusBar，双击某一个功能区块，或者新建一个 keyWindow 始终至于 App 最上方等等，而且每一个 App 里面的线下附带功能模块很多是相似的，比如帧率查看、内存和 CPU 监控等等，但是现在基本上都是每个 App 都是自己实现了一份，经历了以上的问题之后，DoraemonKit 就有了它存在的意义。

DoraemonKit 是一个功能集合面板，能够让每一个 App 快速接入一些常用的或者你没有实现的一些辅助开发工具、测试效率工具、视觉辅助工具，而且能够完美在 Doraemon 面板中接入你已经实现的与业务紧密耦合的一些非通有的辅助工具，功能强大，接入方便，便于扩展。

简单总结

1、DoraemonKit 能够快速让你的业务测试代码能够在这里统一管理，统一收口；
2、DoraemonKit 内置很多常用的工具，避免重复实现，一次接入，你将会拥有强大的工具集合。

效果演示

功能模块

一、常用工具

1. 【App 信息查看】 快速查看手机信息，App 信息，权限信息的渠道，避免去手机设置查找或者查看项目源代码的麻烦；
2. 【沙盒浏览】 App 内部文件浏览的功能，支持删除和预览, 并且能通过 AirDrop 或者其他分享方式上传到 PC 中，进行更加细致的操作；
3. 【MockGPS】 App 能定位到全国各地，支持地图地位和手动输入经纬度；
4. 【H5任意门】 开发测试同学可以快速输入 H5 页面地址，查看该页面效果；
5. 【Crash查看】 方便本地打印出出现 Crash 的堆栈；
6. 【子线程UI】 快速定位哪一些 UI 操作在非主线程中进行渲染，避免不必要的问题；
7. 【清除本地数据】 一键删除沙盒中所有数据；
8. 【NSLog】 把所有 NSLog 信息打印到UI界面，避免没有开发证书无法调式的尴尬；
9. 【Lumberjack】 每一条 CocoaLumberjack 的日志信息，都在在 App 的界面中显示出来，再也不需要导出日志这么麻烦。

二、性能检测

1. 【帧率】 App 帧率信息提供波形图查看功能，让帧率监控的趋势更加明显；
2. 【CPU】 App CPU 使用率信息提供波形图查看功能，让 CPU 监控的趋势更加形象；
3. 【内存】 App 内存使用量信息提供波形图查看功能，让内存监控的趋势更加鲜明；
4. 【流量】 拦截 App 内部流量信息，提供波形图展示、流量概要展示、流量列表展示、流量筛选、流量详情，对流量信息统一拦截，成为我们 App 中自带的 “Charles”；
5. 【卡顿】 锁定 App 出现卡顿的时刻，打印出对应的代码调用堆栈；
6. 【自定义】 可以选择你要监控的选项，包括 FPS、CPU、内存、流量。监控完毕之后，把数据保存到本地，也可以导出来做更加细致的分析；
7. 【Load 耗时】 Load 函数耗时是 iOS 启动性能优化中重要的一项，该功能可以打印出所有 Load 函数的耗时，给开发者以参考。

三、视觉工具

1. 【颜色吸管】 方便设计师 UI 捉虫的时候，查看每一个组件的颜色值是否设置正确；
2. 【组件检查】 可以抓取任意一个UI控件，查看它们的详细信息，包括控件名称、控件位置、背景色、字体颜色、字体大小；
3. 【对齐标尺】 参考 Android 系统自带测试工具，能够实时捕获屏幕坐标，并且可以查看组件是否对齐；
4. 【元素边框线】 绘制出每一个 UI 组件的边框，对于组件布局有一定的参考意义。

接入方式

1. Gradle依赖

dependencies {
        ...
    debugImplementation 'com.didichuxing.doraemonkit:doraemonkit:1.1.2'
    releaseImplementation 'com.didichuxing.doraemonkit:doraemonkit-no-op:1.1.2'
    ...
}

最新版本参见这里。

2. 初始化

在App启动的时候进行初始化。

@Override
public void onCreate() {
        ...
    DoraemonKit.install(application)
     
    // H5任意门功能需要，非必须
    DoraemonKit.setWebDoorCallback(new WebDoorManager.WebDoorCallback() {
    @Override
    public void overrideUrlLoading(Context context, String s) {
        // 使用自己的H5容器打开这个链接
    }
    ...
} 

3. 流量监控功能（可选）

在项目的build.gradle中添加classpath。

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    dependencies {
        ...
        classpath 'com.didichuxing.doraemonkit:compiler:1.0.1'
        ...
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

在app的build.gradle中添加plugin。

...
apply plugin: 'com.doraemon.compiler.plugin'

4. 自定义功能组件（可选）

自定义组件需要实现IKit接口，该接口对应哆啦A梦功能面板中的组件。

以黑马乘客端为例，实现环境切换组件如下。

public class EnvSwitchKit implements IKit {
    @Override
    public int getCategory() {
        return Category.BIZ;
    }
 
    @Override
    public int getName() {
        return R.string.bh_env_switch;
    }
 
    @Override
    public int getIcon() {
        return R.drawable.bh_roadbit;
    }
 
    @Override
    public void onClick(Context context) {
        DebugService service = ServiceManager.getInstance().getService(context, DebugService.class);
        PageManager.getInstance().startFragment(service.getContainer(), EnvSwitchFragment.class);
    }
 
    @Override
    public void onAppInit(Context context) {
    
    }
}

在初始化的时候注册自定义组件。

@Override
public void onCreate() {
    kits.add(new EnvSwitchKit());
    DoraemonKit.install(application, kits);
    ...
}

5. FAQ

1. 为什么接入后看不到悬浮窗入口？

先看下是否打开了app的悬浮窗权限，另外看看是否错误引用了no-op版本

2. com.didichuxing.doraemonkit:kit和com.didichuxing.doraemonkit:kit-no-op有什么区别？

no-op版本仅提供了DoraemonKit类的空实现，因为DoraemonKit是不推荐集成到线上版本使用的，可通过gradle配置动态切换正常版本和no-op版本。

3. 没有H5任意门入口

H5任意门需要在调用DoraemonKit.setWebDoorCallback实现回调，打开自己App内的Webview，这是因为一般app都有自己的JsBridge逻辑，使用通用的Webview打开Url并没什么意义。如果接入时未设置回调，则在菜单页不会显示H5任意门

4. 流量监控无数据

目前流量监测功能只支持OkHttp3和HttpUrlConnection的自动注入，其他网络库暂不支持。 其他网络库可以使用NetworkPrinterHelper类进行请求数据的手动添加，使用方式参照demo。

5. 性能监控中，CPU、RAM无数据

旧版本的CPU监控是通过读取/proc实现的，在8.0系统上这个方法读取不到数据。新版本已修改了实现方式，可以正常读取。

6. 帧率、CPU、RAM数据不准确

由于读取cpu、内存数据本身需要消耗cpu和内存，加上心跳图的绘制也是耗性能的，所以开启这几项功能后，数据比app实际使用值有一定提升。

7. com.doraemon.compiler.plugin是必须的吗

这个插件目前的用处是在编译阶段在okhttp和httpurlconnection的调用处进行插桩，用以收集网络请求数据从而实现流量监控功能，如果不需要流量监控功能或者使用的是非okhttp和httpurlconnection网络库，则可以不引用这个插件。另外，这个插件会在用户自定义的Application内插入DoraemonKit.install方法，实现sdk的自动注册，引用了这个插件就不需要手动注册sdk了。 因为这个插件会涉及到字节码的修改，同时会插入一些代码到网络请求中，对性能和稳定性有轻微影响，所以极度不推荐线上版本中使用。在线上版本中，务必去除该插件的引用。

8. 沙盒游览功能能否打开数据库、sp文件

目前沙盒功能是以文本形式打开数据库文件和sp文件，sp文件是xml格式，可以正常浏览，但是数据库文件打开会有乱码，后续会提供类似Root Explorer的数据库查看功能。