Crash監(jiān)控的簡單實現(xiàn)方案

個人博客

http://www.milovetingting.cn

Crash監(jiān)控的簡單實現(xiàn)方案

前言

本文從Java層及Native展開,簡單記錄Android中的Crash監(jiān)控方案。

Java層Crash

Java層的crash監(jiān)控，可以通過實現(xiàn)Thread.UncaughtExceptionHandler接口，重寫uncaughtException方法來實現(xiàn)，簡單示意代碼如下:

public class CrashHandler implements Thread.UncaughtExceptionHandler {

    private static Thread.UncaughtExceptionHandler defaultUncaughtExceptionHandler;

    private static Context mContext;

    private static String mPath;

    public static void init(Context context, String path) {
        mContext = context.getApplicationContext();
        mPath = path;
        defaultUncaughtExceptionHandler = Thread.getDefaultUncaughtExceptionHandler();
        Thread.setDefaultUncaughtExceptionHandler(new CrashHandler());
    }


    @Override
    public void uncaughtException(@NonNull Thread thread, @NonNull Throwable throwable) {
        File dir = new File(mContext.getExternalCacheDir(), mPath);
        if (!dir.exists()) {
            dir.mkdirs();
        }
        long l = System.currentTimeMillis();
        File file = new File(dir, l + ".txt");

        try {
            PrintWriter pw = new PrintWriter(new FileWriter(file));
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            pw.println("time: " + sdf.format(new Date()));
            pw.println("thread: " + thread.getName());
            throwable.printStackTrace(pw);
            pw.flush();
            pw.close();
        } catch (Exception ioException) {
            ioException.printStackTrace();
        } finally {
            if (defaultUncaughtExceptionHandler != null) {
                defaultUncaughtExceptionHandler.uncaughtException(thread, throwable);
            }
        }
    }
}

新建一個CrashUtil類，封裝CrashHandler

public class CrashUtil {

    //Java層Crash信息保存目錄
    public static final String JAVA_CRASH_DIR = "java_crash";

    public static void init(Context context) {

        //初始化Java層CrashHandler
        Context applicationContext = context.getApplicationContext();
        CrashHandler.init(applicationContext, JAVA_CRASH_DIR);

    }

}

在Application的onCreate方法中，初始化CrashHandler

public class AppInit extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        CrashUtil.init(this);
    }
}

在AndroidManifest中配置Application的name屬性

<application
        android:name=".AppInit"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <!--省略其它代碼-->
    </application>

Native層Crash

Native層crash監(jiān)控，可以采用Google的BreakPad開源框架。開源地址:https://github.com/google/breakpad

BreakPad需要編譯后才能使用。

  1. 新建一個module，專門編譯BreakPad。

  2. 要新建的breakpadlib的src/main目錄下，新建cpp目錄，這個目錄名稱隨意。

  3. 在cpp目錄下新建breakpad目錄，這個目錄名稱隨意。

  4. 將下載回來的BreakPad代碼解壓后，將里面的src目錄都復制到剛才新建的breakpad目錄下。

  5. 在breakpad目錄下新建CMakeLists.txt文件，在里面配置如下

    cmake_minimum_required(VERSION 3.4.1)

include_directories(src src/common/android/include)

enable_language(ASM)

add_library(breakpad STATIC
        src/client/linux/crash_generation/crash_generation_client.cc
        src/client/linux/dump_writer_common/thread_info.cc
        src/client/linux/dump_writer_common/ucontext_reader.cc
        src/client/linux/handler/exception_handler.cc
        src/client/linux/handler/minidump_descriptor.cc
        src/client/linux/log/log.cc
        src/client/linux/microdump_writer/microdump_writer.cc
        src/client/linux/minidump_writer/linux_dumper.cc
        src/client/linux/minidump_writer/linux_ptrace_dumper.cc
        src/client/linux/minidump_writer/minidump_writer.cc
        src/client/minidump_file_writer.cc
        src/common/convert_UTF.cc
        src/common/md5.cc
        src/common/string_conversion.cc
        src/common/linux/breakpad_getcontext.S
        src/common/linux/elfutils.cc
        src/common/linux/file_id.cc
        src/common/linux/guid_creator.cc
        src/common/linux/linux_libc_support.cc
        src/common/linux/memory_mapped_file.cc
        src/common/linux/safe_readlink.cc)

