• 主页
  • 文章
  • 一般的
  • 什么是 Logback.xml 日志框架？ ConsoleAppender、FileAppender 和 RollingFileAppender 示例

什么是 Logback.xml 日志框架？ ConsoleAppender、FileAppender 和 RollingFileAppender 示例

已发表: 2019-02-13
什么是 Logback.xml 日志框架？ ConsoleAppender、FileAppender 和 RollingFileAppender 教程

你知道Logback Logging Framework吗？ 好吧，大多数人主要在他们的项目中使用log4j and slf4j 。 自从过去 6 个月以来，我一直在使用Logback.xml日志框架，我想说我在生产应用程序中看到了很多性能改进。

在本教程中，我们将介绍 Logback 日志框架的实际示例。

什么是 logback.qos.ch？

Logback 是 Log4j 的一种新版本。 它是从 log4j 开发停止的地方开发的。

Logback 日志框架详细信息

在 Crunchify 上，如果您有兴趣，我们已经发布了多个关于 Log4j 的教程：

  • 如何设置自己的 log4j 日志记录级别？
  • 如何配置 log4j.properties？

在这里，我们将详细介绍如何为您的企业 Java 项目设置 Logback 日志框架。 我们将在下面创建新文件。

  1. 资源文件夹下logback.xml文件
  2. Java 类CrunchifyLogbackLogging.java

让我们开始吧

Step-1 创建 logback.xml 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<? xml version = "1.0" encoding = "UTF-8" ?>
< configuration >
 
< appender name = "CRUNCHIFYOUT" class = "ch.qos.logback.core.ConsoleAppender" >
< layout class = "ch.qos.logback.classic.PatternLayout" >
< Pattern > % d { HH : mm : ss . SSS } [ % thread ] % - 5level % logger { 36 }
% X { sourceThread } - % msg % n < / Pattern >
< / layout >
< / appender >
 
< appender name = "CRUNCHIFYFILE" class = "ch.qos.logback.core.FileAppender" >
< file > / Users / ashah / Documents / crunchify . log < / file >
 
< encoder >
< pattern > % date % level [ % thread ] % logger { 10 } [ % file : % line ] % msg % n < / pattern >
< / encoder >
< / appender >
 
< appender name = "CRUNCHIFYROLLING" class = "ch.qos.logback.core.rolling.RollingFileAppender" >
< file > / Users / ashah / Documents / crunchify - rolling . log < / file >
 
< encoder class = "ch.qos.logback.classic.encoder.PatternLayoutEncoder" >
< Pattern >
% d { yyyy - MM - dd HH : mm : ss } [ % thread ] % level % logger { 35 } - % msg % n
< / Pattern >
< / encoder >
 
< rollingPolicy class = "ch.qos.logback.core.rolling.TimeBasedRollingPolicy" >
< ! -- We are rolling over daily -- >
< fileNamePattern > crunchify . log . timeroll . % d { yyyy - MM - dd } . log < / fileNamePattern >
 
< ! -- keep 10 days ' worth of history capped at 1GB total size -- >
< maxHistory > 10 < / maxHistory >
< totalSizeCap > 1GB < / totalSizeCap >
 
< / rollingPolicy >
< / appender >
 
< ! -- default is DEBUG -- >
< root level = "DEBUG" >
< appender - ref ref = "CRUNCHIFYOUT" / >
< appender - ref ref = "CRUNCHIFYFILE" / >
< appender - ref ref = "CRUNCHIFYROLLING" / >
< / root >
 
< / configuration >

我们先了解一下 logback.xml 文件。

  • 在文件的底部，您会看到我们在root元素下有 3 个附加程序引用appender-ref 。
  • 我们使用日志级别作为DEBUG 。 这意味着使用 DEBUG 及以上级别打印所有内容。

CRUNCHIFYOUT appender 属于 ch.qos.logback.core 类。 ConsoleAppender 。 这意味着，所有日志记录数据都将打印到 Eclipse 控制台。

CRUNCHIFYFILE是 ch.qos.logback.core 类型。 FileAppender 。 这意味着，所有日志记录数据也将打印到本地文件。 在我们的例子中，它是 /Users/ ashah /Documents/ crunchify.log 。

CRUNCHIFYROLLING属于 ch.qos.logback.core.rolling 类型。 RollingFileAppender 。 正如您在 rollingPolicy 中看到的，我们每天都在滚动文件并最多保留 10 个文件。 此外，在我们的示例中，总文件大小容量限制为1 GB 。 新文件将在/Users/ ashah /Documents/ crunchify -rolling.log位置创建。

