android studio第三方调试,Android Studio中三方so库的源码调试

一、需求背景

Android Studio 2.2+版本支持使用CMake构建native库，同时调试器也能对自构建的native代码进行源码的调试，我们可以像调试java代码一样方便地调试native代码。

我们很多的项目都依赖的so库，有些是我们单独的库工程中的，有些是三方提供的。如果想在主工程中调试这些库的源码，一种方法添加子工程或者CMake子模块关联源码，作为自身构建的一部分，当然需要所有的子工程都编译通过。

搭建多工程环境和构建子工程本身就是一个耗时又麻烦的事情，我们希望和库工程尽量不要耦合，而且调试时不需要再去构建库工程。

问题：我们本地有so库对应版本的源码，也有带符号so文件，如何进行源码的调试？

二、工程示例

这里我们示例一个简单的库工程mylib，它的c++代码中封装了一个求平均数的方法，然后java对外暴露了native的接口。

#include

extern "C"

JNIEXPORT jint JNICALL

Java_smarttime_tsia_com_mylib_MyLibNative_nativeCalAverage(JNIEnv *env, jclass type, jint a, jint b) {

int sum = a+b;

int avg = sum/2;

return avg;

}

MyLibNative.java

package smarttime.tsia.com.mylib;

public class MyLibNative {

static {

System.loadLibrary("test-lib");

}

public static native int nativeCalAverage(int a, int b);

}

然后我们将它打包成一个armeabi-v7a架构的so库(libtest-lib.so)：

我们APP主工程中，依赖这个三方库(可以通过fileTree或maven)，有一个按钮点击触发调用nativeCalAverage：

public class MainActivity extends AppCompatActivity {

...

void onClick(View v) {

int ret = MyLibNative.nativeCalAverage(3,5);

}

}

三、源码调试

要在主工程中进行源码调试，首先要有源码，这边要注意要和主工程依赖的版本对应。工程依赖的三方库都是不带符号的，我们可以解压APK查看libtest-lib.so，stripped表示调试信息已经去掉了

1. 获取符号文件

符号文件中包含了行号信息，这样调试器就知道符号地址对应的行号，也包含源码文件的信息，这样在IDE中调试器就能调到对应的文件中的某一行了。

在库工程中，虽然发布的时候so去掉了调试信息，但是构建时会生成cmake原始的构建产物，其中带有符号信息，注意到带符号的so要比不带符号的要大很多

2. 调试过程和原理

1)启动调试器

可通过Debug 'app'或者Attach Debugger to Process的方式，后者无需重启应用，注意选择Debug Type为native，因为我们要调试的是native代码。

2)设置断点

调试器连接上进程之后，点击pause program，然后我们在jni方法Java_smarttime_tsia_com_mylib_MyLibNative_nativeCalAverage设置一个断点，source info可以查看当前堆栈的源码和行号信息，但这时候我们还没有符号文件，所以只能看到一个它的地址。

3)添加符号文件

add-dsym可以添加指定的符号文件，如果这时候libtest-lib.so还没有加载进来就会添加失败，匹配不到对应的模块。

add-dsym的时候我们取得是mylib库工程中cmake的构建产物，现在我们将库工程的源码在主工程的IDE中打开。这时我们通过IDE在文件中打断点就能看到行号都已经对上了。

4)触发断点

断点触发以后，source info查看到当前的行号已经有了，源码信息也指向我们工程中打开的源码文件，所以IDE就跳到对应的断点上了，然后我们就可以进行单步调试、条件断点、watch point等调试了。

实际调试中只要调试器连接到进程，然后添加调试符号就行了，然后Android Studio中在对应的源码文件中直接打断点调试即可，上述过程只是方便分析原理。

3. 源码映射

上述的符号文件和源码是在库工程里，符号文件是源码构建生成的，所以我们添加了符号文件就能调试源码了。实际在很多项目中库构建和发布都是在一台专门用来打包的服务器(云端)上进行的，本地只有对应版本的源码，为了保证一致性，主工程依赖的是打包机器发布的库，我们也用打包机器上生成的符号文件来调试。

打包机器和本地生成的符号文件唯一的不同就是构建环境，也就是源码文件的路径信息。我们来模拟一下，假设上述在mylib工程的目录就是打包发布的专用目录，而我们要调试的native代码放在了另一个目录里。

打包时环境：/Users/derek/Documents/AndroidProject/jniTest2/mylib/src/main/jni/test.cpp

调试源码路径：/Users/derek/Downloads/src/test.cpp

符号文件添加后，断点到jni方法，虽然有行号信息，但IDE中并没有调到对应的文件，因为这时候调试器只知道符号文件的源码信息，它没有指向本地要调试的源码。

执行LLDB的setting set target.source-map命令把符号文件中的源码信息指向本地调试的文件路径，设置成功后，可以看到断点就生效了，这时候source info也改变了。

4. Android Studio Debugger配置

以上我们都是通过执行lldb命令来添加符号、源码映射的，如果觉得麻烦Android Studio也提供了Debugger配置：

Symbol Directories为符号目录，调试器会递归的寻找这个目录下的文件，直到匹配到需要的符号文件为止；LLDB Post Attach Commands为调试器连接到进程后执行的命令，我们可以在这里添加setting set target.source-map源码映射的命令。

如果通过Debugger配置来调试，必须用Debug 'app'的方式，不能使用Attach的方式，因为只有前者才会去执行Debugger里的命令。

参考：