美文网首页
升级你的Logger(注解+动态代理)

升级你的Logger(注解+动态代理)

作者: ZuYuan | 来源:发表于2020-12-20 17:19 被阅读0次

前言

基于Android的Log进行了一层简单的封装,以一个demo的形式呈现。

背景

我们在自定义Log的时候,应该考虑到的几点:

  1. 使用方便(我自己觉得只传递msg的Logger用起来是最舒服);
  2. 统一管理,包括日志类型、level、开关;
  3. 自定义方便,使用者只需添加一个注解就完成了一种类型的Logger;

实现

描述: 利用注解描述一个类型的日志,利用动态代理生成一种日志类型。
直接看demo,简单粗暴:

日志等级枚举:

enum class LogLevel(value: Int) {

    NONE(0), DEBUG(1), INFO(2), ERROR(3);

    private val level: Int = value

    fun isLessThan(levelEnum: LogLevel) = this.level < levelEnum.level

    fun isLessThanOrEqual(levelEnum: LogLevel) = this.level <= levelEnum.level
}

普通的日志类,可以实例化之后使用:

class DSLogger(
    var openLog: Boolean = true,
    var logLevel: LogLevel = LogLevel.DEBUG,
    val name: String = "ds"
) {

    init {
        if (logLevel.isLessThanOrEqual(LogLevel.NONE)) {
            openLog = false
        }
    }

    fun debug(msg: String) : DSLogger {
        if (openLog && logLevel.isLessThan(LogLevel.INFO)) {
            Log.d(name, msg)
        }
        return this
    }

    fun debug(tag: String, msg: String) : DSLogger {
        if (openLog && logLevel.isLessThan(LogLevel.INFO)) {
            Log.d("$name-$tag", msg)
        }
        return this
    }

    //我就不全部粘贴出来了,都是一样的

Config注解,描述一种类型的日志:开关、等级、名称(log前缀):

@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class Config(val openLog: Boolean = true,
                        val logLevel: LogLevel = LogLevel.DEBUG,
                        val name: String)

日志接口,利用Config注解添加一种日志类型

interface ILogger {

    @Config(openLog = true, logLevel = LogLevel.DEBUG, name = "def")
    fun default() : DSLogger

    @Config(openLog = true, logLevel = LogLevel.DEBUG, name = "net")
    fun net() : DSLogger

    @Config(openLog = true, logLevel = LogLevel.DEBUG, name = "map")
    fun map() : DSLogger
}

动态代理,Logger的代理类,可以生成和管理所有Logger:

class LoggerManager : InvocationHandler {

    private val loggers = mutableListOf<DSLogger>()

    private val defaultLogger = DSLogger()

    private val methodOfLoggers = mutableMapOf<String, DSLogger>()

    init {
        methodOfLoggers["DiverseShow-Logger"] = defaultLogger
        loggers.add(defaultLogger)
    }

    override fun invoke(proxy: Any?, method: Method, args: Array<out Any>?): Any {
        if (method.returnType != DSLogger::class.java) {
            throw RuntimeException("find ${method.returnType.simpleName} on ${method.name}'s return type, but require BaseLogger.")
        }

        //找到注解,提取注解的value
        val fromMethodName = methodOfLoggers[method.name]
        if (fromMethodName != null) {
            return fromMethodName
        } else {
            var targetAnnotation: Config? = null
            method.annotations.forEach find@ {
                if (it is Config) {
                    targetAnnotation = it
                    return@find
                }
            }
            if (targetAnnotation == null) {
                Log.e("ds", "the ${method.name}() has no annotation which is Config::class ")
                return defaultLogger
            }
            //生成一个新的Logger
            val config = targetAnnotation!!
            val logger = DSLogger(config.openLog, config.logLevel, "ds-${config.name}")
            synchronized(this::class) {
                val checkLogger = methodOfLoggers[method.name]
                if (checkLogger != null) return checkLogger
                methodOfLoggers[method.name] = logger
                loggers.add(logger)
                return logger
            }
        }
    }
}

对上面的那些类封装一层,对外提供日志的能力,DSLog:

object DSLog : ILogger {

    private val loggerManager = LoggerManager()

    private val logger: ILogger = (Proxy.newProxyInstance(DSLogger::class.java.classLoader,
        arrayOf(ILogger::class.java), loggerManager)) as ILogger

    override fun default(): DSLogger = logger.default()

    override fun net(): DSLogger  = logger.net()

    override fun map(): DSLogger = logger.map()

    fun getLoggerManager() = loggerManager
}

使用

//默认日志
DSLog.defalut().debug("hello world!")
DSLog.defalut().debug("myTag","hello world!")
//网络日志
DSLog.net().debug("http failed.")

//关闭所有日志
DSLog.getLoggerManager().closeAllLogger()

demo日志器就做好了,在上面扩展功能也是非常容易的~
欢迎拿去食用~

相关文章

  • 升级你的Logger(注解+动态代理)

    前言 基于Android的Log进行了一层简单的封装,以一个demo的形式呈现。 背景 我们在自定义Log的时候,...

  • Java 代理

    静态代理 动态代理 动态代理, 日志切片使用反射获得方法 动态代理, 自定义注解(对注解的方法,使用动态代理添加切...

  • Java基础:反射

    反射注解动态代理相关阅读 Java基础:类加载器 Java基础:反射 Java基础:注解 Java基础:动态代理 ...

  • retrofir

    注解 + 动态代理+反射+ okhttp

  • web25 动态代理 注解

    注解有特殊功能都是runtime级别的 注解三步:定义,使用,解析 动态代理也可增强,但一般用于拦截 动态代理必须...

  • spring aop 汇总

    静态代理、动态代理和cglib代理 aop 使用 Spring AOP - 注解方式使用介绍spring aop ...

  • 动态代理,注解

    代理模式 什么是代理模式及其作用Proxy Pattern(即:代理模式),23种常用的面向对象软件的设计模式之一...

  • JDK1.8里Method.invoke()的实现原理

    简介 上一篇文章[java注解研究]提到注解最终通过生成动态代理实现类方式来调用,而动态代理实际就是通过反射来调用...

  • 设计模式之代理模式

    设计模式之代理模式 10分钟看懂动态代理设计模式(升级篇)-对这篇动态代理模式的思路整理 仿JDK实现动态代理逻辑...

  • 从注解动态代理理解Retrofit对OkHttp的封装,手写实现

    仅实现Retrofit中的注解和动态代理 大概流程:1.通过动态代理实例化接口2.每调用一个方法都会调用到动态代理...

网友评论

      本文标题:升级你的Logger(注解+动态代理)

      本文链接:https://www.haomeiwen.com/subject/qpeknktx.html