XLog

简单、美观、强大、可扩展的 Android 和 Java 日志库，可同时在多个通道打印日志，如 Logcat、Console 和文件。如果你愿意，甚至可以打印到远程服务器（或其他任何地方）。

XLog 能干什么:

• 全局配置（TAG，各种格式化器...）或基于单条日志的配置
• 支持打印任意对象以及可自定义的对象格式化器
• 支持打印数组
• 支持打印无限长的日志（没有 4K 字符的限制）
• XML 和 JSON 格式化输出
• 线程信息（线程名等，可自定义）
• 调用栈信息（可配置的调用栈深度，调用栈信息包括类名、方法名文件名和行号）
• 支持日志拦截器
• 保存日志文件（文件名和自动备份策略可灵活配置）
• 在 Android Studio 中的日志样式美观
• 简单易用，扩展性高

与其他日志库的不同:

• 优美的源代码，良好的文档
• 扩展性高，可轻松扩展和强化功能
• 轻量级，零依赖

依赖

compile 'com.elvishew:xlog:1.6.1'

预览

• 带线程信息、调用栈信息和边框的日志 
• 格式化后的网络 API 请求 
• 格式化后的网络 API 响应 
• 日志文件 
  

架构

用法

初始化

简单方式

XLog.init(LogLevel.ALL);

或者如果你想要在正式版中禁止打日志

XLog.init(BuildConfig.DEBUG ? LogLevel.ALL : LogLevel.NONE);

高级方式

LogConfiguration config = new LogConfiguration.Builder()
    .logLevel(BuildConfig.DEBUG ? LogLevel.ALL             // 指定日志级别，低于该级别的日志将不会被打印，默认为 LogLevel.ALL
        : LogLevel.NONE)
    .tag("MY_TAG")                                         // 指定 TAG，默认为 "X-LOG"
    .t()                                                   // 允许打印线程信息，默认禁止
    .st(2)                                                 // 允许打印深度为2的调用栈信息，默认禁止
    .b()                                                   // 允许打印日志边框，默认禁止
    .jsonFormatter(new MyJsonFormatter())                  // 指定 JSON 格式化器，默认为 DefaultJsonFormatter
    .xmlFormatter(new MyXmlFormatter())                    // 指定 XML 格式化器，默认为 DefaultXmlFormatter
    .throwableFormatter(new MyThrowableFormatter())        // 指定可抛出异常格式化器，默认为 DefaultThrowableFormatter
    .threadFormatter(new MyThreadFormatter())              // 指定线程信息格式化器，默认为 DefaultThreadFormatter
    .stackTraceFormatter(new MyStackTraceFormatter())      // 指定调用栈信息格式化器，默认为 DefaultStackTraceFormatter
    .borderFormatter(new MyBoardFormatter())               // 指定边框格式化器，默认为 DefaultBorderFormatter
    .addObjectFormatter(AnyClass.class,                    // 为指定类添加格式化器
        new AnyClassObjectFormatter())                     // 默认使用 Object.toString()
    .addInterceptor(new BlacklistTagsFilterInterceptor(    // 添加黑名单 TAG 过滤器
        "blacklist1", "blacklist2", "blacklist3"))
    .addInterceptor(new MyInterceptor())                   // 添加一个日志拦截器
    .build();

