用kotlin打印出漂亮的android日志

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 用kotlin打印出漂亮的android日志

image.png


Kotlin号称是Android版本的swift,距离它1.0正式版本的推出快一年了。它像swift一样,可以写客户端也可以写服务端。由于公司项目比较繁忙,我一直没有时间关注和更进它,只是偶尔花点时间看一下它的语法。


元旦放三天假,可以好好陪家人,也可以自己随便写点东西,于是便有了这篇文章。我尝试用kotlin封装了一个日志组件,用于android项目。


我们先来看下效果图,看看它是如何打印出日志的


image.png


image.png

上面的日志格式是不是很酷?它是用kotlin写出来的哦。


talk is cheap, show me the code!

import android.util.Log
import org.json.JSONArray
import org.json.JSONException
import org.json.JSONObject
/**
 * Created by Tony Shen on 2017/1/2.
 */
object L {
    enum class LogLevel {
        ERROR {
            override val value: Int
                get() = 0
        },
        WARN {
            override val value: Int
                get() = 1
        },
        INFO {
            override val value: Int
                get() = 2
        },
        DEBUG {
            override val value: Int
                get() = 3
        };
        abstract val value: Int
    }
    private var TAG = "SAF_L"
    var logLevel = LogLevel.DEBUG // 日志的等级,可以进行配置,最好在Application中进行全局的配置
    @JvmStatic fun init(clazz: Class<*>) {
        TAG = clazz.simpleName
    }
    /**
     * 支持用户自己传tag,可扩展性更好
     * @param tag
     */
    @JvmStatic fun init(tag: String) {
        TAG = tag
    }
    @JvmStatic fun e(msg: String) {
        if (LogLevel.ERROR.value <= logLevel.value) {
            if (msg.isNotBlank()) {
                val s = getMethodNames()
                Log.e(TAG, String.format(s, msg))
            }
        }
    }
    @JvmStatic fun w(msg: String) {
        if (LogLevel.WARN.value <= logLevel.value) {
            if (msg.isNotBlank()) {
                val s = getMethodNames()
                Log.e(TAG, String.format(s, msg))
            }
        }
    }
    @JvmStatic fun i(msg: String) {
        if (LogLevel.INFO.value <= logLevel.value) {
           if (msg.isNotBlank()) {
               val s = getMethodNames()
               Log.i(TAG, String.format(s,msg))
           }
        }
    }
    @JvmStatic fun d(msg: String) {
        if (LogLevel.DEBUG.value <= logLevel.value) {
            if (msg.isNotBlank()) {
                val s = getMethodNames()
                Log.d(TAG, String.format(s, msg))
            }
        }
    }
    @JvmStatic fun json(json: String) {
        var json = json
        if (json.isBlank()) {
            d("Empty/Null json content")
            return
        }
        try {
            json = json.trim { it <= ' ' }
            if (json.startsWith("{")) {
                val jsonObject = JSONObject(json)
                var message = jsonObject.toString(LoggerPrinter.JSON_INDENT)
                message = message.replace("\n".toRegex(), "\n║ ")
                val s = getMethodNames()
                println(String.format(s, message))
                return
            }
            if (json.startsWith("[")) {
                val jsonArray = JSONArray(json)
                var message = jsonArray.toString(LoggerPrinter.JSON_INDENT)
                message = message.replace("\n".toRegex(), "\n║ ")
                val s = getMethodNames()
                println(String.format(s, message))
                return
            }
            e("Invalid Json")
        } catch (e: JSONException) {
            e("Invalid Json")
        }
    }
    private fun getMethodNames(): String {
        val sElements = Thread.currentThread().stackTrace
        var stackOffset = LoggerPrinter.getStackOffset(sElements)
        stackOffset++
        val builder = StringBuilder()
        builder.append(LoggerPrinter.TOP_BORDER).append("\r\n")
                // 添加当前线程名
                .append("║ " + "Thread: " + Thread.currentThread().name).append("\r\n")
                .append(LoggerPrinter.MIDDLE_BORDER).append("\r\n")
                // 添加类名、方法名、行数
                .append("║ ")
                .append(sElements[stackOffset].className)
                .append(".")
                .append(sElements[stackOffset].methodName)
                .append(" ")
                .append(" (")
                .append(sElements[stackOffset].fileName)
                .append(":")
                .append(sElements[stackOffset].lineNumber)
                .append(")")
                .append("\r\n")
                .append(LoggerPrinter.MIDDLE_BORDER).append("\r\n")
                // 添加打印的日志信息
                .append("║ ").append("%s").append("\r\n")
                .append(LoggerPrinter.BOTTOM_BORDER).append("\r\n")
        return builder.toString()
    }
    fun String.isBlank(msg:String):Boolean {
        return msg==null || msg.length==0;
    }
    fun String.isNotBlank(msg:String):Boolean {
        return !msg.isBlank();
    }
}


