Android 输出本地日志文件

36 阅读1分钟

本地文件日志输入,制约大小、时限

java库

dependencies {
  implementation 'org.slf4j:slf4j-api:2.0.7'
  implementation 'com.github.tony19:logback-android:3.0.0'
  testImplementation 'ch.qos.logback:logback-classic:1.2.11'
}

configurations.testImplementation {
  exclude module: 'logback-android'
}

logback.xml配置

文件路径的配置

<!--    可以这样写:具体看权限允许不允许-->
<property name="LOG_DIR" value="/storage/emulated/0/A_log" />
<!--    也可以这样写-->
<property name="LOG_DIR" value="${EXT_DIR:-${DATA_DIR}}/B_Log" />
 

日志级别控制

在logback.xml中修改可以控制日志级别:

  • DEBUG:所有日志(开发环境)

  • INFO:及以上级别(生产环境推荐)

  • WARN:警告及以上

  • ERROR:仅错误

Timber

    dependencies {
      implementation 'com.jakewharton.timber:timber:5.0.1'
    }

一个日志框架,可以转发。搭桥转接更方便使用,如此就不需要在每个类中 LoggerFactory.getLogger()。 节省不少重复代码。

在java中调用kotlin

    /**
 * Slf4jTree是一个Timber的树(Tree)实现,用于将Timber日志输出重定向到SLF4J日志框架。它通过重写DebugTree的log方法,根据日志优先级将日志消息发送到相应的SLF4J日志级别。
 * 避免每次都要在使用类中get.logger()实例
 */
class Slf4jTree : DebugTree() {

    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
       val  logger  = LoggerFactory.getLogger(tag)//timber会自动生成tag,一般是类名
        when (priority) {
            Log.VERBOSE -> logger.trace("{}", message, t)
            Log.DEBUG -> logger.debug("{}", message, t)
            Log.INFO -> logger.info("{}", message, t)
            Log.WARN -> logger.warn("{}", message, t)
            Log.ERROR, Log.ASSERT -> logger.error("{}", message, t)
        }
    }
}
    
object TimberUtils {

    @JvmStatic
    fun configTimber() {
        Timber.plant(Slf4jTree())//如果直接在java类中.plan(DebugTree()),IDE会报错警告,这是兼容问题导致。
    }

}
    
    

初始化,根据打包的类型调整日志级别和输出

public class BaseApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        initLogConfig();
        TimberUtils.configTimber();
    }

    /**
     * 初始化日志配置 - 必须在任何Logger使用前调用
     * logback-android会从assets/logback.xml自动加载配置
     */
    private void initLogConfig() {

        // Release版本:移除logcat输出,设置日志级别为INFO
        if (!BuildConfig.DEBUG) {
            removeLogcatAppender();
        }

        Timber.i("Log config initialized. BuildType: %s, DEBUG: %s ",
                BuildConfig.BUILD_TYPE, BuildConfig.DEBUG);
    }

    /**
     *
     */
    private void removeLogcatAppender() {
        ch.qos.logback.classic.Logger rootLogger =
                (ch.qos.logback.classic.Logger) org.slf4j.LoggerFactory.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
        rootLogger.detachAppender("LOGCAT");//移除logcat appender(用于release环境)
        rootLogger.setLevel(ch.qos.logback.classic.Level.INFO);//设置日志级别为INFO(用于release环境)
    }

}

索引

logback.qos.ch/manual/conf…

github.com/tony19/logb…