步骤 2 编写 Java 程序进行测试。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package crunchify . com . tutorial ;
 
import org . slf4j . Logger ;
import org . slf4j . LoggerFactory ;
 
/**
* @author Crunchify.com
* Program: Very simple Logback.xml test class with ConsoleAppender, FileAppender and RollingFileAppender
* Version: 1.0.0
*
*/
 
public class CrunchifyLogbackLogging {
 
private final Logger crunchifyLogging = LoggerFactory . getLogger ( CrunchifyLogbackLogging . class ) ;
 
public static void main ( String [ ] args ) {
 
CrunchifyLogbackLogging crunchifyLogger = new CrunchifyLogbackLogging ( ) ;
crunchifyLogger . getStartedwithLogBackTesting ( ) ;
 
}
 
private void getStartedwithLogBackTesting ( ) {
 
for ( int i = 1 ; i < = 10 ; i ++ ) {
crunchifyLogging . debug ( "......This is test by Crunchify on Logback DEBUG...... " ) ;
crunchifyLogging . info ( "......This is test by Crunchify on Logback INFO......" ) ;
crunchifyLogging . error ( "......This is test by Crunchify on Logback ERROR......" ) ;
crunchifyLogging . warn ( "......This is test by Crunchify on Logback WARN......" ) ;
}
 
}
}

这是一个非常简单的 Java 测试类，我们在其中使用了错误、信息、调试和警告所有 4 个日志级别。 我们循环了 10 次。

第三步

运行上述程序后，logback 框架将创建两个新文件，如上所述。

检查您的 Eclipse 控制台。 您将看到以下日志：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
15 : 36 : 12 , 978 | - INFO in ch . qos . logback . classic . LoggerContext [ default ] - Could NOT find resource [ logback - test . xml ]
15 : 36 : 12 , 978 | - INFO in ch . qos . logback . classic . LoggerContext [ default ] - Could NOT find resource [ logback . groovy ]
15 : 36 : 12 , 978 | - INFO in ch . qos . logback . classic . LoggerContext [ default ] - Found resource [ logback . xml ] at [ file : / Users / ashah / Documents / site / Bitbucket / crunchifytutorials / target / classes / logback . xml ]
15 : 36 : 13 , 077 | - INFO in ch . qos . logback . classic . joran . action . ConfigurationAction - debug attribute not set
15 : 36 : 13 , 077 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - About to instantiate appender of type [ ch . qos . logback . core . ConsoleAppender ]
15 : 36 : 13 , 087 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - Naming appender as [ CRUNCHIFYOUT ]
15 : 36 : 13 , 143 | - WARN in ch . qos . logback . core . ConsoleAppender [ CRUNCHIFYOUT ] - This appender no longer admits a layout as a sub - component , set an encoder instead .
15 : 36 : 13 , 143 | - WARN in ch . qos . logback . core . ConsoleAppender [ CRUNCHIFYOUT ] - To ensure compatibility , wrapping your layout in LayoutWrappingEncoder .
15 : 36 : 13 , 143 | - WARN in ch . qos . logback . core . ConsoleAppender [ CRUNCHIFYOUT ] - See also http : //logback.qos.ch/codes.html#layoutInsteadOfEncoder for details
15 : 36 : 13 , 144 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - About to instantiate appender of type [ ch . qos . logback . core . FileAppender ]
15 : 36 : 13 , 147 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - Naming appender as [ CRUNCHIFYFILE ]
15 : 36 : 13 , 147 | - INFO in ch . qos . logback . core . joran . action . NestedComplexPropertyIA - Assuming default type [ ch . qos . logback . classic . encoder . PatternLayoutEncoder ] for [ encoder ] property
15 : 36 : 13 , 148 | - INFO in ch . qos . logback . core . FileAppender [ CRUNCHIFYFILE ] - File property is set to [ / Users / ashah / Documents / crunchify . log ]
15 : 36 : 13 , 151 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - About to instantiate appender of type [ ch . qos . logback . core . rolling . RollingFileAppender ]
15 : 36 : 13 , 152 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - Naming appender as [ CRUNCHIFYROLLING ]
15 : 36 : 13 , 159 | - INFO in c . q . l . core . rolling . TimeBasedRollingPolicy @ 2096171631 - setting totalSizeCap to 1 GB
15 : 36 : 13 , 161 | - INFO in c . q . l . core . rolling . TimeBasedRollingPolicy @ 2096171631 - No compression will be used
15 : 36 : 13 , 163 | - INFO in c . q . l . core . rolling . TimeBasedRollingPolicy @ 2096171631 - Will use the pattern crunchify . log . timeroll . % d { yyyy - MM - dd } . log for the active file
15 : 36 : 13 , 166 | - INFO in c . q . l . core . rolling . DefaultTimeBasedFileNamingAndTriggeringPolicy - The date pattern is 'yyyy-MM-dd' from file name pattern 'crunchify.log.timeroll.%d{yyyy-MM-dd}.log' .
15 : 36 : 13 , 166 | - INFO in c . q . l . core . rolling . DefaultTimeBasedFileNamingAndTriggeringPolicy - Roll - over at midnight .
15 : 36 : 13 , 171 | - INFO in c . q . l . core . rolling . DefaultTimeBasedFileNamingAndTriggeringPolicy - Setting initial period to Thu Sep 07 11 : 42 : 27 CDT 2017
15 : 36 : 13 , 173 | - INFO in ch . qos . logback . core . rolling . RollingFileAppender [ CRUNCHIFYROLLING ] - Active log file name : / Users / ashah / Documents / crunchify - rolling . log
15 : 36 : 13 , 173 | - INFO in ch . qos . logback . core . rolling . RollingFileAppender [ CRUNCHIFYROLLING ] - File property is set to [ / Users / ashah / Documents / crunchify - rolling . log ]
15 : 36 : 13 , 173 | - INFO in ch . qos . logback . classic . joran . action . RootLoggerAction - Setting level of ROOT logger to DEBUG
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . core . joran . action . AppenderRefAction - Attaching appender named [ CRUNCHIFYOUT ] to Logger [ ROOT ]
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . core . joran . action . AppenderRefAction - Attaching appender named [ CRUNCHIFYFILE ] to Logger [ ROOT ]
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . core . joran . action . AppenderRefAction - Attaching appender named [ CRUNCHIFYROLLING ] to Logger [ ROOT ]
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . classic . joran . action . ConfigurationAction - End of configuration .
15 : 36 : 13 , 175 | - INFO in ch . qos . logback . classic . joran . JoranConfigurator @ 7e0babb1 - Registering current configuration as safe fallback point
 
