Android 捕获错误日志（下篇）

2021-11-29 04:27:49

前提

昨天写了捕获错误日志的文章，但是没有写上传到服务器的部分，今天就针对上传服务器的部分进行编写和分析，如果没有观看的请先移步到上篇Android 捕获错误日志（上篇）。

在写之前我们首先分析一下，我们首先分析一下昨天写的东西，我们在crash类里面当崩溃的时候再上传到服务器这个显然是不正确的。因为当程序已经崩溃了，写到本地之后就会直接退出，如下面的代码所示，不可能再进行上传文件的耗时操作了。那么我们该怎么来解决呢？我这里有两种方法，第一种就是把文件名保存在SharedPreferences里面，当第二次进入的时候直接上传（已经实现），还有一种方法是发送一个广播或者用EventBus传递出去然后直接上传（未实现，感兴趣的可以自己实现，也是很方便）。

  @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());
}

 }

首先

先上图，no pic say a xx


Android 捕获错误日志（下篇）
客户端文件上传成功.png
Android 捕获错误日志（下篇）
文件上传后台.png
Android 捕获错误日志（下篇）
服务器保存文件.png

分析：文件上传的时候，客户端有两种方式一种是HttpClient当然这种现在已经不用了，还有一种是用现在大家都知道的RxJava+Retrofit封装的方式进行上传的，我们客户端用第二种方式。服务器使用servlet的方式进行接收。

  • 客户端需要引入的库

     //RxAndroid
implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'
 //RxJava2
implementation 'io.reactivex.rxjava2:rxjava:2.1.8'
//Retrofit2的RxJava适配
implementation 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0'
//Retrofit2
implementation 'com.squareup.retrofit2:retrofit:2.3.0'
//RxJava2Gson适配
implementation 'com.squareup.retrofit2:converter-gson:2.3.0'
//网络日志拦截
implementation 'com.squareup.okhttp3:logging-interceptor:3.8.1'

其次

图片看完之后咱们来看看实现方法

  • CrashHandler（修改一番）

    public class CrashHandler implements UncaughtExceptionHandler {

private static final String TAG = "CrashHandler";
private static final boolean DEBUG = true;

private static final String FILE_NAME = "crash";

// log文件的后缀名
private static final String FILE_NAME_SUFFIX = ".txt";

private static CrashHandler sInstance = new CrashHandler();

// 系统默认的异常处理（默认情况下，系统会终止当前的异常程序）
private UncaughtExceptionHandler mDefaultCrashHandler;

private Context mContext;
//log路径
private  String mLogPath=null;
private String fileName="";


// 构造方法私有，防止外部构造多个实例，即采用单例模式
private CrashHandler() {
}

public static CrashHandler getInstance() {
  return sInstance;
}

// 这里主要完成初始化工作
public void init(Context context,String logPath) {
  // 获取系统默认的异常处理器
  mDefaultCrashHandler = Thread.getDefaultUncaughtExceptionHandler();
  // 将当前实例设为系统默认的异常处理器
  Thread.setDefaultUncaughtExceptionHandler(this);
  // 获取Context，方便内部使用
  mContext = context.getApplicationContext();
  this.mLogPath=logPath;
}

/**
 * 这个是最关键的函数，当程序中有未被捕获的异常，系统将会自动调用#uncaughtException方法
 * thread为出现未捕获异常的线程，ex为未捕获的异常，有了这个ex，我们就可以得到异常信息。
 */
@Override
public void uncaughtException(Thread thread, Throwable ex) {
  try {
      // 导出异常信息到SD卡中
      dumpExceptionToSDCard(ex);
      // 这里可以通过网络上传异常信息到服务器，便于开发人员分析日志从而解决bug（有问题舍弃掉）
 //   if (!TextUtils.isEmpty(fileName)){
//        uploadExceptionToServer(new File(fileName));
//    }
  } catch (IOException e) {
      e.printStackTrace();
  }

  // 打印出当前调用栈信息
  ex.printStackTrace();

  // 如果系统提供了默认的异常处理器，则交给系统去结束我们的程序，否则就由我们自己结束自己
  if (mDefaultCrashHandler != null) {
      mDefaultCrashHandler.uncaughtException(thread, ex);
  } else {
      Process.killProcess(Process.myPid());
  }

}

/**
 * 写入SD卡
 * 
 * @param ex
 * @throws IOException
 */
@SuppressLint("SimpleDateFormat")
private void dumpExceptionToSDCard(Throwable ex) throws IOException {
  // 如果SD卡不存在或无法使用，则无法把异常信息写入SD卡
  if (!Environment.getExternalStorageState().equals(
          Environment.MEDIA_MOUNTED)) {
      if (DEBUG) {
          Log.e(TAG, "sdcard unmounted,skip dump exception");
          return;
      }
  }

  File dir = new File(mLogPath);
  if (!dir.exists()) {
      dir.mkdirs();
  }
  long current = System.currentTimeMillis();
  String time = new SimpleDateFormat("yyyyMMddHHmmss")
          .format(new Date(current));
  fileName=mLogPath + FILE_NAME + time + FILE_NAME_SUFFIX;
  PreferencesUtils.putString(mContext,CRASH_FILE_NAME,fileName);
  // 以当前时间创建log文件
  File file = new File(fileName);

  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(File file) {
  
}


}

分析： 这里主要用的是SharedPreferences保存报错的文件路径名，然后第二次进入的时候直接上传

  • CrashActivity

    public class CrashActivity extends AppCompatActivity {


Button mBtnCrash;
private ProgressDialog dialog;

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.activity_second);
  mBtnCrash=findViewById(R.id.btn_crash);
  mBtnCrash.setOnClickListener(new View.OnClickListener() {
      @Override
      public void onClick(View v) {
          throw new RuntimeException(toUtf8("出现异常了"));
      }
  });

  dialog = new ProgressDialog(CrashActivity.this);
  dialog.setMax(100);
  dialog.setProgressStyle(ProgressDialog.STYLE_HORIZONTAL);
  dialog.setMessage("上传文件中");

  if (!TextUtils.isEmpty(PreferencesUtils.getString(this,CRASH_FILE_NAME))){
      upload(new File(PreferencesUtils.getString(this,CRASH_FILE_NAME)));
  }
 }

