LoggerSupport (Taobao Middleware Logger API 0.2.0 API)

java.lang.Object
- com.taobao.middleware.logger.support.LoggerSupport

All Implemented Interfaces:

Logger, ActivateOption

Direct Known Subclasses:

Log4j2Logger, Log4jLogger, NopLogger, Slf4jLogger
```
public abstract class LoggerSupport
extends Object
implements Logger
```

Field Summary

Fields
Modifier and Type Field and Description

protected ActivateOption activateOption

protected Object delegateLogger

Fields
Modifier and Type	Field and Description
`protected ActivateOption`	`activateOption`
`protected Object`	`delegateLogger`

Constructor Summary

Constructors
Constructor and Description

LoggerSupport(Object delegate)

Constructors
Constructor and Description
`LoggerSupport(Object delegate)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activateAppender(Logger logger)` 使用logger对象的appender来初始化当前logger
`void`	`activateAppender(String productName, String file, String encoding)` 设置FileAppender，日志按天回滚
`void`	`activateAppenderWithSizeRolling(String productName, String file, String encoding, String size, int maxBackupIndex)` 设置按文件大小、最大备份文件数回滚说明： 1、Log4j 备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份 2、备份日志格式说明： Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始 Logback: notify.log.1， notify.log.1
`void`	`activateAppenderWithTimeAndSizeRolling(String productName, String file, String encoding, String size)` 设置按天和文件大小回滚
`void`	`activateAppenderWithTimeAndSizeRolling(String productName, String file, String encoding, String size, String datePattern)` 设置按日期格式和文件大小回滚说明：Log4j 对日期格式不生效，只有按大小回滚，同时不支持备份文件，即达到文件大小直接截断，如果需要备份文件，请参考带 maxBackupIndex 参数的方法
`void`	`activateAppenderWithTimeAndSizeRolling(String productName, String file, String encoding, String size, String datePattern, int maxBackupIndex)` 设置按日期格式、文件大小、最大备份文件数回滚说明： 1、Log4j 对日期格式不生效，只有按大小、备份文件数回滚，备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份 2、备份日志格式说明： Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始 Logback: notify.log.2014-09-19.0， notify.log.2014-09-19.1，即中间会带日期格式，同时序号从0开始
`void`	`activateAsync(int queueSize, int discardingThreshold)` 将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化
`void`	`activateAsync(List<Object[]> args)` 将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化
`void`	`activateAsyncAppender(String productName, String file, String encoding)` 设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 `ActivateOption.activateAsync(int, int)`
`void`	`activateAsyncAppender(String productName, String file, String encoding, int queueSize, int discardingThreshold)` 设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 `ActivateOption.activateAsync(int, int)`
`void`	`activateConsoleAppender(String target, String encoding)` 设置ConsoleAppender，生产环境慎用
`void`	`debug(String message)` 输出Debug日志
`void`	`debug(String format, Object... args)` 输出Debug日志
`void`	`error(String errorCode, String message)` 输出Error日志
`void`	`error(String errorCode, String format, Object... args)` 输出Error日志
`void`	`error(String errorCode, String message, Throwable t)` 输出Error日志
`Object`	`getDelegate()` 获取内部日志实现对象
`Level`	`getLevel()` 获取日志级别
`String`	`getProductName()` 获取所属的产品名
`void`	`info(String message)` 输出Info日志
`void`	`info(String format, Object... args)` 输出Info日志
`void`	`setAdditivity(boolean additivity)` 设置日志是否Attach到Parent
`void`	`setLevel(Level level)` 设置日志级别
`void`	`warn(String message)` 输出Warn日志
`void`	`warn(String format, Object... args)` 输出Warn日志

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.taobao.middleware.logger.Logger
debug, debug, error, error, error, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, warn, warn, warn

- Field Detail
  - delegateLogger
```
protected Object delegateLogger
```
  - activateOption
```
protected ActivateOption activateOption
```
- Constructor Detail
  - LoggerSupport
```
public LoggerSupport(Object delegate)
```
- Method Detail
  - debug
```
public void debug(String message)
```
    Description copied from interface: Logger
    
    输出Debug日志
    
    Specified by:
    
    debug in interface Logger
    
    Parameters:
    message - 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
  - debug
```
public void debug(String format,
         Object... args)
```
    Description copied from interface: Logger
    
    输出Debug日志
    
    Specified by:
    
    debug in interface Logger
    
    Parameters:
    format - 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
    args - 格式化串参数数组
  - info
