-- 作者谢恩铭转载请注明出处

内容简介

前言
难读的 BugReport
ChkBugReport来拯救你
写一个 Shell 快捷方式
总结

1. 前言

从事 Android（嵌入式）开发，也许常要和 BugReport 打交道。

BugReport 是由 Bug 和 Report 这两个英语单词组成。bug 是英语「瑕疵，错误」的意思，在计算机领域专指程序中的问题。report 是英语「报告」的意思。

顾名思义，BugReport 就是「错误报告」的意思。不过，真实的 BugReport 不仅仅记录错误，不同级别的日志也会记录下来，方便我们 debug。

一般来说 Android 的 BugReport 是 .txt 结尾的文本文件，比如我们公司的 Android app 里的 BugReport 就是命名为 bugreport.txt。当然了，命名没有限定。

Google 的 Android 主页上有专页论述如何阅读 BugReport ：https://source.android.com/source/read-bug-reports

上面的页面推荐好好阅读下，对你排查 Android 的问题很有帮助。

2. 难读的 BugReport

Android 的 BugReport 里面包含了 dumpsys，dumpstate，logcat 命令输出的结果。内容一般来说会很多。

要生成一个 BugReport，我们可以运行以下命令：

adb bugreport > bugreport.txt

一般的 BugReport 是这样的：

这样的：

是不是觉得很难阅读呢？有点望而却步的感觉。

3. ChkBugReport来拯救你

幸好，我们有一个免费开源的小软件来拯救你。

这个软件是索尼（Sony）公司开发的，开源在 Github 上：https://github.com/sonyxperiadev/ChkBugReport

这个软件名叫 ChkBugReport。Chk 是 check 的缩写，表示「检查」。

ChkBugReport 并没有什么安装程序或脚本，只有一个 JAR 包供下载。

软件下载链接：https://github.com/sonyxperiadev/ChkBugReport/downloads

我们下载最新版，下载下来是这样一个文件：

要用它来解析 BugReport 文件并生成网页版报告，需要用 java 命令（请先安装和配置 Java 开发环境，网上有很多图文教程，就不赘述了）：

java -jar $HOME/chkbugreport.jar $HOME/bugreport.txt

$HOME 是一个环境变量，指示了你的家目录的路径。

ChkBugReport 会为你生成一个文件夹，叫做 bugreport_out，文件夹里有个 index.html 文件，这就是我们的错误报告的网页了，是一个 HTML 文件。

你可以双击启动它（如果你设置了 .html 文件用浏览器程序启动的话），或者用命令行，比如我用 firefox 浏览器来启动这个 HTML 文件：

firefox bugreport_out/index.html

打开后的网页如下所示，有很多栏目：

可以查看每一个栏目，比如查看 System log 中的 log ：

4. 写一个 Shell 快捷方式

难道每次我们启动 ChkBugReport 都要附上那个 JAR 包的路径吗？岂不是太麻烦。

没关系，我们可以写一个 Shell 脚本来作为快捷启动方式。

首先我们把 chkbugreport-0.4-185.jar 改名为 chkbugreport.jar，并把它放到 $HOME/bin 目录中：

mv $HOME/chkbugreport-0.4-185.jar $HOME/bin/chkbugreport.jar

然后创建一个 Shell 脚本，起名叫 chkbugreport 好了，也放在 $HOME/bin 目录中：

vim $HOME/bin/chkbugreport

在脚本中加入以下代码：

#!/bin/sh

DIR=$HOME/bin
JAR=$DIR/chkbugreport.jar
CP=$JAR

if [ ! -f $JAR]; then
    echo "为了这个脚本能够运行，请把下载的 ChkBugReport 的 JAR 包拷贝到 $JAR 中"
    exit 1
fi

java -jar $CP "$@"

为脚本添加可执行权限：

chmod +x $HOME/bin/chkbugreport

确保 $HOME/bin 这个目录在 Path 环境变量中，请参看 Linux探索之旅 | 第五部分第二课：一入Shell深似海，酷炫外壳惹人爱。

之后，你就可以在随便哪个目录中运行

chkbugreport bugreport.txt

来生成错误报告的网页版了。

5. 总结

Android 因其开源特性，相比 iOS 可以应用在更多领域，比如嵌入式。
网上有不少 Android 开发有用的开源工具，Github 上更是一搜一大堆。善于使用工具，必将事半功倍。
ChkBugReport 可以基于 Android 的 BugReport 为我们输出易读的网页版错误报告，是 HTML 格式的，可以用浏览器打开。

微信公众号「程序员联盟」ProgrammerLeague
我是谢恩铭，在巴黎奋斗的软件工程师。
我的简介
 我的经历
热爱生活，喜欢游泳，略懂烹饪。
人生格言：「向着标杆直跑」