public static String toUtf8(String str) {
  String result = null;
  try {
      result = new String(str.getBytes("UTF-8"), "UTF-8");
  } catch (UnsupportedEncodingException e) {
      e.printStackTrace();
  }
  return result;
}

/**
 * 封装后的单文件上传方法
 */
  public void upload(File file) {
  dialog.show();
  Log.e("File",file.getAbsolutePath());
  RetrofitClient
          .getInstance()
          .upLoadFile(URL, file, new FileUploadObserver<ResponseBody>() {
              @Override
              public void onUpLoadSuccess(ResponseBody responseBody) {
                  Toast.makeText(CrashActivity.this, "上传成功", Toast.LENGTH_SHORT).show();
                  try {
                      Log.e("上传进度",responseBody.string());
                  } catch (IOException e) {
                      e.printStackTrace();
                  }
                  dialog.dismiss();
              }

              @Override
              public void onUpLoadFail(Throwable e) {
                  Toast.makeText(CrashActivity.this, "上传失败"+e.getMessage(), Toast.LENGTH_SHORT).show();
                  dialog.dismiss();
              }
              @Override
              public void onProgress(int progress) {
                  dialog.setProgress(progress);
              }
          });
}

@Override
protected void onStop() {
  super.onStop();
  if (!TextUtils.isEmpty(PreferencesUtils.getString(this,CRASH_FILE_NAME))){
      PreferencesUtils.remove(this,CRASH_FILE_NAME);
  }
}
}

分析： 我们这里的变化是上传文件和保存文件名，并且在onStop的时候清除了一次保存的key。试想一下，如果第一次崩溃的时候是会把我们所需要的文件名保存到SharedPreferences中，那么第二次进入的时候就会直接上传。但是，当我们第三次第四次进入的时候还需要上传吗？当然是不需要了，不仅造成服务器压力，也不太优雅，所以要清除SharedPreferences中的键值对。

最后

再啰嗦一句：做任何事情的时候应该全方面考虑，如果各位同仁有更好的建议的话，请告诉我。正所谓：三人行必有我师。
代码已经上传到码云
后台代码

上一篇：安全的Web主机iptables防火墙脚本


下一篇：Android 动画初探