```
public void info(String message)
```
    Description copied from interface: Logger
    
    输出Info日志
    
    Specified by:
    
    info in interface Logger
    
    Parameters:
    message - 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
  - info
```
public void info(String format,
        Object... args)
```
    Description copied from interface: Logger
    
    输出Info日志
    
    Specified by:
    
    info in interface Logger
    
    Parameters:
    format - 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
    args - 格式化串参数数组
  - warn
```
public void warn(String message)
```
    Description copied from interface: Logger
    
    输出Warn日志
    
    Specified by:
    
    warn in interface Logger
    
    Parameters:
    message - 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
  - warn
```
public void warn(String format,
        Object... args)
```
    Description copied from interface: Logger
    
    输出Warn日志
    
    Specified by:
    
    warn in interface Logger
    
    Parameters:
    format - 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
    args - 格式化串参数数组
  - error
```
public void error(String errorCode,
         String message)
```
    Description copied from interface: Logger
    
    输出Error日志
    
    Specified by:
    
    error in interface Logger
    
    Parameters:
    errorCode - 错误码，如HSF-0001
    message - 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
  - error
```
public void error(String errorCode,
         String message,
         Throwable t)
```
    Description copied from interface: Logger
    
    输出Error日志
    
    Specified by:
    
    error in interface Logger
    
    Parameters:
    errorCode - 错误码，如HSF-0001
    message - 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
    t - 异常信息
  - error
```
public void error(String errorCode,
         String format,
         Object... args)
```
    Description copied from interface: Logger
    
    输出Error日志
    
    Specified by:
    
    error in interface Logger
    
    Parameters:
    errorCode - 错误码，如HSF-0001
    format - 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
    args - 格式化串参数数组
  - getDelegate
```
public Object getDelegate()
```
    Description copied from interface: Logger
    
    获取内部日志实现对象
    
    Specified by:
    
    getDelegate in interface Logger
  - activateConsoleAppender
```
public void activateConsoleAppender(String target,
                           String encoding)
```
    Description copied from interface: ActivateOption
    
    设置ConsoleAppender，生产环境慎用
    
    Specified by:
    
    activateConsoleAppender in interface ActivateOption
    
    Parameters:
    target - System.out or System.err
    encoding - 编码
  - activateAppender
```
public void activateAppender(String productName,
                    String file,
                    String encoding)
```
    Description copied from interface: ActivateOption
    
    设置FileAppender，日志按天回滚
    
    Specified by:
    
    activateAppender in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
  - setLevel
```
public void setLevel(Level level)
```
    Description copied from interface: ActivateOption
    
    设置日志级别
    
    Specified by:
    
    setLevel in interface ActivateOption
    
    Parameters:
    level - 日志级别
    See Also:
    Level
  - getLevel
```
public Level getLevel()
```
    Description copied from interface: ActivateOption
    
    获取日志级别
    
    Specified by:
    
    getLevel in interface ActivateOption
  - setAdditivity
```
public void setAdditivity(boolean additivity)
```
    Description copied from interface: ActivateOption
    
    设置日志是否Attach到Parent
    
    Specified by:
    
    setAdditivity in interface ActivateOption
    
    Parameters:
    additivity - true or false
  - getProductName
```
public String getProductName()
```
    Description copied from interface: ActivateOption
    
    获取所属的产品名
    
    Specified by:
    
    getProductName in interface ActivateOption
  - activateAsyncAppender
```
public void activateAsyncAppender(String productName,
                         String file,
                         String encoding)
```
    Description copied from interface: ActivateOption
    
    设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 ActivateOption.activateAsync(int, int)
    
    Specified by:
    
    activateAsyncAppender in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
  - activateAsyncAppender
```
public void activateAsyncAppender(String productName,
                         String file,
                         String encoding,
                         int queueSize,
                         int discardingThreshold)
```
    Description copied from interface: ActivateOption
    
    设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 ActivateOption.activateAsync(int, int)
    
    Specified by:
    
    activateAsyncAppender in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
    queueSize - 等待队列大小
    discardingThreshold - discardingThreshold，该参数仅对logback实现有效，log4j和log4j2无效
  - activateAppenderWithTimeAndSizeRolling
```
public void activateAppenderWithTimeAndSizeRolling(String productName,
                                          String file,
                                          String encoding,
                                          String size)
```
    Description copied from interface: ActivateOption
    
    设置按天和文件大小回滚
    
    Specified by:
    
    activateAppenderWithTimeAndSizeRolling in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
    size - 文件大小，如300MB，支持KB，MB，GB，该参数对log4j实现不生效，log4j2和logback有效
  - activateAppender