这里,对kotlin的语法不做特别详细的解释,就解释一下@JvmStatic和最后两个方法。


kotlin中在方法名前标注@JvmStatic,就表示该方法是静态的。


例如:

@JvmStatic fun i(msg: String)


相当于java的

public static void i(String msg)


最后两个方法,就更加厉害了,使用了kotlin的extension function的特性。(即扩展类的函数, 可以在已有类中添加新的方法, 比继承更加简洁和优雅。)这个特性跟Objective-C的Category很类似。

fun String.isBlank(msg:String):Boolean {
        return msg==null || msg.length==0;
    }
    fun String.isNotBlank(msg:String):Boolean {
        return !msg.isBlank();
    }


他们扩展了String类,在String类中增加两个函数isBlank()、isNotBlank()。


使用方法:

msg.isNotBlank()


如果对这两个扩展类感兴趣,可以看看kotlin bytecode:


image.png


对了,还漏了一个LoggerPrinter类。同样附上源码:

/**
 * Created by Tony Shen on 2017/1/2.
 */
object LoggerPrinter {
    private val MIN_STACK_OFFSET = 3
    /**
     * Drawing toolbox
     */
    private val TOP_LEFT_CORNER = '╔'
    private val BOTTOM_LEFT_CORNER = '╚'
    private val MIDDLE_CORNER = '╟'
    private val HORIZONTAL_DOUBLE_LINE = '║'
    private val DOUBLE_DIVIDER = "════════════════════════════════════════════"
    private val SINGLE_DIVIDER = "────────────────────────────────────────────"
    val TOP_BORDER = TOP_LEFT_CORNER + DOUBLE_DIVIDER + DOUBLE_DIVIDER
    val BOTTOM_BORDER = BOTTOM_LEFT_CORNER + DOUBLE_DIVIDER + DOUBLE_DIVIDER
    val MIDDLE_BORDER = MIDDLE_CORNER + SINGLE_DIVIDER + SINGLE_DIVIDER
    /**
     * It is used for json pretty print
     */
    val JSON_INDENT = 2
    fun getStackOffset(trace: Array<StackTraceElement>): Int {
        var i = MIN_STACK_OFFSET
        while (i < trace.size) {
            val e = trace[i]
            val name = e.className
            if (name != LoggerPrinter::class.java.name && name != L::class.java.name) {
                return --i
            }
            i++
        }
        return -1
    }
}


这个日志组件就这么两个类,支持跟java混编。


举个栗子吧:

import android.app.Activity
import android.content.Intent
import android.os.Bundle
import android.widget.Button
import cn.kotlintest.saf.log.L
import org.jetbrains.anko.find
/**
 * Created by Tony Shen on 2016/12/28.
 */
class MainActivity : Activity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.main_activity)
        L.init(this.javaClass)
        initViews()
        initData()
    }
    fun initViews():Unit{
        val button = find<Button>(R.id.button)
        button.setOnClickListener({ view ->
            var intent =  Intent(this,SecondActivity::class.java)
            startActivity(intent)
        })
    }
    fun initData():Unit{
        var s = "{\"firstName\":\"Brett\",\"lastName\":\"McLaughlin\",\"email\":\"aaaa\"}"
        L.json(s)
    }
}


在initData()中会打印一个json字符串,其运行效果已在最开始的图中。


再举一个跟java混编的例子吧

import android.app.Activity;
import android.os.Bundle;
import cn.kotlintest.saf.log.L;
/**
 * Created by Tony Shen on 2017/1/3.
 */
public class SecondActivity extends Activity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        L.init(this.getClass());
        L.i("this is second activity");
    }
}


image.png


写在最后



kotlin是开发android不错的选择,虽然我不会很激进地完全使用kotlin来替换原先的java代码,但是一些常用的工具类可能会有它来写,或者用它来逐步替换原先的工具类。


