org.tinygroup.logger
Interface Logger

All Known Implementing Classes:

LoggerImpl

public interface Logger

日志接口

Author:

luoguo

Method Summary

void	endTransaction() 结束事务日志
void	error(String code)
void	error(String code, Throwable throwable)
void	error(String code, Throwable throwable, Context context)
void	error(String code, Throwable throwable, Object... args)
void	error(Throwable throwable)
void	errorMessage(String message)
void	errorMessage(String message, Throwable throwable)
void	errorMessage(String message, Throwable throwable, Context context)
void	errorMessage(String message, Throwable throwable, Object... args)
void	flushTransaction() 把事务日志缓冲中的内容写入到日志当中，慎用 由哪个日志记录器发起，则会用哪个日志记录器记录
LogBuffer	getLogBuffer() 获取日志缓冲
org.slf4j.Logger	getLogger() 返回原生的日志记录器，，慎用 采用此日志记录器，则缓冲，国际化等都无法使用
int	getMaxBufferRecords() 返回缓存限制记录条数 说明：该参数在日志对象被置为缓存模式后才有效， 若缓存待输出日志条数超过该参数，插件将调用 flush方法输出日志并清空缓存。
boolean	isEnabled(LogLevel logLevel) 判定某个级别是否启用
boolean	isSupportTransaction() 是否支持事务日志
void	log(LogLevel logLevel, Locale locale, String code, Context context) 通过国际化方式进行记录
void	log(LogLevel logLevel, Locale locale, String code, Object... args) 通过国际化方式进行记录
void	log(LogLevel logLevel, String code) 通过国际化方式进行记录
void	log(LogLevel logLevel, String code, Context context) 通过国际化方式进行记录
void	log(LogLevel logLevel, String code, Object... args) 通过国际化方式进行记录
void	logMessage(LogLevel logLevel, String message) 不对message进行格式化直接输出
void	logMessage(LogLevel logLevel, String message, Context context) 不对message进行格式化直接输出
void	logMessage(LogLevel logLevel, String message, Object... args) 不对message进行格式化直接输出
void	logMessage(LogLevel logLevel, String message, Throwable t)
void	logMessage(LogLevel logLevel, String message, Throwable t, Context context)
void	logMessage(LogLevel logLevel, String message, Throwable t, Object... args)
void	putToMDC(String key, Object value) 往MDC存放值
void	removeFromMDC(String key) 移除MDC中变量值
void	removeLogBuffer() 删除日志缓冲
void	resetTransaction() 重置事务日志，记数器归零，内容清空，一般在最上层调用，否则会导致缓冲内容丢失，慎用
void	setMaxBufferRecords(int bufferRecords) 设置缓存限制记录条数 说明：当日志对象被置为缓存模式后，该参数用于 限制缓存允许的最大记录条数。
void	setSupportTransaction(boolean supportBusiness) 设置事务日志支持方式
void	startTransaction() 开始事务日志

Method Detail

isSupportTransaction

boolean isSupportTransaction()

是否支持事务日志

Returns:

getLogBuffer

LogBuffer getLogBuffer()

获取日志缓冲

Returns:

removeLogBuffer

void removeLogBuffer()

删除日志缓冲

setSupportTransaction

void setSupportTransaction(boolean supportBusiness)

设置事务日志支持方式

Parameters:

supportBusiness - true为支持，false为不支持，默认为支持

startTransaction

void startTransaction()

开始事务日志

endTransaction

void endTransaction()

结束事务日志

flushTransaction

void flushTransaction()

把事务日志缓冲中的内容写入到日志当中，慎用
由哪个日志记录器发起，则会用哪个日志记录器记录

resetTransaction

void resetTransaction()

重置事务日志，记数器归零，内容清空，一般在最上层调用，否则会导致缓冲内容丢失，慎用

getLogger

org.slf4j.Logger getLogger()

返回原生的日志记录器，，慎用
采用此日志记录器，则缓冲，国际化等都无法使用

Returns:

isEnabled

boolean isEnabled(LogLevel logLevel)

判定某个级别是否启用

Parameters:

logLevel -

Returns:

logMessage

void logMessage(LogLevel logLevel,
                String message)

不对message进行格式化直接输出

Parameters:

logLevel -

message -

logMessage

void logMessage(LogLevel logLevel,
                String message,
                Throwable t)

logMessage

void logMessage(LogLevel logLevel,
                String message,
                Object... args)

不对message进行格式化直接输出

Parameters:

logLevel -

message - 采用{0} {1} 方式占位

args -

logMessage

void logMessage(LogLevel logLevel,
                String message,
                Throwable t,
                Object... args)

logMessage

void logMessage(LogLevel logLevel,
                String message,
                Context context)

不对message进行格式化直接输出

Parameters:

logLevel -

message - 采用{name} {$age} 方式占位

context -

logMessage

void logMessage(LogLevel logLevel,
                String message,
                Throwable t,
                Context context)

log

void log(LogLevel logLevel,
         String code)

通过国际化方式进行记录

Parameters:

logLevel -

code -

log

void log(LogLevel logLevel,
         Locale locale,
         String code,
         Object... args)

通过国际化方式进行记录

Parameters:

logLevel -

locale -

code -

args -

log

void log(LogLevel logLevel,
         String code,
         Object... args)

通过国际化方式进行记录

Parameters:

logLevel -

code -

args -

log

void log(LogLevel logLevel,
         Locale locale,
         String code,
         Context context)

通过国际化方式进行记录

Parameters:

logLevel -

locale -

code -

context -

log

void log(LogLevel logLevel,
         String code,
         Context context)

通过国际化方式进行记录

Parameters:

logLevel -

code -

context -

error

void error(String code)

error

void error(Throwable throwable)

error

void error(String code,
           Throwable throwable)

error

void error(String code,
           Throwable throwable,
           Object... args)

error

void error(String code,
           Throwable throwable,
           Context context)

errorMessage

void errorMessage(String message)

errorMessage

void errorMessage(String message,
                  Throwable throwable)

errorMessage

void errorMessage(String message,
                  Throwable throwable,
                  Object... args)

errorMessage

void errorMessage(String message,
                  Throwable throwable,
                  Context context)

putToMDC

void putToMDC(String key,
              Object value)

往MDC存放值

Parameters:

key -

value -

removeFromMDC

void removeFromMDC(String key)

移除MDC中变量值

Parameters:

key -

getMaxBufferRecords

int getMaxBufferRecords()

返回缓存限制记录条数

说明：该参数在日志对象被置为缓存模式后才有效，
若缓存待输出日志条数超过该参数，插件将调用
flush方法输出日志并清空缓存。

Returns:

返回限制记录数

setMaxBufferRecords

void setMaxBufferRecords(int bufferRecords)

设置缓存限制记录条数

说明：当日志对象被置为缓存模式后，该参数用于
限制缓存允许的最大记录条数。

Parameters:

bufferRecords - 设置限制记录数