XLog

To persist logs to a file, create a FilePrinter using its Builder and add it during initialization or when creating a Logger.

Key configuration options for FilePrinter.Builder():

• Builder(String path): Specify the full path to the log directory.
• fileNameGenerator(FileNameGenerator): Specify how filenames are generated. Defaults to ChangelessFileNameGenerator("log").
• backupStrategy(BackupStrategy): Specify the backup policy. Defaults to FileSizeBackupStrategy(1024 * 1024).
• cleanStrategy(CleanStrategy): Specify the log cleanup policy. Defaults to NeverCleanStrategy().
• flattener(Flattener): Specify how log elements are flattened into a string. Defaults to DefaultFlattener.

Printer filePrinter = new FilePrinter                      // 打印日志到文件的打印器
    .Builder("<日志目录全路径>")                             // 指定保存日志文件的路径
    .fileNameGenerator(new DateFileNameGenerator())        // 指定日志文件名生成器，默认为 ChangelessFileNameGenerator("log")
    .backupStrategy(new NeverBackupStrategy())             // 指定日志文件备份策略，默认为 FileSizeBackupStrategy(1024 * 1024)
    .cleanStrategy(new FileLastModifiedCleanStrategy(MAX_TIME))     // 指定日志文件清除策略，默认为 NeverCleanStrategy()
    .flattener(new MyFlattener())                          // 指定日志平铺器，默认为 DefaultFlattener
    .build();

// Option 1: Global initialization
XLog.init(config, filePrinter);

// Option 2: Non-global Logger
Logger logger = XLog.printer(filePrinter).build();

// Option 3: One-time print
XLog.printer(filePrinter).d("用一次性配置打印的消息");

LibCat requires the android-aspectjx plugin to intercept android.util.Log calls at the bytecode level. Configure your build.gradle as follows:

1. Apply the android-aspectjx plugin.
2. Set sourceCompatibility and targetCompatibility to JavaVersion.VERSION_1_8.
3. Add the aspectjx classpath to your buildscript dependencies.
4. Configure the aspectjx block. If using Kotlin, you must exclude 'kotlin' to avoid zip file is empty build errors. You can also use exclude or include to specify packages/classes for interception.
5. Add com.elvishew:xlog-libcat:1.0.0 to your dependencies.

apply plugin: 'android-aspectjx'

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

buildscript {
    repositories {
        jcenter()
        google()
    }
    dependencies {
        classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.10'
    }
}

aspectjx {
    // if you use kotlin in your project make sure to exclude `kotlin`,
    // otherwise a build error `zip file is empty` will be thrown
    exclude 'kotlin'

    // add 'exclude' packages/classes that you don't want to intercept the logs from
    exclude 'androidx.appcompat'
    exclude 'android.support'

    // or add 'include' packages/classes that you want to intercept the logs from
}

dependencies {
    implementation 'com.elvishew:xlog-libcat:1.0.0'
}

LibCat requires the android-aspectjx plugin to intercept android.util.Log calls during the compilation phase. During compilation, AspectJ removes calls to android.util.Log and replaces them with LibCat logic.

Important Notes:

• If your project uses Kotlin, ensure you exclude 'kotlin' in the aspectjx configuration to avoid 'zip file is empty' errors.
• You can use exclude to specify packages/classes you do NOT want to intercept (e.g., androidx.appcompat, android.support).
• Alternatively, you can use include to specify only the packages/classes you want to intercept.

apply plugin: 'android-aspectjx'

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

buildscript {
    repositories {
        jcenter()
        google()
    }
    dependencies {
        classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.10'
    }
}

aspectjx {
    // If using Kotlin, exclude it to prevent 'zip file is empty' error
    exclude 'kotlin'

    // Add packages/classes you don't want to intercept
    exclude 'androidx.appcompat'
    exclude 'android.support'

    // OR: Add 'include' for specific packages/classes you want to intercept
}

dependencies {
    implementation 'com.elvishew:xlog-libcat:1.0.0'
}

Use FilePrinter.Builder to save logs to a file with custom strategies:

• .Builder(String path): Specify the directory path.
• .fileNameGenerator(Generator): Custom file name generation (default: ChangelessFileNameGenerator("log")).
• .backupStrategy(Strategy): Strategy for file rotation (default: FileSizeBackupStrategy(1024 * 1024)).
• .cleanStrategy(Strategy): Strategy for cleaning old logs (default: NeverCleanStrategy()).
• .flattener(Flattener): Custom flattener (default: DefaultFlattener).
• .writer(Writer): Custom writer (default: SimpleWriter).

Printer filePrinter = new FilePrinter.Builder("<path-to-logs-dir>")
    .fileNameGenerator(new DateFileNameGenerator())
    .backupStrategy(new NeverBackupStrategy())
    .cleanStrategy(new FileLastModifiedCleanStrategy(MAX_TIME))
    .flattener(new MyFlattener())
    .writer(new MyWriter())
    .build();