Android日誌記錄框架

日誌記錄框架

版本 v1.0.0 已完成：業務日誌、通用日誌、錯誤日誌能夠正常使用 待完善：Action日誌當前頁面功能、本地存儲的上傳規則

框架功能簡介

使用

在須要使用的module的gradle中添加：

compile 'com.moment:logconverge:1.0.3-2'
複製代碼

日誌框架入口初始化(在Application的onCreate方法中初始化)： 在Application中添加代理：

LogApplicationProxy.getProxy().onCreate(this);
LogApplicationProxy.getProxy().onTrimMemory(level);
LogApplicationProxy.getProxy().onLowMemory();
LogApplicationProxy.getProxy().onTerminate();
LogApplicationProxy.getProxy().onConfigurationChanged(newConfig);
初始化：
LogConverge.Builder builder = new LogConverge
                .Builder()
                /**
                 * 設置日誌記錄級別，日誌級別分爲(ACTION,EXCEPTION,ALL,NONE)
                 * 通用日誌和業務日誌默認開啓
                 */
                .setLogLevel(LogConverge.ShowLevel.ALL)
                .setChannel(Constant.channel)
                /**
                 * 設置日誌解析格式
                 * JSON
                 * Sting
                 */
                .setParseType(ParseType.JSON)
                /**
                 * 設置日誌打印方式
                 * LOGCAT
                 * Toast
                 */
                .setPrintType(PrintType.LOGGCAT)
                /**
                 * 設置日誌持久化方式
                 * 文件
                 * 數據庫
                 */
                .setCacheType(CacheType.DATABASE);
        //日誌框架初始化入口
        LogConverge.init(builder, this);
複製代碼

Action日誌初始化 在Fragment(須要日誌記錄的頁面，通常爲BaseFragment)中添加代理:

LogProxy.create().onFragmentHiddenChanged(hidden, this.javaClass.simpleName)
LogProxy.create().onFragmentResume()
LogProxy.create().onFragmentPause()

複製代碼

業務日誌使用方法

Map<String,Object> map = new HashMap<String,Object>();
map.put("業務名稱", "業務數據")
LogConverge.create().log(map)
複製代碼

框架詳情解析

業務日誌(BusinessLog)

根據業務需求添日誌記錄. 數據結構：Map<String, Object> 調用方法：LogConverge.log(Map<String, Object> logs)

{
  "businessLog": {
    "name": "moment",
    "gender": "male",
    "age": 17
  }
}
複製代碼

通用日誌(CommonLog)

框架自動記錄，日誌字段分別爲： 設備廠商(devicebrand) 系統版本號(sysversion) 設備惟一標識(uuid) 應用版本(appversion) 應用渠道(channel) 最大分配內存(memorysize)

{
  "appversion": "1.0.0",
  "channel": "xiaomi",
  "deviceBrand": "Xiaomi",
  "memorysize": "256M",
  "sysversion": "7.1.1",
  "uuid": "XXXX-XXXX-XXX-XXX-XXXXXXXX"
}
複製代碼

錯誤日誌(ExceptionLog)

錯誤日誌分爲客戶端異常和網絡異常 客戶端異常由框架自動記錄 網絡異常需用戶調用方法LogConverge.logNetError(String log)方法實現

{
  "error": {
    "clientError": "Attempt to invoke a virtual method on a null object reference case:java.lang.NullPointerException: Attempt to invoke a virtual method on a null object reference"
  }
}
複製代碼

ACTION日誌(ActionLog)

框架自動記錄，日誌字段分別爲：
當前頁面(currentPage)
上一頁面(previousPage)
進入時間(enterTime)
退出時間(exitTime)
前一頁面停留時間(spendTime)
{
  "currentPage": "TestActivity",
  "enterTime": 1516076541468,
  "exitTime": 1516076630131,
  "previousPage": "MainActivity_MainFragment",
  "spendTime": "0h1m28s"
}
複製代碼

新加apk下載管理類

示例：

|- 在Manifest中進行Service註冊

<service android:name="com.moment.logconverge.download.DownloadService" />
複製代碼

|- 註冊fileProvider

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="${applicationId}.provider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths" />
</provider>
複製代碼

在app-src-main-res目錄下建立xml文件夾並添加file_paths.xml文件

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <root-path
        name="root"
        path="" />
    <files-path
        name="files"
        path="" />

    <cache-path
        name="cache"
        path="" />

    <external-path
        name="external"
        path="" />

    <external-files-path
        name="external_file_path"
        path="" />
    <external-cache-path
        name="external_cache_path"
        path="" />
</paths>
複製代碼

|- 初始化及註冊進度回調

//初始化文件下載管理類
FileDownloaderManager.init(context)
// 註冊下載進度監聽，並開啓廣播接收
FileDownloaderManager.registerDownload(object : FileDownloaderManager.DownloadCallback {
            override fun onComplete(file: File) = mainView.downloadSucc(file)

            override fun onFail(msg: String?) = Unit

            override fun onProgress(progress: Int) = mainView.onProgress(progress)

            override fun onPrepare() = Unit

        })
複製代碼

|- 開啓下載

FileDownloaderManager.download(url)
複製代碼

|- 在下載完成後進行資源重置

FileDownloaderManager.unbinder()
複製代碼

apk下載混淆添加

-dontwarn okhttp3.**
-dontwarn okio.**
-dontwarn javax.annotation.**
複製代碼

混淆以下

-keep class com.moment.logconverge.entity.**{*;}

-dontwarn com.moment.logconverge.entity.**

-keep class org.litepal.** {
    *;
}

-keep class * extends org.litepal.crud.DataSupport {
    *;
}
複製代碼

Thanks

JSON解析：fastjson 數據庫存儲：litepal

源碼地址：源碼地址