代码调试、追踪和混淆
文章目录
- 代码调试
- 异常追踪
- 关于异常捕获
- 第一步 定义异常处理Handler
- 第二步 为ui线程添加默认异常事件Handler
- 代码混淆
- 第一步 混淆配置
- 第二步 混淆规则
- 参考资料
代码调试
代码调试在开发中是一个非常常见的一种操作，在Android Studio中有着丰富的调试快捷键，工欲善其事必先利其器，下面就列出来常用的debug快捷键吧
异常追踪
在自己开发测试过程中，如果发现出现crash问题，我们可以查看logcat上面的错误信息，最后得出分析结论，很容易查出问题原因。但是，当 如果线上版本，用户使用过程中出现crash问题，并不是在自己的开发环境出现的错误，难道我们就能视而不见吗？当然不是，我们还可以通过收集这些错误信息，定时上传到我们的服务器上。
接下来的步骤参考任玉刚大佬的《Android程序Crash时的异常上报》，但可能不太一样的是，当时他那篇文章写的时候是2013年，现在是2018快到2019年了，他把异常信息放在SD卡的文件上，但现在Android版本的更新和手机吃的发展，很多手机基本上废弃SD卡了，而且在读写访问的权限上也格外的严格，所以需要注意技术的更新。
关于异常捕获
在Thread类中有以下一个方法
/**
* Sets the default uncaught exception handler. This handler is invoked in
* case any Thread dies due to an unhandled exception.
*
* @param handler
* The handler to set or null.
*/
public static void setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler handler) {
Thread.defaultUncaughtHandler = handler;
}
我们可以通过该方法在application中设置UI线程捕获到异常信息，同样也可以通过该方法在应用闪退前提醒用户，接下来我们就可以通过捕获到的异常信息保存到自己的本地文件，然后上传到自己的服务器上。
第一步 定义异常处理Handler
定义一个专门用户收集错误信息的类，每当发生crash时候，把发生crash异常信息的时间，所用的手机设备信息，和具体错误信息记录下来。
public class CrashHandler implements UncaughtExceptionHandler {
private static final String TAG = "CrashHandler";
private static final boolean DEBUG = true;
private static final String PATH ；// = Environment.getExternalStorageDirectory().getPath() + "/ryg_test/log/";
private static final String FILE_NAME = "crash";
//log文件的后缀名
private static final String FILE_NAME_SUFFIX = ".trace";
private static CrashHandler sInstance = new CrashHandler();
//系统默认的异常处理（默认情况下，系统会终止当前的异常程序）
private UncaughtExceptionHandler mDefaultCrashHandler;
private Context mContext;
//构造方法私有，防止外部构造多个实例，即采用单例模式
private CrashHandler() {
}
public static CrashHandler getInstance() {
return sInstance;
}
//这里主要完成初始化工作
public void init(Context context) {
//获取系统默认的异常处理器
mDefaultCrashHandler = Thread.getDefaultUncaughtExceptionHandler();
//将当前实例设为系统默认的异常处理器
Thread.setDefaultUncaughtExceptionHandler(this);
//获取Context，方便内部使用
mContext = context.getApplicationContext();
}
/**
* 这个是最关键的函数，当程序中有未被捕获的异常，系统将会自动调用#uncaughtException方法
* thread为出现未捕获异常的线程，ex为未捕获的异常，有了这个ex，我们就可以得到异常信息。
*/
@Override
public void uncaughtException(Thread thread, Throwable ex) {
try {
//导出异常信息到SD卡中
dumpExceptionToSDCard(ex);
//这里可以通过网络上传异常信息到服务器，便于开发人员分析日志从而解决bug
uploadExceptionToServer();
} catch (IOException e) {
e.printStackTrace();
}
//打印出当前调用栈信息
ex.printStackTrace();
//如果系统提供了默认的异常处理器，则交给系统去结束我们的程序，否则就由我们自己结束自己
if (mDefaultCrashHandler != null) {
mDefaultCrashHandler.uncaughtException(thread, ex);
} else {
Process.killProcess(Process.myPid());
}
}
private void dumpExceptionToSDCard(Throwable ex) throws IOException {
//判断外部存储是否可用
if (Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()) ) {
PATH = getExternalFilesDir("log").getAbsolutePath();
}else{//没外部存储就使用内部存储
PATH = getFilesDir()+File.separator+"log";
}
File dir = new File(PATH);
if (!dir.exists()) {
dir.mkdirs();
}
long current = System.currentTimeMillis();
String time = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(current));
//以当前时间创建log文件
File file = new File(PATH + FILE_NAME + time + FILE_NAME_SUFFIX);
try {
PrintWriter pw = new PrintWriter(new BufferedWriter(new FileWriter(file)));
//导出发生异常的时间
pw.println(time);
//导出手机信息
dumpPhoneInfo(pw);
pw.println();
//导出异常的调用栈信息
ex.printStackTrace(pw);
pw.close();
} catch (Exception e) {
Log.e(TAG, "dump crash info failed");
}
}
private void dumpPhoneInfo(PrintWriter pw) throws NameNotFoundException {
//应用的版本名称和版本号
PackageManager pm = mContext.getPackageManager();
PackageInfo pi = pm.getPackageInfo(mContext.getPackageName(), PackageManager.GET_ACTIVITIES);
pw.print("App Version: ");
pw.print(pi.versionName);
pw.print('_');
pw.println(pi.versionCode);
//android版本号
pw.print("OS Version: ");
pw.print(Build.VERSION.RELEASE);
pw.print("_");
pw.println(Build.VERSION.SDK_INT);
//手机制造商
pw.print("Vendor: ");
pw.println(Build.MANUFACTURER);
//手机型号
pw.print("Model: ");
pw.println(Build.MODEL);
//cpu架构
pw.print("CPU ABI: ");
pw.println(Build.CPU_ABI);
}
private void uploadExceptionToServer() {
//TODO Upload Exception Message To Your Web Server
}
}
其中需要申请的权限
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.INTERNET"/>
动态申请权限
//权限
private String[] allPermissions = new String[]{Manifest.permission.READ_EXTERNAL_STORAGE,Manifest.permission.WRITE_EXTERNAL_STORAGE};
/**
* 动态申请权限
*/
public void applyPermission(){
if (VERSION.SDK_INT>= 23) {
ActivityCompat.requestPermissions(this,allPermissions,1);
}
}
第二步 为ui线程添加默认异常事件Handler
既然是在主线程中添加异常处理器，那也就是在ui线程中添加异常处理Handler，我们推荐大家在Application中添加而不是在Activity中添加。Application标识着整个应用，在Android声明周期中是第一个启动的，早于任何的Activity、Service等。
public class TestApp extends Application {
private static TestApp sInstance;
@Override
public void onCreate() {
super.onCreate();
sInstance = this;
//在这里为应用设置异常处理程序，然后我们的程序才能捕获未处理的异常
CrashHandler crashHandler = CrashHandler.getInstance();
crashHandler.init(this);
}
public static TestApp getInstance() {
return sInstance;
}
}
其实到这里捕获异常，上传异常就部署完成了，你可以在程序中去抛出一个异常测试一下是否能够捕获异常
代码混淆
我们知道，打包的APK可以通过反编译工具来获得应用的源代码，所以为了防止某些意图不轨的采花大盗对应用进行反编译，利用漏洞进行不法勾当。我们往往会对应用进行代码混淆，这样就算能对应用进行反编译，但得到也是命名无意义的类和变量。增加分析难度。
第一步 混淆配置
混淆是对app/proguard-rules.pro里面进行编写混淆规则，然后在app的build.gradle文件中引用混淆文件
buildTypes {
release {
//打包是否混淆
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'),'proguard-rules.pro'
}
}
第二步 混淆规则
在配置之前，我们需要搞清楚要对哪些代码进行混淆
一般以下情况都会不混淆：
- 使用了自定义控件那么要保证它们不参与混淆
- 使用了枚举要保证枚举不被混淆
- 对第三方库中的类不进行混淆
- 运用了反射的类也不进行混淆
- 使用了 Gson 之类的工具要使 JavaBean 类即实体类不被混淆
- 在引用第三方库的时候，一般会标明库的混淆规则的，建议在使用的时候就把混淆规则添加上去，免得到最后才去找
- 有用到 WebView 的 JS 调用也需要保证写的接口方法不混淆，原因和第一条一样
- Parcelable 的子类和 Creator 静态成员变量不混淆，否则会产生 Android.os.BadParcelableException 异常
1. 实体类
-keep class com.xx.xx.entity.** { *; }
2. 第三方包
#eventBus
-keepattributes *Annotation*
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.** { *; }
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
<init>(java.lang.Throwable);
}
3.反射相关的类和方法
-keep class com.xx.xx.xx.xx.view.** { *; }
-keep class com.xx.xx.xx.xx.xx.** { *; }
4.继承某类不被混淆
避免所有继承Activity的类被混淆
**5.固定模块
#############################################
#
# 对于一些基本指令的添加
#
#############################################
# 代码混淆压缩比，在0~7之间，默认为5，一般不做修改
-optimizationpasses 5
# 混合时不使用大小写混合，混合后的类名为小写
-dontusemixedcaseclassnames
# 指定不去忽略非公共库的类
-dontskipnonpubliclibraryclasses
# 这句话能够使我们的项目混淆后产生映射文件
# 包含有类名->混淆后类名的映射关系
-verbose
# 指定不去忽略非公共库的类成员
-dontskipnonpubliclibraryclassmembers
# 不做预校验，preverify是proguard的四个步骤之一，Android不需要preverify，去掉这一步能够加快混淆速度。
-dontpreverify
# 保留Annotation不混淆
-keepattributes *Annotation*,InnerClasses
# 避免混淆泛型
-keepattributes Signature
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
# 指定混淆是采用的算法，后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法，一般不做更改
-optimizations !code/simplification/cast,!field/*,!class/merging/*
#############################################
#
# Android开发中一些需要保留的公共部分
#
#############################################
# 保留我们使用的四大组件，自定义的Application等等这些类不被混淆
# 因为这些子类都有可能被外部调用
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Appliction
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider
-keep public class * extends android.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference
-keep public class * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
# 保留support下的所有类及其内部类
-keep class android.support.** {*;}
# 保留继承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**
# 保留R下面的资源
-keep class **.R$* {*;}
# 保留本地native方法不被混淆
-keepclasseswithmembernames class * {
native ;
}
# 保留在Activity中的方法参数是view的方法，
# 这样以来我们在layout中写的onClick就不会被影响
-keepclassmembers class * extends android.app.Activity{
public void *(android.view.View);
}
# 保留枚举类不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
# 保留我们自定义控件（继承自View）不被混淆
-keep public class * extends android.view.View{
*** get*();
void set*(***);
public (android.content.Context);
public (android.content.Context, android.util.AttributeSet);
public (android.content.Context, android.util.AttributeSet, int);
}
# 保留Parcelable序列化类不被混淆
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
# 保留Serializable序列化的类不被混淆
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
!static !transient ;
!private ;
!private ;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
# 对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆
-keepclassmembers class * {
void *(**On*Event);
void *(**On*Listener);
}
# webView处理，项目中没有使用到webView忽略即可
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
public *;
}
-keepclassmembers class * extends android.webkit.webViewClient {
public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.webViewClient {
public void *(android.webkit.webView, jav.lang.String);
}
参考资料
Android程序Crash时的异常上报
(通用)Android App代码混淆终极解决方案