mirai-core / net.mamoe.mirai.utils / MiraiLoggerPlatformBase

MiraiLoggerPlatformBase

abstract class MiraiLoggerPlatformBase : MiraiLogger

日志基类. 实现了 follower 的调用传递. 若 Mirai 自带的日志系统无法满足需求, 请继承这个类并实现其抽象函数.

这个类不应该被用作变量的类型定义. 只应被作为继承对象. 在定义 logger 变量时, 请一直使用 MiraiLogger 或者 MiraiLoggerWithSwitch.

Constructors

<init>

日志基类. 实现了 follower 的调用传递. 若 Mirai 自带的日志系统无法满足需求, 请继承这个类并实现其抽象函数.

MiraiLoggerPlatformBase()

Properties

follower

随从. 在 this 中调用所有方法后都应继续往 follower 传递调用. follower 的存在可以让一次日志被多个日志记录器记录.

var follower: MiraiLogger?

isEnabled

获取 MiraiLogger 是否已开启

open val isEnabled: Boolean

Functions

debug

记录一个 调试 级别的日志.

fun debug(message: String?): Unitfun debug(message: String?, e: Throwable?): Unit

debug0

abstract fun debug0(message: String?): Unit
abstract fun debug0(message: String?, e: Throwable?): Unit

error

记录一个 错误 级别的日志.

fun error(message: String?): Unitfun error(message: String?, e: Throwable?): Unit

error0

abstract fun error0(message: String?): Unit
abstract fun error0(message: String?, e: Throwable?): Unit

info

记录一个 信息 级别的日志.

fun info(message: String?): Unitfun info(message: String?, e: Throwable?): Unit

info0

abstract fun info0(message: String?): Unit
abstract fun info0(message: String?, e: Throwable?): Unit

plus

添加一个 follower, 返回 follower 它只会把 this 的属性 MiraiLogger.follower 修改为这个函数的参数 follower, 然后返回这个参数. 若 MiraiLogger.follower 已经有值, 则会替换掉这个值.

open operator fun <T : MiraiLogger> plus(follower: T): T

plusAssign

添加一个 followerMiraiLogger.follower 已经有值, 则会对这个值调用 plusAssign. 即会在日志记录器链的末尾添加这个参数 follower

open fun plusAssign(follower: MiraiLogger): Unit

verbose

记录一个 verbose 级别的日志. 无关紧要的, 经常大量输出的日志应使用它.

fun verbose(message: String?): Unitfun verbose(message: String?, e: Throwable?): Unit

verbose0

abstract fun verbose0(message: String?): Unit
abstract fun verbose0(message: String?, e: Throwable?): Unit

warning

记录一个 警告 级别的日志.

fun warning(message: String?): Unitfun warning(message: String?, e: Throwable?): Unit

warning0

abstract fun warning0(message: String?): Unit
abstract fun warning0(message: String?, e: Throwable?): Unit

Extension Functions

debug

fun MiraiLogger.debug(lazyMessage: () -> String?): Unit
fun MiraiLogger.debug(lazyMessage: () -> String?, e: Throwable?): Unit

error

fun MiraiLogger.error(lazyMessage: () -> String?): Unit
fun MiraiLogger.error(lazyMessage: () -> String?, e: Throwable?): Unit

info

fun MiraiLogger.info(lazyMessage: () -> String?): Unit
fun MiraiLogger.info(lazyMessage: () -> String?, e: Throwable?): Unit

verbose

fun MiraiLogger.verbose(lazyMessage: () -> String): Unit
fun MiraiLogger.verbose(lazyMessage: () -> String, e: Throwable?): Unit

warning

fun MiraiLogger.warning(lazyMessage: () -> String?): Unit
fun MiraiLogger.warning(lazyMessage: () -> String?, e: Throwable?): Unit

withSwitch

给这个 logger 添加一个开关, 用于控制是否记录 log

fun MiraiLogger.withSwitch(default: Boolean = true): MiraiLoggerWithSwitch

Inheritors

MiraiLoggerWithSwitch

带有开关的 Logger. 仅能通过 MiraiLogger.withSwitch 构造

class MiraiLoggerWithSwitch : MiraiLoggerPlatformBase

PlatformLogger

当前平台的默认的日志记录器. 在 JVM 控制台 端的实现为 printlnAndroid 端的实现为 android.util.Log

open class PlatformLogger : MiraiLoggerPlatformBase

SimpleLogger

简易日志记录, 所有类型日志都会被重定向 logger

class SimpleLogger : MiraiLoggerPlatformBase