登录

去注册

登录

注册

去登录

注册

Android调试利器Pandora了解下哇

whataa   2018-07-03   收藏

an android library for debugging what we care about directly in app.

API License

Pandora

Pandora 是一款无需ROOT、可以直接在 应用内 查看和修改包括网络、数据库、UI等的Android工具箱,适合开发和测试阶段的各种问题的快速定位。

功能

  • 查看每条网络请求的详细日志,例如headers、response等;
  • 查看自身应用的内部存储系统;
  • 查看所有数据库,支持直接进行增删改查操作;
  • 查看并编辑所有Shared Preference;
  • 预览当前页面的视图层级、查看/修改常用控件的属性;
  • 测量控件之间距离、检测是否对齐;
  • 选中页面上的任意控件以移动位置、查看自身大小、显示相对关系;
  • 更多功能期待大家探索;

部分效果如下:

展示图片依次为:网络、数据库、UI、文件

image image

image image

集成 Release

  1. 在root's build.gradle中加入Jitpack仓库:
allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
  1. 在app's build.gradle中(请使用最新版本):
dependencies {
    ...
    debugImplementation 'com.github.whataa:pandora:v1.0.1'
    releaseImplementation 'com.github.whataa:pandora-no-op:v1.0.1'
}  

最新库版本说明

library namerelease version
pandoraRelease
pandora-no-opRelease

使用

在应用的Application中调用以下代码初始化:

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Pandora.init(this).enableShakeOpen();
    }
}

enableShakeOpen() 是可选的,表示启用 “摇一摇打开” 的功能,开启后,在应用内任何页面摇晃手机都可以打开功能面板开始debug。

如果该特性和你的应用有冲突,也可以实现自己的触发方式并调用以下方法来打开功能面板:

Pandora.get().open();

关闭功能面板:

Pandora.get().close();

如果你的项目中使用了OKHttp作为底层网络库,可以为其添加以下拦截器开启网络调试模块的功能:

注意:请将Pandora作为最后一个拦截器,以防request-headers, request-params获取不到;

new OkHttpClient.Builder()
    ...
    .addInterceptor(Pandora.get().getInterceptor())
    ...
    .build()

扩展特性

查看View属性

Pandora默认支持动态查看和部分修改View、ViewGroup以及常见的TextView、ImageView控件的属性,如果想查看更多控件的属性,可以通过以下方式进行扩展:

  1. 实现 tech.linjiang.pandora.inspector.attribute.IParser 接口并指定所关注的View类型,这里以已经实现的ImageView为例:
public class ImageViewParser implements IParser<ImageView> {

    @Override
    public List<Attribute> getAttrs(ImageView view) {
        List<Attribute> attributes = new ArrayList<>();
        // 添加所关心的属性并返回
        Attribute scaleTypeAttribute = new Attribute("scaleType", scaleTypeToStr(view.getScaleType()), Attribute.Edit.SCALE_TYPE);
        attributes.add(scaleTypeAttribute);
        return attributes;
    }
    ...
}
  1. 将新建的Parser添加到Pandora中即可:
Pandora.get().getAttrFactory().addParser(new ImageViewParser());

在此之后,每次点击查看ImageView控件时,属性列表中会自动将我们所关注的属性值列举出来。

查看Shared Preference

Pandora默认读取的是应用内默认的SP路径下(data/data/<package-name>/shared_prefs/)的XML文件,如果有其它非默认路径的SP文件,可以通过以下方式扩展:
1. 实现 tech.linjiang.pandora.preference.protocol.IProvider接口,返回对应的文件列表:

(具体可参考库中的默认实现SharedPrefProvider)

  1. 将新建的Provider添加到Pandora中即可:
Pandora.get().getSharedPref().addProvider(new XXProvider());

限制

  • 最低支持的Android SDK版本为 14

  • 网络调试模块:仅支持底层为OKHttp 3.x的网络库;

  • 数据库调试模块:仅支持基于SQLite的数据库,且暂时不支持查看加密数据库;

  • 其它

致谢

Pandora是站在巨人的肩膀上开发而来,非常感谢以下开源项目:

  • 灵感来源于 Flipboard 开源的iOS平台调试工具 FLEX

  • 项目中的数据库模块思路及部分源码来源于 facebook 的开源项目 stetho

  • 项目中的UI模块中的选择控件的思路及部分源码来源于 eleme 的开源项目 UETool

  • Demo中的演示网络请求的API来源于 jgilfelt 的开源项目 chuck

开源协议

Apache-2.0

项目地址:https://github.com/whataa/pandora