target_link_libraries(breakpad log)

  6. 在breakpadlib模塊的src/main/java/包名/目錄下，創(chuàng)建NativeCrash.java文件，在這里聲明Native方法，方便其它模塊調用

    public class NativeCrash {

    static {
        System.loadLibrary("breakpad_lib");
    }

    public static void init(String path) {
        initNativeCrash(path);
    }

    /**
     * 初始化NativeCrash
     *
     * @param path
     */
    private static native void initNativeCrash(String path);

}

  1. 在cpp目錄下，新建breakpad_lib.cpp文件，實現(xiàn)native方法，并配置Native層crash的監(jiān)聽

    #include <jni.h>
#include <android/log.h>
#include "client/linux/handler/minidump_descriptor.h"
#include "client/linux/handler/exception_handler.h"

#define TAG "breakpad_lib"

bool DumpCallback(const google_breakpad::MinidumpDescriptor &descriptor,
                  void *context,
                  bool succeeded) {
    __android_log_print(ANDROID_LOG_ERROR, TAG, "native crash:%s", descriptor.path());
    return false;
}

extern "C"
JNIEXPORT void JNICALL
Java_com_wangyz_breadpadlib_NativeCrash_initNativeCrash(JNIEnv *env, jclass clazz, jstring path_) {

    const char *path = env->GetStringUTFChars(path_, 0);

    __android_log_print(ANDROID_LOG_INFO, TAG, "initNativeCrash,dmp path:%s", path);

    google_breakpad::MinidumpDescriptor descriptor(path);

    static google_breakpad::ExceptionHandler eh(descriptor, NULL, DumpCallback, NULL, true, -1);

    env->ReleaseStringUTFChars(path_, path);

}

  2. 在cpp目錄下創(chuàng)建CMakeLists.txt文件

    cmake_minimum_required(VERSION 3.4.1)

include_directories(breakpad/src breakpad/src/common/android/include)

add_library(breakpad_lib SHARED breakpad_lib.cpp)

add_subdirectory(breakpad)

target_link_libraries(breakpad_lib breakpad log)

  3. 在breakpadlib的build.gradle文件中配置ndk

    android {
    //...

    defaultConfig {
        //...

        // 要編譯哪些CPU架構
        externalNativeBuild {
            cmake {
                abiFilters 'armeabi-v7a', 'x86'
            }
        }

        // 把哪些CPU架構打包進去
        ndk {
            abiFilters 'armeabi-v7a', 'x86'
        }
    }

    externalNativeBuild {
        cmake {
            path 'src/main/cpp/CMakeLists.txt'
        }
    }

    //...
}

  4. build這個module，就會生成包含so的aar，可以給其它模塊引用，這樣就可以為Native層的Crash增加監(jiān)控。

breakpadlib目錄結構如圖

breakpadlib目錄結構

注意事項

在編譯時，一般會報錯。這是由于缺少相應的文件導致的。將linux_syscall_support.h文件放到cpp/breakpad/src/third_part/lss目錄下，再編譯就可以了。

app模塊引用breakpad編譯出來的aar

將編譯出來的aar放到app模塊的libs目錄下，并配置app的build.gradle文件

