Kotlin中日志的使用方法详解

更新时间：2021年03月18日 10:08:31 作者：氷泠

这篇文章主要给大家介绍了关于Kotlin中日志的使用方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

1 引言

想必学过Java的人都知道一个@Slf4j使用得多么的舒服：

@Slf4j
public class TestController{
 @GetMapping("/test")
 public String test(){
  log.debug("debug");  
  return "test";
 }
}

但是很不幸在Kotlin中并没有这种注解，因此，本文给出了一种类似@Slf4j注解在Kotlin中的使用方法，以及介绍一个100%使用Kotlin编写的日志库。

2 动手写@Slf4j

很简单，先上代码：

import org.slf4j.Logger
import org.slf4j.LoggerFactory

@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
annotation class Slf4j{
 companion object{
  val <reified T> T.log: Logger
  inline get() = LoggerFactory.getLogger(T::class.java)
 }
}

逐行解释如下：

@Target：与Java中的@Target类似，注解的目标，这里是类
@Retention：与Java中的@Retention类似，运行时保留
annotation class：声明一个注解
companion object：伴生对象
val <reified T> T.log:Logger：声明一个Logger类型的泛型对象
inline get() = LoggerFactory.getLogger(T::class.java)：声明getter为内联，声明为内联才能使用T，这样才能传递给后面的getLogger，T::class.java相当于Java中的T.class，也就是getLogger(T::class.java)相当于getLogger(SomeClass.class)

使用很简单：

@RestController
@Slf4j
class TestController {
  @GetMapping("/test")
  fun test():String{
    log.warn("cc")
    return "test"
  }
}

直接类上加一个注解，就可以使用log.info/log.warn之类的方法了。

3 kotlin-logging

上面介绍了注解的使用方法，如果不想使用注解的话，可以使用别人的库，比如kotlin-logging。

kotlin-logging是一个100%使用Kotlin编写的轻度封装了slf4j的开源日志库，已经收获1.4k的star：

依赖如下：

<dependency>
  <groupId>io.github.microutils</groupId>
  <artifactId>kotlin-logging-jvm</artifactId>
  <version>2.0.6</version>
</dependency>

Gradle：

implementation 'io.github.microutils:kotlin-logging-jvm:2.0.6'

引入时，只需要在对应的类中创建一个属性即可：

private val logger = KotlinLogging.logger {}

使用时，直接调用其中的info/debug/error等即可：

import mu.KotlinLogging
private val logger = KotlinLogging.logger {} 
class FooWithLogging {
  val message = "world"
  fun bar() {
    logger.debug { "hello $message" }
  }
}

4 两者结合使用

当然，也可以将注解与kotlin-logging结合一下使用，首先，笔者简单地看了一下KotlinLogging的接口：

提供了三个对外的logger方法，参数分别是：

函数
字符串
org.slf4j.Logger

对外没有提供类似getLogger(Class<?> clazz)这样的用类作为参数的方法，因此，需要通过泛型获取到具体类的名字并使用第二种方法构造mu.KLogger：

import mu.KotlinLogging
import org.slf4j.Logger

@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
annotation class Slf4j{
  companion object{
    val <reified T> T.log: Logger
    inline get() = KotlinLogging.logger{T::class.java.name}
  }
}

使用方法同上，直接加一个@Slf4j即可使用。

5 完整Demo参考

6 参考

1、kotlin-logging

2、Kotlin官网-内联函数

到此这篇关于Kotlin中日志使用方法的文章就介绍到这了,更多相关Kotlin日志使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Android LineChart绘制多条曲线的方法
这篇文章主要为大家详细介绍了Android LineChart绘制多条曲线的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-05-05
Android子线程与更新UI问题的深入讲解
首先和其他许多的GUI库一样，Android的UI线程是不安全的。所以下面这篇文章主要给大家介绍了关于Android子线程与更新UI问题的相关资料，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧
2019-03-03
Android PopUpWindow使用详解
PopupWindow与AlertDialog最关键的区别是AlertDialog不能指定显示位置，只能默认显示在屏幕最中间（当然也可以通过设置WindowManager参数来改变位置）。而PopupWindow是可以指定显示位置的，随便哪个位置都可以，更加灵活
2021-10-10
Android 文件选择的实现代码
这篇文章介绍了Android 文件选择的实现代码，有需要的朋友可以参考一下
2013-08-08
Android ViewPager导航小圆点实现无限循环效果
这篇文章主要为大家详细介绍了Android ViewPager导航小圆点实现无限循环效果，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-08-08
故事讲解Activity生命周期（猫的一生）
关于Android中Activity的生命周期，网上大多数文章基本都是直接贴图、翻译API，比较笼统含糊不清。本文主要用故事讲解Activity生命周期。下面跟着小编一起来看下吧
2017-03-03
Android实现数字跳动效果的TextView方法示例
数字跳动效果相信大家应该都见过，在开发加上这种效果后会让ui交互看起来非常不错，所以下面这篇文章主要给大家介绍了Android实现数字跳动的TextView的相关资料，文中给出了详细的示例代码，需要的朋友可以参考学习，下面来一起看看吧。
2017-04-04
Android开发之软键盘用法实例分析
这篇文章主要介绍了Android开发之软键盘用法,实例分析了Android软键盘的实现技巧,需要的朋友可以参考下
2015-05-05
Android如何通过命令行操作Sqlite3数据库的方法
这篇文章主要介绍了Android如何通过命令行操作Sqlite3数据库的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-06-06
Android中颜色选择器和改变字体颜色的实例教程
这篇文章主要介绍了Android中颜色选择器和改变字体颜色的实例教程,其中改变字体颜色用到了ColorPicker颜色选择器,需要的朋友可以参考下
2016-04-04