當APP主線程拋出異常時就會導致APP crash,可能是由於view點擊時拋出了異常等等,像這種異常我們更希望即使點擊沒反應也不要crash,用戶頂多會認爲是點了沒反應,或者認爲是本來就不可以點擊,這時候就可以使用Cockroach,而且沒有其他副作用,用戶就跟沒點一樣,並且不影響其他邏輯。這樣總比每次都crash要好很多,起碼不會由於頻繁crash導致用戶卸載APP。當然這個庫也存在不確定因素,比如Activity初始化時等拋出了異常,就會導致Activity什麼都不顯示,但這並不是ANR,是由於Activity生命週期沒有執行完整導致,issues中很多人認爲這是ANR,進而導致微博上有人說這個庫捕獲到異常後會導致ANR,其實這個時候主線程並沒有被阻塞,也就不存在ANR。當然這個庫對於native異常和ANR也是無能爲力的,只能保證java異常不會導致crash。
當線上發現進入某個Activity時有大量crash時,若裝載Cockroach後不影響APP運行,不影響用戶體檢,就可以通過後端控制來自動開啓Cockroach,當退出這個Activity後自動卸載Cockroach。
下文也明確說明了
可以根據需要在任意地方裝載,在任意地方卸載。 雖然可以捕獲到所有異常,但可能會導致一些莫名其妙的問題,比如view初始化時發生了異常,異常後面的代碼得不到執行,雖然不 會導致app crash但view內部已經出現了問題,運行時就會出現很奇葩的現象。再比如activity聲明週期方法中拋出了異常,則生 命週期就會不完整,從而導致各種奇葩的現象。
所以關鍵是要如何正確利用這個庫
Cockroach
打不死的小強,永不crash的Android。
android 開發中最怕的就是crash,好好的APP測試時沒問題,一發布就各種crash,只能通過緊急發佈hotfix來解決,但準備hotfix的時間可能很長,導致這段時間用戶體驗非常差,android中雖然可以通過設置 Thread.setDefaultUncaughtExceptionHandler來捕獲所有線程的異常,但主線程拋出異常時仍舊會導致activity閃退,app進程重啓。使用Cockroach後就可以保證不管怎樣拋異常activity都不會閃退,app進程也不會重啓。 關於DefaultUncaughtExceptionHandler的用法參考這 DefaultUncaughtExceptionHandler
使用方式
自定義Application繼承自android的Application,並在Application中裝載,越早初始化越好,可以在Aplication的onCreate中初始化,當然也可以根據需要在任意地方(不一定要在主線程)裝載,在任意地方卸載。可以多次裝載和卸載。
例如:
import android.app.Application;
import android.os.Handler;
import android.os.Looper;
import android.util.Log;
import android.widget.Toast;
/**
* Created by wanjian on 2017/2/14.
*/
public class App extends Application {
@Override
public void onCreate() {
super.onCreate();
Cockroach.install(new Cockroach.ExceptionHandler() {
// handlerException內部建議手動try{ 你的異常處理邏輯 }catch(Throwable e){ } ,以防handlerException內部再次拋出異常,導致循環調用handlerException
@Override
public void handlerException(final Thread thread, final Throwable throwable) {
//開發時使用Cockroach可能不容易發現bug,所以建議開發階段在handlerException中用Toast談個提示框,
//由於handlerException可能運行在非ui線程中,Toast又需要在主線程,所以new了一個new Handler(Looper.getMainLooper()),
//所以千萬不要在下面的run方法中執行耗時操作,因爲run已經運行在了ui線程中。
//new Handler(Looper.getMainLooper())只是爲了能彈出個toast,並無其他用途
new Handler(Looper.getMainLooper()).post(new Runnable() {
@Override
public void run() {
try {
//建議使用下面方式在控制檯打印異常,這樣就可以在Error級別看到紅色log
Log.e("AndroidRuntime","--->CockroachException:"+thread+"<---",throwable);
Toast.makeText(App.this, "Exception Happend\n" + thread + "\n" + throwable.toString(), Toast.LENGTH_SHORT).show();
// throw new RuntimeException("..."+(i++));
} catch (Throwable e) {
}
}
});
}
});
}
}
卸載 Cockroach
Cockroach.uninstall();
測試
裝載Cockroach後點擊view拋出異常和new Handler中拋出異常
final TextView textView = (TextView) findViewById(R.id.text);
findViewById(R.id.install).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
textView.setText("已安裝 Cockroach");
install();
}
});
findViewById(R.id.uninstall).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
textView.setText("已卸載 Cockroach");
Cockroach.uninstall();
}
});
findViewById(R.id.but1).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
throw new RuntimeException("click exception...");
}
});
findViewById(R.id.but2).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Handler().post(new Runnable() {
@Override
public void run() {
throw new RuntimeException("handler exception...");
}
});
}
});
findViewById(R.id.but3).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread() {
@Override
public void run() {
super.run();
throw new RuntimeException("new thread exception...");
}
}.start();
}
});
findViewById(R.id.but4).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
startActivity(new Intent(getApplicationContext(), SecActivity.class));
}
});
}
private void install() {
Cockroach.install(new Cockroach.ExceptionHandler() {
@Override
public void handlerException(final Thread thread, final Throwable throwable) {
Log.d("Cockroach", "MainThread: " + Looper.getMainLooper().getThread() + " curThread: " + Thread.currentThread());
new Handler(Looper.getMainLooper()).post(new Runnable() {
@Override
public void run() {
try {
Log.e("AndroidRuntime","--->CockroachException:"+thread+"<---",throwable);
Toast.makeText(getApplicationContext(), "Exception Happend\n" + thread + "\n" + throwable.toString(), Toast.LENGTH_SHORT).show();
// throw new RuntimeException("..."+(i++));
} catch (Throwable e) {
}
}
});
}
});
}
捕獲到的堆棧如下,可以看到都已經被 at com.wanjian.cockroach.Cockroach$1.run(Cockroach.java:47)
攔截,APP沒有任何影響,沒有閃退,也沒有重啓進程
02-16 09:58:00.660 21199-21199/wj.com.fuck E/AndroidRuntime: --->CockroachException:Thread[main,5,main]<---
java.lang.RuntimeException: click exception...
at wj.com.fuck.MainActivity$3.onClick(MainActivity.java:53)
at android.view.View.performClick(View.java:4909)
at android.view.View$PerformClick.run(View.java:20390)
at android.os.Handler.handleCallback(Handler.java:815)
at android.os.Handler.dispatchMessage(Handler.java:104)
at android.os.Looper.loop(Looper.java:194)
at com.wanjian.cockroach.Cockroach$1.run(Cockroach.java:47)
at android.os.Handler.handleCallback(Handler.java:815)
at android.os.Handler.dispatchMessage(Handler.java:104)
at android.os.Looper.loop(Looper.java:194)
at android.app.ActivityThread.main(ActivityThread.java:5826)
at java.lang.reflect.Method.invoke(Native Method)
at java.lang.reflect.Method.invoke(Method.java:372)
at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:1009)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:804)
02-16 09:58:12.401 21199-21199/wj.com.fuck E/AndroidRuntime: --->CockroachException:Thread[main,5,main]<---
java.lang.RuntimeException: handler exception...
at wj.com.fuck.MainActivity$4$1.run(MainActivity.java:63)
at android.os.Handler.handleCallback(Handler.java:815)
at android.os.Handler.dispatchMessage(Handler.java:104)
at android.os.Looper.loop(Looper.java:194)
at com.wanjian.cockroach.Cockroach$1.run(Cockroach.java:47)
at android.os.Handler.handleCallback(Handler.java:815)
at android.os.Handler.dispatchMessage(Handler.java:104)
at android.os.Looper.loop(Looper.java:194)
at android.app.ActivityThread.main(ActivityThread.java:5826)
at java.lang.reflect.Method.invoke(Native Method)
at java.lang.reflect.Method.invoke(Method.java:372)
at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:1009)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:804)
02-16 09:58:13.241 21199-21199/wj.com.fuck E/AndroidRuntime: --->CockroachException:Thread[Thread-26326,5,main]<---
java.lang.RuntimeException: new thread exception...
at wj.com.fuck.MainActivity$5$1.run(MainActivity.java:76)
當卸載Cockroach後再在click中拋出異常,日誌如下
02-16 09:59:01.251 21199-21199/wj.com.fuck E/AndroidRuntime: FATAL EXCEPTION: main
Process: wj.com.fuck, PID: 21199
java.lang.RuntimeException: click exception...
at wj.com.fuck.MainActivity$3.onClick(MainActivity.java:53)
at android.view.View.performClick(View.java:4909)
at android.view.View$PerformClick.run(View.java:20390)
at android.os.Handler.handleCallback(Handler.java:815)
at android.os.Handler.dispatchMessage(Handler.java:104)
at android.os.Looper.loop(Looper.java:194)
at android.app.ActivityThread.main(ActivityThread.java:5826)
at java.lang.reflect.Method.invoke(Native Method)
at java.lang.reflect.Method.invoke(Method.java:372)
at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:1009)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:804)
可以看到 at com.wanjian.cockroach.Cockroach$1.run(Cockroach.java:47)
沒有攔截,並且APP crash了。
注意
-
當主線程或子線程拋出異常時都會調用exceptionHandler.handlerException(Thread thread, Throwable throwable)
-
exceptionHandler.handlerException可能運行在非UI線程中。
-
handlerException內部建議手動try{ 你的異常處理邏輯 }catch(Throwable e){ } ,以防handlerException內部再次拋出異常,導致循環調用handlerException
-
若設置了Thread.setDefaultUncaughtExceptionHandler則可能無法捕獲子線程異常。
雖然可以捕獲到所有異常,但可能會導致一些莫名其妙的問題,比如view初始化時發生了異常,異常後面的代碼得不到執行,雖然不 會導致app crash但view內部已經出現了問題,運行時就會出現很奇葩的現象。再比如activity聲明週期方法中拋出了異常,則生 命週期就會不完整,從而導致各種奇葩的現象。
雖然會導致各種奇葩問題發生,但可以最大程度的保證APP正常運行,很多時候我們希望主線程即使拋出異常也不影響app的正常使用,比如我們 給某個view設置背景色時,由於view是null就會導致app crash,像這種問題我們更希望即使view沒法設置顏色也不要crash,這 時Cockroach就可以滿足你的需求。
handlerException(final Thread thread, final Throwable throwable)內部建議請求自己服務器決定該如何處理該異常,是 直接忽略還是殺死APP又或者其他操作。
Cockroach採用android標準API編寫,無依賴,足夠輕量,輕量到只有不到100行代碼,一般不會存在兼容性問題,也不存在性能上的問題,可以兼容所有android版本。
已上傳到jcenter, compile 'com.wanjian:cockroach:0.0.5'
原理分析:
android中最重要的就是Handler機制了,簡單來說Handler機制就是在一個死循環內部不斷取走阻塞隊列頭部的Message,這個阻塞隊列在主線程中是唯一的,當沒有Message時,循環就阻塞,當一旦有Message時就立馬被主線程取走並執行Message。
查看android源碼可以發現在ActivityThread中main方法(main方法簽名 public static void main(String[] args){}
,這個main方法是靜態的,公有的,可以理解爲應用的入口)最後執行了Looper.loop();
,此方法內部是個死循環(for(;;)循環),所以一般情況下主線程是不會退出的,除非拋出異常。queue.next();
就是從阻塞隊列裏取走頭部的Message,當沒有Message時主線程就會阻塞在這裏,一有Message就會繼續往下執行。android的view繪製,事件分發,activity啓動,activity的生命週期回調等等都是一個個的Message,android會把這些Message插入到主線程中唯一的queue中,所有的消息都排隊等待主線程的執行。
ActivityThread的main方法如下:
public static void main(String[] args) {
...
Looper.prepareMainLooper();//創建主線程唯一的阻塞隊列queue
...
ActivityThread thread = new ActivityThread();
thread.attach(false);//執行初始化,往queue中添加Message等
...
Looper.loop();//開啓死循環,挨個執行Message
throw new RuntimeException("Main thread loop unexpectedly exited");
}
Looper.loop()
關鍵代碼如下:
for (;;) {
Message msg = queue.next(); // might block
...
msg.target.dispatchMessage(msg);//執行Message
...
}
android消息機制僞代碼如下:
public class ActivityThread {
public static void main(String[]args){
Queue queue=new Queue();// 可以理解爲一個加鎖的,可以阻塞線程的ArrayList
queue.add(new Message(){
void run(){
...
print("android 啓動了,下一步該往queue中插入啓動主Activity的Message了");
Message msg=getMessage4LaunchMainActivity();
queue.add(msg);
}
});
for(;;){//開始死循環,for之後的代碼永遠也得不到執行
Message msg=queue.next();
msg.run();
}
}
}
看了上面的分析相信大家對android的消息機制很清楚了。 關於Handler機制更多內容可以看這 java工程實現Handler機制代碼
下面我們看一下Cockroach的核心代碼
new Handler(Looper.getMainLooper()).post(new Runnable() {
@Override
public void run() {
//主線程異常攔截
while (true) {
try {
Looper.loop();//主線程的異常會從這裏拋出
} catch (Throwable e) {
}
}
}
});
sUncaughtExceptionHandler = Thread.getDefaultUncaughtExceptionHandler();
//所有線程異常攔截,由於主線程的異常都被我們catch住了,所以下面的代碼攔截到的都是子線程的異常
Thread.setDefaultUncaughtExceptionHandler(new Thread.UncaughtExceptionHandler() {
@Override
public void uncaughtException(Thread t, Throwable e) {
}
});
原理很簡單,就是通過Handler往主線程的queue中添加一個Runnable,當主線程執行到該Runnable時,會進入我們的while死循環,如果while內部是空的就會導致代碼卡在這裏,最終導致ANR,但我們在while死循環中又調用了Looper.loop()
,這就導致主線程又開始不斷的讀取queue中的Message並執行,這樣就可以保證以後主線程的所有異常都會從我們手動調用的Looper.loop()
處拋出,一旦拋出就會被try{}catch捕獲,這樣主線程就不會crash了,如果沒有這個while的話那麼主線程下次拋出異常時我們就又捕獲不到了,這樣APP就又crash了,所以我們要通過while讓每次crash發生後都再次進入消息循環,while的作用僅限於每次主線程拋出異常後迫使主線程再次進入消息循環。我們可以用下面的僞代碼來表示:
public class ActivityThread {
public static void main(String[]args){
Queue queue=new Queue();// 可以理解爲一個加鎖的,可以阻塞線程的ArrayList
...
for(;;){//開始死循環,for之後的代碼永遠也得不到執行
Message msg=queue.next();
//如果msg 是我們post的Runnable就會執行如下代碼
//我們post的Runnable中的代碼
while (true) {
try {
for(;;){//所有主線程的異常都會從msg.run()中拋出,所以我們加一個try{}catch來捕獲所有主線程異常,捕獲到後再次強迫進入循環,不斷讀取queue中消息並執行
Message msg=queue.next();
msg.run();
}
} catch (Throwable e) {
}
//否則執行其他邏輯
}
}
爲什麼要通過new Handler.post方式而不是直接在主線程中任意位置執行 while (true) { try { Looper.loop(); } catch (Throwable e) {} }
這是因爲該方法是個死循環,若在主線程中,比如在Activity的onCreate中執行時會導致while後面的代碼得不到執行,activity的生命週期也就不能完整執行,通過Handler.post方式可以保證不影響該條消息中後面的邏輯。
親測,唯不足之處是,在Activity中的生命週期方法裏異常之後,crash到但未能處理Activity,導致假死狀態。
下面貼出code:
Cockroach:
package com.support.framework.crash;
import android.os.Binder;
import android.os.Handler;
import android.os.Looper;
import com.support.BaseApp;
/**
* Created by wanjian on 2017/2/14.
*/
public final class Cockroach {
public interface ExceptionHandler {
void handlerException(Thread thread, Throwable throwable);
}
private Cockroach() {
}
private static ExceptionHandler sExceptionHandler;
private static Thread.UncaughtExceptionHandler sUncaughtExceptionHandler;
private static boolean sInstalled = false;//標記位,避免重複安裝卸載
/**
* 當主線程或子線程拋出異常時會調用exceptionHandler.handlerException(Thread thread, Throwable throwable)
* <p>
* exceptionHandler.handlerException可能運行在非UI線程中。
* <p>
* 若設置了Thread.setDefaultUncaughtExceptionHandler則可能無法捕獲子線程異常。
*
* @param exceptionHandler
*/
public static synchronized void install(ExceptionHandler exceptionHandler) {
if (sInstalled) {
return;
}
sInstalled = true;
sExceptionHandler = exceptionHandler;
new Handler(Looper.getMainLooper()).post(new Runnable() {
@Override
public void run() {
while (true) {
try {
Looper.loop();
} catch (Throwable e) {
// Binder.clearCallingIdentity();
if (e instanceof QuitCockroachException) {
return;
}
if (sExceptionHandler != null) {
//Unable to start activity
sExceptionHandler.handlerException(Looper.getMainLooper().getThread(), e);
// sUncaughtExceptionHandler.uncaughtException(Looper.getMainLooper().getThread(), e);
}
}
}
}
});
sUncaughtExceptionHandler = Thread.getDefaultUncaughtExceptionHandler();
Thread.setDefaultUncaughtExceptionHandler(new Thread.UncaughtExceptionHandler() {
@Override
public void uncaughtException(Thread t, Throwable e) {
if (sExceptionHandler != null) {
sExceptionHandler.handlerException(t, e);
}
}
});
}
public static synchronized void uninstall() {
if (!sInstalled) {
return;
}
sInstalled = false;
sExceptionHandler = null;
//卸載後恢復默認的異常處理邏輯,否則主線程再次拋出異常後將導致ANR,並且無法捕獲到異常位置
Thread.setDefaultUncaughtExceptionHandler(sUncaughtExceptionHandler);
new Handler(Looper.getMainLooper()).post(new Runnable() {
@Override
public void run() {
throw new QuitCockroachException("Quit Cockroach.....");//主線程拋出異常,迫使 while (true) {}結束
}
});
}
}
QuitCockroachException:
package com.support.framework.crash;
/**
* Created by wanjian on 2017/2/15.
*/
final class QuitCockroachException extends RuntimeException {
public QuitCockroachException(String message) {
super(message);
}
}