前言

基于Android的Log進行了一層簡單的封裝，以一個demo的形式呈現(xiàn)。

背景

我們在自定義Log的時候，應(yīng)該考慮到的幾點：

1. 使用方便（我自己覺得只傳遞msg的Logger用起來是最舒服）；
2. 統(tǒng)一管理，包括日志類型、level、開關(guān)；
3. 自定義方便，使用者只需添加一個注解就完成了一種類型的Logger；

實現(xiàn)

描述： 利用注解描述一個類型的日志，利用動態(tài)代理生成一種日志類型。
直接看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注解，描述一種類型的日志：開關(guān)、等級、名稱（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
}

動態(tài)代理，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!")
//網(wǎng)絡(luò)日志
DSLog.net().debug("http failed.")

//關(guān)閉所有日志
DSLog.getLoggerManager().closeAllLogger()

demo日志器就做好了，在上面擴展功能也是非常容易的～
歡迎拿去食用～