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

源码地址：源码地址