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日志使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用CMake构建OpenCV项目过程解析

    使用CMake构建OpenCV项目过程解析

    这篇文章主要介绍了使用CMake构建OpenCV项目过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-11-11
  • Android协程作用域与序列发生器限制介绍梳理

    Android协程作用域与序列发生器限制介绍梳理

    协程的作用是什么?协程是一种轻量级的线程,解决异步编程的复杂性,异步的代码使用协程可以用顺序进行表达,文中通过示例代码介绍详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-08-08
  • Android仿微信5实现滑动导航条

    Android仿微信5实现滑动导航条

    这篇文章主要为大家详细介绍了Android仿微信5实现滑动导航条,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • Android 架构之数据库框架搭建

    Android 架构之数据库框架搭建

    这篇文章主要给大家介绍的是Android 架构之数据库框架搭建,在本篇中,将会让你一点一滴从无到有创建一个不再为数据库而烦恼的框架。需要的朋友可以参考下面文章的具体内容
    2021-09-09
  • Android获取手机号码和运营商信息的方法

    Android获取手机号码和运营商信息的方法

    这篇文章主要介绍了Android获取手机号码和运营商信息的方法,以实例形式完整讲述了获取手机号码和运营商信息的技巧,代码中包含完整的注释说明,需要的朋友可以参考下
    2015-01-01
  • Android开发使用HttpURLConnection进行网络编程详解【附源码下载】

    Android开发使用HttpURLConnection进行网络编程详解【附源码下载】

    这篇文章主要介绍了Android开发使用HttpURLConnection进行网络编程的方法,结合实例形式分析了Android基于HttpURLConnection实现显示图片与文本功能,涉及Android布局、文本解析、数据传输、权限控制等相关操作技巧,需要的朋友可以参考下
    2018-01-01
  • Android使用WebView实现离线阅读功能

    Android使用WebView实现离线阅读功能

    这篇文章主要介绍了Android使用WebView实现离线阅读功能,帮助大家更好的理解和学习使用Android,感兴趣的朋友可以了解下
    2021-04-04
  • android 使用OkHttp上传多张图片的实现代码

    android 使用OkHttp上传多张图片的实现代码

    这篇文章主要介绍了android 使用OkHttp上传多张图片的相关资料,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07
  • Android酷炫动画效果之3D星体旋转效果

    Android酷炫动画效果之3D星体旋转效果

    本文要实现的3D星体旋转效果是从CoverFlow演绎而来,不过CoverFlow只是对图像进行转动,我这里要实现的效果是要对所有的View进行类似旋转木马的转动
    2018-05-05
  • 深入理解Android中View绘制的三大流程

    深入理解Android中View绘制的三大流程

    这篇文章主要给大家介绍了关于Android中View绘制的三大流程,View的工作流程主要是指measure、layout、draw这三大流程,即测量、布局和绘制,文中通过示例代码介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
    2017-07-07

最新评论