安卓 本地文件log日志打印，方便记录运行中出现的错误，供开发者查找问题

Posted 2022-12-06 mjsoftwareking

项目地址 已发布jitpack仓库

一、概要

1. 这是一个基于EventBus的本地文件日志打印系统。
2. 日志打印过程使用子线程处理，不会阻塞主线程。
3. 每次需要打印时都会检查文件夹是否存在，因此软件运行时，删除打印目录后会重建而不会发生异常

二、工程引入工具包准备

android 
     repositories 
        flatDir 
            dirs 'libs'
        
    
    ...



引入日志打印aar

dependencies 
   implementation(name: 'localloglib', ext: 'aar')
   //eventbus，引入后你的项目将支持EventBus，EventBus是一种用于Android的事件发布-订阅总线，替代广播的传值方式，使用方法可以度娘查询。
   implementation 'org.greenrobot:eventbus:3.1.1'
   ...

三、日志系统初始化

1. manifest 文件添加权限，更多信息，可参考仓库内的APP使用

   <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

2. 参照项目示例获取权限后进行初始化

private void initPermissions() 
        CompositeDisposable disposable = new CompositeDisposable();
        new RxPermissions(this).request(
                Manifest.permission.WRITE_EXTERNAL_STORAGE,
                Manifest.permission.READ_EXTERNAL_STORAGE)
                //io 线程运行
                .subscribeOn(Schedulers.io())
                //主线程返回
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Observer<Boolean>() 
                    @Override
                    public void onSubscribe(@Nullable Disposable d) 
                        disposable.add(d);
                    

                    @Override
                    public void onNext(@Nullable Boolean aBoolean) 
                        if (aBoolean) 
                            // 初始化日志系统，不可主动调用 printf 方法
                            //初始化参数为日志文件所在文件夹，不可为空
                            LocalLogSystem.init(FolderUtil.getSDRoot() + "AppLocalLogTest")
                                    //日志文件内容的编码，默认 utf-8
                                    .setCharset(Charset.forName("UTF-8"))
                                    //日志文件名成前缀，默认“Log”
                                    .setFileName("App")
                                    //日志文件后缀按时间生成日志文件，此列为每小时一份，目前提供按年、按月、按日、按小时以及不区分全部放入一个文件5种文件分隔
                                    .setLogTimeSection(LogTimeSectionEnum.YYYY_MM_DD_HH)
                                    //完成初始化，并成为观察者，此时才会接收日志打印事件
                                    .complete();
                         else 
                            //未授权
                        
                    

                    @Override
                    public void onError(@Nullable Throwable e) 
                        disposable.dispose();
                    

                    @Override
                    public void onComplete() 
                        disposable.dispose();
                    
                );
    

四、日志系统的储存使用

1. 在需要保存日志的位置添加


EventBus.getDefault().post(new LogCommonEvent("这是一个普通级别日志"));

2. 目前系统提供一下级别日志文件

            Random random = new Random();
            int r = random.nextInt(10000);
            //第一种方案
            try 
                EventBus.getDefault().post(new LogCommonEvent("这是一个普通级别日志: " + r));
                EventBus.getDefault().post(new LogCustomEvent("自定义", "这是一个自定义级别日志: " + r));
                EventBus.getDefault().post(new LogDebugEvent("这是一个Debug级别日志: " + r));
                EventBus.getDefault().post(new LogInfoEvent("这是一个Info级别日志: " + r));
                EventBus.getDefault().post(new LogRuntimeEvent("这是一个Runtime级别日志: " + r));

                throw new RuntimeException("这是一个测试异常");
             catch (Exception e) 
                EventBus.getDefault().post(new LogExceptionEvent("这是一个Exception级别日志: " + r, e));
            

            //第二种方案， 推荐方案
            try 
                LocalLogPrintUtils.commonPrintf("这是一个普通级别日志: " + r);
                LocalLogPrintUtils.customPrintf("自定义", "这是一个自定义级别日志: " + r);
                LocalLogPrintUtils.debugPrintf("这是一个Debug级别日志: " + r);
                LocalLogPrintUtils.infoPrintf("这是一个Info级别日志: " + r);
                LocalLogPrintUtils.runtimePrintf("这是一个Runtime级别日志: " + r);

                throw new RuntimeException("这是一个测试异常");
             catch (Exception e) 
                LocalLogPrintUtils.exceptionPrintf("这是一个Exception级别日志: " + r, e);