15 : 36 : 13.181 [ main ] DEBUG c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback DEBUG . . . . . .
15 : 36 : 13.186 [ main ] INFO    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback INFO . . . . . .
15 : 36 : 13.187 [ main ] ERROR c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback ERROR . . . . . .
15 : 36 : 13.187 [ main ] WARN    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback WARN . . . . . .
15 : 36 : 13.188 [ main ] DEBUG c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback DEBUG . . . . . .
15 : 36 : 13.188 [ main ] INFO    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback INFO . . . . . .
15 : 36 : 13.188 [ main ] ERROR c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback ERROR . . . . . .
15 : 36 : 13.188 [ main ] WARN    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback WARN . . . . . .

除此之外，您还可以检查本地文件日志，如您所见， logback.xml文件已创建所有新文件并开始在其中打印日志。

Logback.xml 文件创建新的文件附加程序文件

享受吧，您已经正确设置了 logback.xml 和所有 3 个附加程序：ConsoleAppender、FileAppender、RollingFileAppender。

奖励点：

你想用FixedWindowRollingPolicy设置RollingFileAppender吗？ 使用下面的 appender 并将其放入 logback.xml 文件中，你应该一切都好

1
2
3
4
5
6
7
8
9
10
11
12
13
14
< appender name = "CRUNCHIFYROLLINGFIXEDWINDOW" class = "ch.qos.logback.core.rolling.RollingFileAppender" >
     < file > / Users / ashah / Documents / crunchify - rolling - fixwindows . log < / file >
     < encoder class = "ch.qos.logback.classic.encoder.PatternLayoutEncoder" >
         < pattern > % date % level [ % thread ] % logger { 10 } [ % file : % line ] % msg % n < / pattern >
     < / encoder >
     < rollingPolicy class = "ch.qos.logback.core.rolling.FixedWindowRollingPolicy" >
         < FileNamePattern > crunchify . log . fixedsize . { yyyy - MM - dd } % i . log < / FileNamePattern >
         < MinIndex > 1 < / MinIndex >
         < MaxIndex > 15 < / MaxIndex >
     < / rollingPolicy >
     < triggeringPolicy class = "ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy" >
         < MaxFileSize > 20MB < / MaxFileSize >
     < / triggeringPolicy >
< / appender >

此外，只需在根元素下添加 appender-ref。

1
< appender - ref ref = "CRUNCHIFYROLLINGFIXEDWINDOW" / >