128 lines
5.7 KiB
Markdown
128 lines
5.7 KiB
Markdown
# Logback
|
||
## Introduce
|
||
`logback-classic`模块需要classpath下存在`slf4j-api.jar`, `logback-core.jar`, `logback-classic.jar`。
|
||
|
||
logback使用示例如下：
|
||
```java
|
||
package chapters.introduction;
|
||
|
||
import org.slf4j.Logger;
|
||
import org.slf4j.LoggerFactory;
|
||
|
||
public class HelloWorld1 {
|
||
|
||
public static void main(String[] args) {
|
||
|
||
Logger logger = LoggerFactory.getLogger("chapters.introduction.HelloWorld1");
|
||
logger.debug("Hello world.");
|
||
|
||
}
|
||
}
|
||
```
|
||
`HelloWorld1`类定义在`chapters.introduction`包下，其引入了slf4j中的`Logger`和`LoggerFactory`类。
|
||
|
||
在上述示例中，并没有引入任何logback的类，在使用日志的大多数场景中，只需要引入slf4j的api类即可。
|
||
|
||
## Logback Architecture
|
||
logback目前结构分为3个模块，`logback-core`，`logback-classic`，`logback-access`。
|
||
|
||
`logback-core`是其他两个模块的基础，`classic`模块拓展了`core`模块。`classic`模块实现了slf4j api，因而在使用slf4j时可以在logback和其他日志系统之间轻松切换。而`access`模块和servlet容器做了集成，可以通过http对日志进行访问。
|
||
|
||
### Logger, Appender, Layout
|
||
logback基于3个主要的类构成：`Logger`, `Appender`, `Layout`。`Logger`类属于logback-classic模块，Appender和Layout类则是属于logback-core模块。
|
||
|
||
#### Log Context
|
||
在logback-classic中，每个logger都关联了一个`Log Context`，log Context负责创建logger，并且log context将创建的logger按照树状结构排列。
|
||
|
||
Logger都拥有名称，其名称大小写敏感，并遵循分层的命名规则：
|
||
|
||
> 如果一个logger的名称，其名称加上`.`后形成的字符串，为另一个logger的前缀，那么可称后一个logger是前一个logger的后代。如果一个logger和后代logger之间没有其他的logger，那么可以称前一个logger是后一个logger的parent。
|
||
|
||
例如，名称为`"com.foo"`的logger是名称为`"com.foo.Bar"`的parent。
|
||
|
||
root logger是位于最顶层的logger，其可以通过如下方式进行获取：
|
||
```java
|
||
Logger rootLogger = LoggerFactory.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
|
||
```
|
||
|
||
其他所有的logger也可以通过`getLogger`方法进行获取，该方法接收logger name来作为参数，`Logger`接口具有如下方法：
|
||
```java
|
||
package org.slf4j;
|
||
public interface Logger {
|
||
|
||
// Printing methods:
|
||
public void trace(String message);
|
||
public void debug(String message);
|
||
public void info(String message);
|
||
public void warn(String message);
|
||
public void error(String message);
|
||
}
|
||
```
|
||
|
||
#### 有效级别
|
||
logger都会被指定一个log level，level可以是`TRACE, DEBUG, INFO, WARN, ERROR`中的一个，其定义在`ch.qos.logback.classic.Level`类中。如果指定logger没有被指定level，那么其会从`离其最近并且被指定level的先祖logger`中继承level。
|
||
|
||
为了保证所有logger都可以继承level，root logger一定会被指定log level。默认情况下，level为`debug`。
|
||
|
||
> log level顺序为：
|
||
>
|
||
> `TRACE < DEBUG < INFO < WARN < ERROR`
|
||
|
||
#### 获取Logger
|
||
在通过`LoggerFactory.getLogger`获取logger对象时，如果向方法传入相同的名称，那么会获得相同的logger对象。
|
||
|
||
通常，应在每个class中指定一个logger，logger name为class的全类名。
|
||
|
||
#### Appender
|
||
在logback中，允许将日志打印到多个目的地，在logback中，目的地被称为`Appender`。目前，目的地可以是console、文件、remote socket server、数据库、JMS等。
|
||
|
||
对每个logger，都可以关联不止一个Appender。
|
||
|
||
`addAppender`将会将Appender关联到指定的logger。每个被允许打印的log请求都会被发送到该logger关联的所有Appender中，并且log请求还会被发送到树结构更高的Appender中。在logger结构中，Appender是增量继承的，后代logger会继承先祖logger的Appender。
|
||
|
||
如果为root logger指定一个console appender，并且为L指定一个file appender，那么对于L和L的后代logger打印日志的请求不仅会被发送到console，还会被打印到文件中。
|
||
|
||
> 可以手动指定logger L增量继承appender的标志为false，那么L和其所有后代logger都不会继承L先祖logger的appender。
|
||
>
|
||
> 默认情况下，appender是否增量继承的标志，默认值为true
|
||
|
||
#### Layout
|
||
如果想要指定日志打印的格式，可以将Layout对象和logger相关联。`PatternLayout`可以通过c语言`printf`的格式来指定打印格式。
|
||
|
||
`PatternLayout`中，若指定conversion pattern为`%-4relative [%thread] %-5level %logger{32} - %msg%n`，其会按如下格式打印消息：
|
||
```
|
||
176 [main] DEBUG manual.architecture.HelloWorld2 - Hello world.
|
||
```
|
||
|
||
#### 参数化打印
|
||
可以通过如下形式来进行参数化打印
|
||
```java
|
||
Object entry = new SomeObject();
|
||
logger.debug("The entry is {}.", entry);
|
||
```
|
||
只有当前消息被评估应该打印时，才会通过消息模板来构造消息，将`{}`替换为entry的实际值。
|
||
|
||
## Logback Configuration
|
||
### logback配置顺序
|
||
1. 如果`logback.configurationFile`系统变量设置
|
||
2. 如果1步骤失败，会尝试在classpath中寻找`logback-test.xml`
|
||
3. 如果2步骤失败，会尝试在classpath中寻找`logback.xml`
|
||
|
||
### 通过xml形式配置logback
|
||
```xml
|
||
<configuration>
|
||
|
||
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
||
<!-- encoders are assigned the type
|
||
ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
|
||
<encoder>
|
||
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%kvp- %msg%n</pattern>
|
||
</encoder>
|
||
</appender>
|
||
|
||
<root level="debug">
|
||
<appender-ref ref="STDOUT" />
|
||
</root>
|
||
</configuration>
|
||
```
|