```
public void activateAppender(Logger logger)
```
    Description copied from interface: ActivateOption
    
    使用logger对象的appender来初始化当前logger
    
    Specified by:
    
    activateAppender in interface ActivateOption
  - activateAppenderWithTimeAndSizeRolling
```
public void activateAppenderWithTimeAndSizeRolling(String productName,
                                          String file,
                                          String encoding,
                                          String size,
                                          String datePattern)
```
    Description copied from interface: ActivateOption
```
 设置按日期格式和文件大小回滚
 说明：Log4j 对日期格式不生效，只有按大小回滚，同时不支持备份文件，即达到文件大小直接截断，如果需要备份文件，请参考带 maxBackupIndex 参数的方法
 
```
    Specified by:
    
    activateAppenderWithTimeAndSizeRolling in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
    size - 文件大小，如300MB，支持KB，MB，GB
    datePattern - 日期格式，如yyyy-MM-dd 或 yyyy-MM，请自行保证格式正确，该参数对log4j实现不生效，log4j2和logback有效
  - activateAppenderWithTimeAndSizeRolling
```
public void activateAppenderWithTimeAndSizeRolling(String productName,
                                          String file,
                                          String encoding,
                                          String size,
                                          String datePattern,
                                          int maxBackupIndex)
```
    Description copied from interface: ActivateOption
```
 设置按日期格式、文件大小、最大备份文件数回滚
 说明：
 1、Log4j 对日期格式不生效，只有按大小、备份文件数回滚，备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份
 2、备份日志格式说明：
     Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始
     Logback: notify.log.2014-09-19.0， notify.log.2014-09-19.1，即中间会带日期格式，同时序号从0开始
 
```
    Specified by:
    
    activateAppenderWithTimeAndSizeRolling in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
    size - 文件大小，如300MB，支持KB，MB，GB
    datePattern - 日期格式，如yyyy-MM-dd 或 yyyy-MM，请自行保证格式正确，该参数对log4j实现不生效，log4j2和logback有效
    maxBackupIndex - 最大备份文件数，如10（对于 Logback，则是保留10天的文件，但是这10天内的文件则会按大小回滚）
  - activateAppenderWithSizeRolling
```
public void activateAppenderWithSizeRolling(String productName,
                                   String file,
                                   String encoding,
                                   String size,
                                   int maxBackupIndex)
```
    Description copied from interface: ActivateOption
```
 设置按文件大小、最大备份文件数回滚
 说明：
 1、Log4j 备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份
 2、备份日志格式说明：
     Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始
     Logback: notify.log.1， notify.log.1
 
```
    Specified by:
    
    activateAppenderWithSizeRolling in interface ActivateOption
    
    Parameters:
    productName - 中间件产品名，如hsf, tddl
    file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
    encoding - 编码
    size - 文件大小，如300MB，支持KB，MB，GB
    maxBackupIndex - 最大备份文件数，如10
  - activateAsync
```
public void activateAsync(int queueSize,
                 int discardingThreshold)
```
    Description copied from interface: ActivateOption
    
    将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化
    
    Specified by:
    
    activateAsync in interface ActivateOption
    
    Parameters:
    queueSize - 等待队列大小
    discardingThreshold - discardingThreshold，该参数仅对logback实现有效，log4j和log4j2无效
  - activateAsync
```
public void activateAsync(List<Object[]> args)
```
    Description copied from interface: ActivateOption
    
    将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化
    
    Specified by:
    
    activateAsync in interface ActivateOption
    
    Parameters:
    args - AsyncAppender配置参数，请自行保证参数的正确性，要求每个Object[]有3个元素，第一个为set方法名，第二个为方法类型数组，第三个为对应的参数值，如 args.add(new Object[] { "setBufferSize", new Class[] { int.class }, queueSize });

Class LoggerSupport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.taobao.middleware.logger.Logger

Field Detail

delegateLogger

activateOption

Constructor Detail

LoggerSupport

Method Detail

debug

debug

info

info

warn

warn

error

error

error

getDelegate

activateConsoleAppender

activateAppender

setLevel

getLevel

setAdditivity

getProductName

activateAsyncAppender

activateAsyncAppender

activateAppenderWithTimeAndSizeRolling

activateAppender

activateAppenderWithTimeAndSizeRolling

activateAppenderWithTimeAndSizeRolling

activateAppenderWithSizeRolling

activateAsync

activateAsync