android {
    //...

    sourceSets {
        main {
            jniLibs.srcDir(['libs'])
        }
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

dependencies {
    //...

    api(name: 'breadpadlib-release', ext: 'aar')
}

同步工程，然后在前面創(chuàng)建的CrashUtil中增加對Native的Crash的初始化。

public class CrashUtil {

    //Java層Crash信息保存目錄
    public static final String JAVA_CRASH_DIR = "java_crash";

    //Native層Crash信息保存目錄
    public static final String NATIVE_CRASH_DIR = "native_crash";

    public static void init(Context context) {

        //初始化Java層CrashHandler
        Context applicationContext = context.getApplicationContext();
        CrashHandler.init(applicationContext, JAVA_CRASH_DIR);

        //初始化Native層CrashHandler
        File file = new File(context.getExternalCacheDir(), NATIVE_CRASH_DIR);
        if (!file.exists()) {
            file.mkdirs();
        }
        NativeCrash.init(file.getAbsolutePath());

    }

}

模擬Native層Crash

  1. 新建一個module:crash,用于生成演示Native層Crash所用的so。

  2. 在crash模塊下的src/main/java/目錄下創(chuàng)建CrashTest.java，聲明native方法

    public class CrashTest {

    static {
        System.loadLibrary("crash_test");
    }

    public static void testCrash() {
        test();
    }

    private static native void test();
}

  3. 在crash模塊下的src/main/目錄下，新建jni目錄

  4. 在jni目錄下新建cpp目錄，在cpp目錄下創(chuàng)建crash_test.cpp

    #include <jni.h>

extern "C"
JNIEXPORT void JNICALL
Java_com_wangyz_crash_CrashTest_test(JNIEnv* env,jclass clazz) {
    int * i = NULL;
    *i = 0;
}

  5. 生成so

    可以通過ndk-build直接生成so文件。在jni目錄下創(chuàng)建Android.mk

    LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)

LOCAL_MODULE := crash_test
LOCAL_SRC_FILES := cpp/crash_test.cpp
include $(BUILD_SHARED_LIBRARY)

    然后在jni的目錄下，執(zhí)行cmd命令ndk-build。如果沒有在系統(tǒng)環(huán)境變量中配置ndk，一般會報'ndk-build' 不是內部或外部命令，也不是可運行的程序。通過Android Studio下載的ndk，一般在Android Studio配置的SDK目錄下。進入SDK目錄下的ndk目錄，選擇一個版本的ndk，將這個路徑配置到環(huán)境變量中。重新打開CMD窗口，并定位到jni目錄下，重新執(zhí)行ndk-build,就會在jni目錄下生成libs和obj目錄。

    也可以在crash模塊的build.gradle中配置來生成aar

    android {
    //...

    defaultConfig {
        //...

        // 要編譯哪些CPU架構
        externalNativeBuild {
            cmake {
                abiFilters 'armeabi-v7a', 'x86'
            }
        }

        // 把哪些CPU架構打包進去
        ndk {
            abiFilters 'armeabi-v7a', 'x86'
        }
    }

    externalNativeBuild {
        cmake {
            path 'src/main/jni/CMakeLists.txt'
        }
    }
    
    //...
}

    在jni目錄下創(chuàng)建CMakeLists.txt

    # CMake方式需要在build.grale中配置其它信息,但可以build生成aar
# 采用Android.mk配置，不需要再額外配置信息

cmake_minimum_required(VERSION 3.4.1)

include_directories(cpp/)

add_library(crash_test SHARED cpp/crash_test.cpp)

target_link_libraries(crash_test)

    build后，就可以生成包含so的aar文件

    crash模塊的目錄結構

    breakpadlib目錄結構

  6. 將aar放到app模塊的libs目錄，并在build.gradle中增加對新加入的aar的引用

    api(name: 'crash-release', ext: 'aar')## 測試Crash

測試Crash

Java Crash

在Activity的onCreate中加入以下代碼

//模擬java crash
int i = 1 / 0;

打包APK，安裝到手機，運行APK，程序Crash。查看/sdcard/Android/data/包名/，發(fā)現(xiàn)在java_crash目錄，生成了記錄crash信息的文件。

Native Crash

在Activity的onCreate中加入以下代碼

//模擬native crash
CrashTest.testCrash();

打包APK，安裝到手機，運行APK，程序Crash。查看/sdcard/Android/data/包名/，發(fā)現(xiàn)在native_crash目錄，生成了記錄crash信息的文件xxx.dmp。

將dmp文件導出到電腦。然后在Android Studio的安裝目錄/bin/lldb/bin中，執(zhí)行CMD命令

minidump_stackwalk D:\15d05b74-5316-4082-cb24cda2-80f355e4.dmp > crash.txt

在當前目錄下會生成crash.txt文件

Operating system: Android
                  0.0.0 Linux 4.4.23+ #1 SMP PREEMPT Wed Sep 30 13:40:36 CST 2020 armv7l
CPU: arm
     ARMv1 ARM part(0x4100d0b0) features: half,thumb,fastmult,vfpv2,edsp,neon,vfpv3,tls,vfpv4,idiva,idivt
     8 CPUs

GPU: UNKNOWN

Crash reason:  SIGILL
Crash address: 0xcb13875c
Process uptime: not available

Thread 0 (crashed)
 0  libcrash_test.so + 0x75c
     r0 = 0xed7b1230    r1 = 0xffc18d0c    r2 = 0x00430000    r3 = 0xffc18ec8
     r4 = 0xef0c35f4    r5 = 0x00000000    r6 = 0x00000000    r7 = 0xffc18fc8
     r8 = 0x00000056    r9 = 0xed7cb000   r10 = 0x00000000   r12 = 0xcb13875d
     fp = 0xffc18d74    sp = 0xffc18d00    lr = 0xcb2d3519    pc = 0xcb13875c
    Found by: given as instruction pointer in context
 1  dalvik-LinearAlloc (deleted) + 0xe5f2
     sp = 0xffc18d04    pc = 0xef0c35f4
    Found by: stack scanning
 2  dalvik-main space (region space) (deleted) + 0xc909ce
     sp = 0xffc18d10    pc = 0x138909d0
    Found by: stack scanning
 3  libart.so + 0x3e0931
     sp = 0xffc18d70    pc = 0xeb2a0933
    Found by: stack scanning
 4  base.vdex + 0x1d521f
     sp = 0xffc18d78    pc = 0xcb519221
    Found by: stack scanning

這個文件列出了操作系統(tǒng)、CPU等信息。

breakpadlib目錄結構

在ndk目錄下，找到ndk\21.0.6113669\toolchains\arm-linux-androideabi-4.9\prebuilt\windows-x86_64\bin\目錄，這里的arm-linux-androideabi-4.9具體以手機的CPU架構為準。

執(zhí)行CMD

arm-linux-androideabi-addr2line.exe -f -C -e D:\libcrash_test.so 0x75c

這里的libcrash_text.so就是發(fā)生crash的so文件，0x75c為上面轉換出來的crash.txt中發(fā)生crash的地址。通過addr2line工具，可以看到發(fā)生crash的具體行數。

后記

關于crash監(jiān)控方案，本文記錄得比較淺顯的，可以查閱其它更詳細的資料。

源碼

https://github.com/milovetingting/Samples/tree/master/BreakPad

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內容

  • 原文[http://www.itdecent.cn/p/4278915847b6]源碼[https://down...
    WaterYuan閱讀 2,281評論 1贊 2
  • Crash（應用崩潰）是由于代碼異常而導致 App 非正常退出，導致應用程序無法繼續(xù)使用，所有工作都停止的現(xiàn)象。發(fā)...
    wuchao226閱讀 1,374評論 0贊 0
  • Android異常監(jiān)控 Crash就是由于代碼異常而導致App非正常退出現(xiàn)象，也就是我們常說的『崩潰』 通常情況下...
    Heezier閱讀 1,169評論 2贊 6
  • Crash(應用崩潰)是由于代碼異常而導致 App 非正常退出，導致應用程序無法繼續(xù)使用，所有工作都 停止的現(xiàn)象。...
    zcwfeng閱讀 754評論 0贊 2
  • 作者：lds(lds2012@gmail.com[mailto:lds2012@gmail.com]) 日期：20...
    駱駝騎士閱讀 37,740評論 6贊 14

友情鏈接更多精彩內容