com.taobao.middleware.logger.Logger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of logger.api Show documentation
There is a newer version: 0.2.8
package com.taobao.middleware.logger;

import com.taobao.middleware.logger.option.ActivateOption;

/**
 *  * 阿里中间件日志API，用于输出定制化的日志
 * 
 * 定制格式如下：01 %d{yyyy-MM-dd HH:mm:ss.SSS} %p [%-5t:%c{2}] %m%n
 * 其中：
 * 01                           日志API版本，后续如果格式有变化，会修改此版本号，方便机器解析
 * d{yyyy-MM-dd HH:mm:ss.SSS}   时间，如，2014-03-19 20:55:08.501，最后面的表示毫秒
 * %p                           日志级别，如INFO,ERROR
 * [%-5t:%c{2}]                 线程名:日志名
 * %m                           日志信息
 * %n                           换行
 * 
 * 关于%m，也有其中的格式要求：[Context] [STAT-INFO] [ERROR-CODE]
 * 其中：
 * Context                      打印时间时的上下文信息，如果没有，则内容为空，但'[]'这个占位符仍要输出
 * STAT-INFO                    待定
 * ERROR-CODE                   常见的错误码，帮助用户解决问题
 * 
 * 在异常中，也需要输出ErrorCode及对应的TraceUrl，可以使用
 * com.taobao.middleware.logger.support.LoggerHelper.getErrorCodeStr(String errorCode)来获取格式化后的串
 * 
 * 
 * @author zhuyong 2014年3月20日 上午9:58:27
 */
public interface Logger extends ActivateOption {

    /**
     * 输出Debug日志
     *
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void debug(String message);

    /**
     * 输出Debug日志
     *
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数数组
     */
    public void debug(String format, Object... args);

    /**
     * 输出Debug日志
     *
     * @param context 日志上下文信息
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void debug(String context, String message);

    /**
     * 输出Debug日志
     *
     * @param context 日志上下文信息
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数数组
     */
    public void debug(String context, String format, Object... args);

    /**
     * 输出Info日志
     *
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void info(String message);

    /**
     * 输出Info日志
     *
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数数组
     */
    public void info(String format, Object... args);

    /**
     * 输出Info日志
     *
     * @param context 日志上下文信息
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void info(String context, String message);

    /**
     * 输出Info日志
     *
     * @param context 日志上下文信息
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数数组
     */
    public void info(String context, String format, Object... args);

    /**
     * 输出Warn日志
     *
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void warn(String message);

    /**
     * 输出Warn日志
     *
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param t 异常信息
     * @since 0.1.5
     */
    public void warn(String message, Throwable t);

    /**
     * 输出Warn日志
     *
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数数组
     */
    public void warn(String format, Object... args);

    /**
     * 输出Warn日志
     *
     * @param context 日志上下文信息
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void warn(String context, String message);

    /**
     * 输出Warn日志
     *
     * @param context 日志上下文信息
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数数组
     */
    public void warn(String context, String format, Object... args);

    /**
     * 输出Error日志
     *
     * @param errorCode 错误码，如HSF-0001
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void error(String errorCode, String message);

    /**
     * 输出Error日志
     *
     * @param errorCode 错误码，如HSF-0001
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param t 异常信息
     */
    public void error(String errorCode, String message, Throwable t);

    /**
     * 输出Error日志
     *
     * @param errorCode 错误码，如HSF-0001
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param objs 格式化串参数数组
     */
    public void error(String errorCode, String format, Object... objs);

    /**
     * 输出Error日志
     *
     * @param context 日志上下文信息
     * @param errorCode 错误码
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     */
    public void error(String context, String errorCode, String message);

    /**
     * 输出Error日志
     *
     * @param context 日志上下文信息
     * @param errorCode 错误码
     * @param message 日志信息（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param t 异常信息
     */
    public void error(String context, String errorCode, String message, Throwable t);

    /**
     * 输出Error日志
     *
     * @param context 日志上下文信息
     * @param errorCode 错误码
     * @param format 日志信息格式化字符串，比如 'Hi,{} {} {}'（当使用ResourceBundle用于国际化日志输出时，message为对应的key, since 0.1.5）
     * @param args 格式化串参数
     */
    public void error(String context, String errorCode, String format, Object... args);

    /**
     * 判断Debug级别是否开启
     * @return
     */
    public boolean isDebugEnabled();

    /**
     * 判断Info级别是否开启
     * @return
     */
    public boolean isInfoEnabled();

    /**
     * 判断Warn级别是否开启
     * @return
     */
    public boolean isWarnEnabled();

    /**
     * 判断Error级别是否开启
     * @return
     */
    public boolean isErrorEnabled();

    /**
     * 获取内部日志实现对象
     * @return
     */
    public Object getDelegate();
}