XLog 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
XLog 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
XLog 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
XLog 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
XLog 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 Apache
开发语言 Java
操作系统 Android
软件类型 开源软件
开发厂商
地区 国产
提 交 者 stenveny123
适用人群 未知
收录时间 2016-01-04

软件简介

简单、美观、强大、可扩展的 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");

类似的库

兼容性

为了兼容 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'。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
暂无内容
发表了博客
2010/12/21 08:34

1,日志组件XLog

这里以日志组件XLog作为开头,不再以专门的概要或者目录说明开始,体现新生命开发团队组件体系的基本思想——追求实用,一切从简! 我写文档资料向来行文自如,没有统一的格式。基本上标题是粗体二号居中,正文是小四,段落首行缩进2字符,行间距1.5倍。我比较喜欢上彩色的代码,因为那样阅读起来非常舒服,有时候干脆直...

0
1
发表了博客
2019/07/13 20:46

win10 mars xlog编译

win10 mars xlog编译 一. 环境准备 安装 cmake 以及 python2.7, 以及下载 ndk-r16b,并配置环境变量 NDK_ROOT 指向 ndk 路径。 如果是 Windows 系统还需要安装 cygwin,并务必要安装其中的 make, gcc gdb。 然后把 cygwin 的 bin 目录配置到环境变量中的 PATH 中 安装cmake https://cmake.org/download/ cmake_install...

0
0
发表于数据库专区
2018/07/15 00:30

PostgreSQL9.x和10.x中xlog的变化

目前PostgreSQL已经出了PG11Beta2版本,细心的朋友可能已经发现,PG9.x及之前版本的xlog做了一些改动,在10以后的版本,xlog改成了wal,官方出于安全性的考虑做出了该改动。 随着这些变化,有一些基于xlog的监控也...

0
1
发表了博客
2020/08/17 14:57

抖音xlog算法最新版解析

前言: 抖音xlog接口用于收集设备环境数据,主要用于检测设备环境是否“合规”,也就是大伙经常听到的过“风控”!xlog接口的body是加密后的设备环境数据,加密通过xlog算法加密。目前抖音APP最新版12.x依然还是用的02算法,此算法抖音官方老长时间没更新了...... “众所周知”: 抖音xlog算法是在native层,无法通过反编...

0
0
发表于大前端专区
2016/12/31 06:04

微信Mars——xlog使用全解析

微信Mars——xlog使用全解析 如约而至,微信在12月19日开源了底层的通信库——Mars,其中有一个部分,是一个高性能的日志模块——xlog。 xlog的详细介绍,大家可以参考微信技术公众号的这篇文章——微信终端跨平台...

0
0
发表于数据库专区
2018/11/28 11:45

PG中XLOG日志结构

概括起来,XLOG日志分为多个XLOG逻辑日志文件,每个逻辑日志文件包含多个XLOG段文件,每个XLOG段文件包含多个XLOG日志页: 每个XLOG逻辑日志文件都有一个ID 即LSN中的逻辑日志文件号 实际XLOG被分为pg_xlog目录下...

0
0
发表了博客
2019/10/12 11:35

关于function pg_switch_xlog() does not exist

pg_switch_xlog() 是9.6版本下的命令,强制手动切换归档日志 postgres=# select version(); version --------------------------------------------------------------------------------------------------------- PostgreSQL 11.5 on x86_64-pc-linux-gnu, compiled by gcc (GCC) 4.4.7 20120313 (Red Hat 4.4.7-18), ...

0
0
发表了博客
2020/05/23 07:04

JDK9的新特性:JVM的xlog

简介 在java程序中,我们通过日志来定位和发现项目中可能出现的问题。在现代java项目中,我们使用log4j或者slf4j,Logback等日志记录框架来处理日志问题。 JVM是java程序运行的基础,JVM中各种事件比如:GC,clas...

1
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
0 评论
97 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部