Skip to content

Latest commit

 

History

History
182 lines (130 loc) · 5.59 KB

README.md

File metadata and controls

182 lines (130 loc) · 5.59 KB
Raw

XTool使用说明

一、功能介绍

🔥 🔥 🔥App错误日志、请求数据、Log信息抓取，同时每次触发错误，通过手机消息列表弹出，增加浮动按钮入口，作为Tool工具总入口。

1、引用资源包

dependencies {
     implementation 'io.github.weishuaidev:xtool:1.4.0'
}

2、初始化流程(可以忽略这一步)

默认工具库已经默认成功初始化，同时设置关闭消息通知栏，如果需要开启通知栏，可以在Application#onCreate() 方法调用XToolReporter.enableNotification()

  • 加载资源库

    XToolReporter.init(getApplication());

  • 设置消息通知栏

    XToolReporter.disableNotification(); 关闭
XToolReporter.enableNotification(); 开启

3、抓取数据入口接入

抓取总共4种数据，分别：Crashes、Exceptions、Http、Log

  1. Crashes数据，工具库自动会抓取，不需要接入
  2. Exceptions数据，在程序中的try{..}catch{..}把错误信息交给XToolReporter.logException(Exception)
    try{

   } catch (e: Exception) {
      //log caught Exception
      XToolReporter.logException(e)
   }
  3. Https数据，在OKHttp拦截器中增加工具库中LoggingInterceptor类
    val client: OkHttpClient = OkHttpClient.Builder()
                .addInterceptor(LoggingInterceptor())
                .build()
  4. Log数据，在需要统计位置直接调用下列方法，使用方法跟系统Log类似
    LoggerUtils.i("info")

LoggerUtils.e("error")

LoggerUtils.d("debug")

LoggerUtils.v("verbose")

LoggerUtils.w("warn")

4、数据查看入口接入

  • 获取悬浮按钮权限，并启动悬浮按钮，通过点击悬浮按钮跳转到ChooseModuleActivity界面。如果不需要悬浮按钮入口，可以直接跳转到ChooseModuleActivity ,也不需要申请权限。

    override fun onCreate(savedInstanceState: Bundle?) {
  View.setOnClickListener {
			//关闭悬浮按钮
            XToolReporter.disableAndzu()
            //申请悬浮按钮权限
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && !Settings.canDrawOverlays(this)) {
                val intent = Intent(
                    Settings.ACTION_MANAGE_OVERLAY_PERMISSION,
                    Uri.parse("package:$packageName")
                )
                startActivityForResult(intent, 1)
            } else {
            	//初始化悬浮按钮
                XToolReporter.initBubbles(SampleApplication.appContext)
            }
        }
}

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        if (requestCode == 1) {
            if (resultCode == RESULT_OK) {
            //初始化悬浮按钮
                XToolReporter.initBubbles(SampleApplication.appContext)
            } 
        } else {
            super.onActivityResult(requestCode, resultCode, data)
        }
    }

  • 资源回收

    override fun onDestroy() {
     super.onDestroy()
     try {
          XToolReporter.recycle()
     } catch (e: Exception) {
          e.printStackTrace()
     }
}

二、参考资料

In-App Android Debugging Tool With Enhanced Logging, Networking Info, Crash reporting And More.

CrashReporter is a handy tool to capture app crashes and save them in a file

赞赏

在开源的同时，解决别人需求，是一件很高兴的事。

赠人玫瑰，手留余香

About me

License

   Copyright 2022 offer

      Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.```