这个日志组件要是看得不过瘾,可以看看我写的Android框架SAF里包含的日志组件,功能更加丰富。


已经发布到github:


https://github.com/fengzhizi715/SAF-Kotlin-log

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
4月前
|
Android开发 Kotlin
Android经典面试题之Kotlin的==和===有什么区别?
本文介绍了 Kotlin 中 `==` 和 `===` 操作符的区别:`==` 用于比较值是否相等,而 `===` 用于检查对象身份。对于基本类型,两者行为相似;对于对象引用,`==` 比较值相等性,`===` 检查引用是否指向同一实例。此外,还列举了其他常用比较操作符及其应用场景。
200 93
|
2月前
|
前端开发 数据处理 Android开发
Flutter前端开发中的调试技巧与工具使用方法,涵盖调试的重要性、基本技巧如打印日志与断点调试、常用调试工具如Android Studio/VS Code调试器和Flutter Inspector的介绍
本文深入探讨了Flutter前端开发中的调试技巧与工具使用方法,涵盖调试的重要性、基本技巧如打印日志与断点调试、常用调试工具如Android Studio/VS Code调试器和Flutter Inspector的介绍,以及具体操作步骤、常见问题解决、高级调试技巧、团队协作中的调试应用和未来发展趋势,旨在帮助开发者提高调试效率,提升应用质量。
63 8
|
3月前
|
存储 Java Android开发
Android|记一个导致 logback 无法输出日志的问题
在给一个 Android 项目添加 logback 日志框架时,遇到一个导致无法正常输出日志的问题,这里记录一下。
52 2
|
3月前
|
Java 程序员 API
Android|集成 slf4j + logback 作为日志框架
做个简单改造,统一 Android APP 和 Java 后端项目打印日志的体验。
155 1
|
3月前
|
存储 前端开发 测试技术
Android kotlin MVVM 架构简单示例入门
Android kotlin MVVM 架构简单示例入门
49 1
|
3月前
|
调度 Android开发 开发者
构建高效Android应用:探究Kotlin多线程优化策略
【10月更文挑战第11天】本文探讨了如何在Kotlin中实现高效的多线程方案,特别是在Android应用开发中。通过介绍Kotlin协程的基础知识、异步数据加载的实际案例,以及合理使用不同调度器的方法,帮助开发者提升应用性能和用户体验。
77 4
|
3月前
|
JSON 调度 数据库
Android面试之5个Kotlin深度面试题:协程、密封类和高阶函数
本文首发于公众号“AntDream”,欢迎微信搜索“AntDream”或扫描文章底部二维码关注,和我一起每天进步一点点。文章详细解析了Kotlin中的协程、扩展函数、高阶函数、密封类及`inline`和`reified`关键字在Android开发中的应用,帮助读者更好地理解和使用这些特性。
47 1
|
3月前
|
Android开发 Kotlin
Android面试题之Kotlin中如何实现串行和并行任务?
本文介绍了 Kotlin 中 `async` 和 `await` 在并发编程中的应用,包括并行与串行任务的处理方法。并通过示例代码展示了如何启动并收集异步任务的结果。
44 0
|
3月前
|
Java 调度 Android开发
Android面试题之Kotlin中async 和 await实现并发的原理和面试总结
本文首发于公众号“AntDream”,详细解析了Kotlin协程中`async`与`await`的原理及其非阻塞特性,并提供了相关面试题及答案。协程作为轻量级线程,由Kotlin运行时库管理,`async`用于启动协程并返回`Deferred`对象,`await`则用于等待该对象完成并获取结果。文章还探讨了协程与传统线程的区别,并展示了如何取消协程任务及正确释放资源。
56 0
|
8月前
|
传感器 Android开发 开发者
构建高效Android应用:Kotlin的协程与Flow
【4月更文挑战第26天】随着移动应用开发的不断进步,开发者寻求更简洁高效的编码方式以应对复杂多变的业务需求。在众多技术方案中,Kotlin语言凭借其简洁性和强大的功能库逐渐成为Android开发的主流选择。特别是Kotlin的协程和Flow这两个特性,它们为处理异步任务和数据流提供了强大而灵活的工具。本文将深入探讨如何通过Kotlin协程和Flow来优化Android应用性能,实现更加流畅的用户体验,并展示在实际开发中的应用实例。