Printer androidPrinter = new AndroidPrinter();             // 通过 android.util.Log 打印日志的打印器
Printer consolePrinter = new ConsolePrinter();             // 通过 System.out 打印日志到控制台的打印器
Printer filePrinter = new FilePrinter                      // 打印日志到文件的打印器
    .Builder("/sdcard/xlog/")                              // 指定保存日志文件的路径
    .fileNameGenerator(new DateFileNameGenerator())        // 指定日志文件名生成器，默认为 ChangelessFileNameGenerator("log")
    .backupStrategy(new NeverBackupStrategy()              // 指定日志文件备份策略，默认为 FileSizeBackupStrategy(1024 * 1024)
    .cleanStrategy(new FileLastModifiedCleanStrategy(MAX_TIME))     // 指定日志文件清除策略，默认为 NeverCleanStrategy()
    .flattener(new MyFlattener())                          // 指定日志平铺器，默认为 DefaultFlattener
    .build();

XLog.init(                                                 // 初始化 XLog
    config,                                                // 指定日志配置，如果不指定，会默认使用 new LogConfiguration.Builder().build()
    androidPrinter,                                        // 添加任意多的打印器。如果没有添加任何打印器，会默认使用 AndroidPrinter(Android)/ConsolePrinter(java)
    consolePrinter,
    filePrinter);

对于 android，做初始化的最佳地方是 Application.onCreate()。

全局用法

XLog.d("Simple message")
XLog.d("My name is %s", "Elvis");
XLog.d("An exception caught", exception);
XLog.d(object);
XLog.d(array);
XLog.json(unformattedJsonString);
XLog.xml(unformattedXmlString);
... // 其他全局使用

局部用法

创建一个 Logger。

Logger partial = XLog.tag("PARTIAL-LOG")
    ... // 其他配置
    .build();

然后对该 Logger 进行局部范围的使用，所有打印日志的相关方法都跟 XLog 类里的一模一样。

partial.d("Simple message 1");
partial.d("Simple message 2");
... // 其他局部使用

基于单条日志的用法

进行基于单条日志的配置，然后就可以直接打印日志了，所有打印日志的相关方法都跟 XLog 类里的一模一样。

XLog.t()    // 允许打印线程信息
    .st(3)  // 允许打印深度为3的调用栈信息
    .b()    // 允许打印日志边框
    ...     // 其他配置
    .d("Simple message 1");

XLog.tag("TEMP-TAG")
    .st(0)  // 允许打印不限深度的调用栈信息
    ...     // 其他配置
    .d("Simple message 2");

XLog.nt()   // 禁止打印线程信息
    .nst()  // 禁止打印调用栈信息
    .d("Simple message 3");

XLog.b().d("Simple message 4");

比较

让我们设想有一个 JSON 字符串和一个 XML 字符串：

String jsonString = "{\"name\": \"Elvis\", \"age\": 18}";
String xmlString = "<team><member name="Elvis"/><member name="Leon"/></team>";

Android Log

Log.d(TAG, "Message");
Log.d(TAG, String.format("Message with argument: age=%s", 18));
Log.d(TAG, jsonString);
Log.d(TAG, xmlString);
Log.d(TAG, "Message with stack trace info", new Throwable());

XLog

XLog.init(LogLevel.ALL);
XLog.d("Message");
XLog.d("Message with argument: age=%s", 18);
XLog.json(jsonString);
XLog.xml(xmlString);
XLog.st(5).d("Message with stack trace info");

带边框的 XLog

XLog.init(LogLevel.ALL, new LogConfiguration.Builder().b().build());
XLog.d("Message");
XLog.d("Message with argument: age=%s", 18);
XLog.json(jsonString);
XLog.xml(xmlString);
XLog.st(5).d("Message with stack trace info");

类似的库

• logger
• KLog

兼容性

为了兼容 Android Log，XLog 支持 Android Log 里的所有方法。 请看 XLog 里的 Log 类。

Log.v(String, String);
Log.v(String, String, Throwable);
Log.d(String, String);
Log.d(String, String, Throwable);
Log.i(String, String);
Log.i(String, String, Throwable);
Log.w(String, String);
Log.w(String, String, Throwable);
Log.wtf(String, String);
Log.wtf(String, String, Throwable);
Log.e(String, String);
Log.e(String, String, Throwable);
Log.println(int, String, String);
Log.isLoggable(String, int);
Log.getStackTraceString(Throwable);

迁移

如果你有一个大工程正在用 Android Log，并且很难将所有对 Android Log 的使用都换成 XLog，那么你可以使用兼容 API，简单地将所有 'android.util.Log' 替换成 'com.elvishew.xlog.XLog.Log'. (为了更好的性能，尽量不要使用兼容 API)

Linux/Cygwin:

grep -rl "android.util.Log" <your-source-directory> | xargs sed -i "s/android.util.Log/com.elvishew.xlog.XLog.Log/g"

Mac

grep -rl "android.util.Log" <your-source-directory> | xargs sed -i "" "s/android.util.Log/com.elvishew.xlog.XLog.Log/g"

Android Studio

在 'Project' 窗口里，切换到 'Project Files' 标签，然后右键点击你的源码目录。 在出现的菜单里，点击 'Replace in Path...' 选项。 在弹出的对话框里，'Text to find' 区域填上 'android.util.Log'，'Replace with' 区域填个 'com.elvishew.xlog.XLog.Log'，然后点击 'Find'。