Formatter (structlog4j-api 1.1 API)

所有已知实现类:

KvPairFormatter
```
public interface Formatter
```
日志格式化类

作者:

IBIT-TECH

字段概要

字段
限定符和类型	字段和说明
`static String`	`KEY_ERROR_MESSAGE` message字段（系统字段）
`static String`	`KEY_MESSAGE` message字段（系统字段）
`static String`	`KEY_STACK_TRACE` stackTrace字段（系统字段）
`static String`	`REPLACE_R` '\r'替换符号
`static String`	`REPLACE_TAB` '\t'替换符号
`static String`	`REPLACE_WRAP` '\n'替换符号
`static String`	`SPACE` 空格
`static String`	`STR_R` '\r'符号
`static String`	`STR_TAB` '\t'符号
`static String`	`STR_WRAP` '\n'符号

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`String`	`format(Map<String,?> kvMap)` 格式化（待实现）
`default String`	`format(Object[] messages)` 格式化
`default String`	`format(Object[] messages, Throwable t)` 格式化
`default String`	`format(String message)` 格式化
`default String`	`format(String message, Throwable t)` 格式化
`default String`	`formatString(String originalStr)` 格式化字符字符串 "\t" 替换为 "\\t", "\r"替换为"\\r", "\n"替换为"\\n"
`default String`	`getErrorMessage(Throwable t)` 获取异常信息
`default String`	`getMessage(Object[] messages)` 根据message片段构造message
`default String`	`getStackTrace(Throwable throwable)` 获取异常堆栈信息

- 字段详细资料
  - KEY_MESSAGE
```
static final String KEY_MESSAGE
```
    message字段（系统字段）
    
    另请参阅:
    
    常量字段值
  - KEY_ERROR_MESSAGE
```
static final String KEY_ERROR_MESSAGE
```
    message字段（系统字段）
    
    另请参阅:
    
    常量字段值
  - KEY_STACK_TRACE
```
static final String KEY_STACK_TRACE
```
    stackTrace字段（系统字段）
    
    另请参阅:
    
    常量字段值
  - STR_TAB
```
static final String STR_TAB
```
    '\t'符号
    
    另请参阅:
    
    常量字段值
  - STR_R
```
static final String STR_R
```
    '\r'符号
    
    另请参阅:
    
    常量字段值
  - STR_WRAP
```
static final String STR_WRAP
```
    '\n'符号
    
    另请参阅:
    
    常量字段值
  - REPLACE_TAB
```
static final String REPLACE_TAB
```
    '\t'替换符号
    
    另请参阅:
    
    常量字段值
  - REPLACE_R
```
static final String REPLACE_R
```
    '\r'替换符号
    
    另请参阅:
    
    常量字段值
  - REPLACE_WRAP
```
static final String REPLACE_WRAP
```
    '\n'替换符号
    
    另请参阅:
    
    常量字段值
  - SPACE
```
static final String SPACE
```
    空格
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - format
```
String format(Map<String,?> kvMap)
```
    格式化（待实现）
    
    参数:
    
    kvMap - 兼职map
    
    返回:
    
    格式化后的文本
  - format
```
default String format(String message)
```
    格式化
    
    参数:
    
    message - message
    
    返回:
    
    格式化后的文本
  - format
```
default String format(String message,
                      Throwable t)
```
    格式化
    
    参数:
    
    message - message
    
    t - 异常
    
    返回:
    
    格式化后的文本
  - format
```
default String format(Object[] messages)
```
    格式化
    
    参数:
    
    messages - message片段，需要格式化String.format(messages[0], message[1]..)
    
    返回:
    
    格式化后的文本
  - format
```
default String format(Object[] messages,
                      Throwable t)
```
    格式化
    
    参数:
    
    messages - message片段，需要格式化String.format(messages[0], message[1]..)
    
    t - 异常
    
    返回:
    
    格式化后的文本
  - getMessage
```
default String getMessage(Object[] messages)
```
    根据message片段构造message
    
    参数:
    
    messages - message片段
    
    返回:
    
    message
  - formatString
```
default String formatString(String originalStr)
```
    格式化字符字符串 "\t" 替换为 "\\t", "\r"替换为"\\r", "\n"替换为"\\n"
    
    参数:
    
    originalStr - 原始字符串
    
    返回:
    
    格式化后的字符串
  - getErrorMessage
```
default String getErrorMessage(Throwable t)
```
    获取异常信息
    
    参数:
    
    t - 异常
    
    返回:
    
    异常信息
  - getStackTrace
```
default String getStackTrace(Throwable throwable)
```
    获取异常堆栈信息
    
    参数:
    
    throwable - 异常
    
    返回:
    
    堆栈信息

接口 Formatter

字段概要

方法概要

字段详细资料

KEY_MESSAGE

KEY_ERROR_MESSAGE

KEY_STACK_TRACE

STR_TAB

STR_R

STR_WRAP

REPLACE_TAB

REPLACE_R

REPLACE_WRAP

SPACE

方法详细资料

format

format

format

format

format

getMessage

formatString

getErrorMessage

getStackTrace