Log4j使用配置文件详解(手把手教你Log4j使用)

Log4j使用配置文件详解(手把手教你Log4j使用)-mikechen

什么是Log4j？

Log4j是Apache为Java提供的日志管理工具，它与System.out.println()的作用相似，用来跟踪、调试、维护程序。

 

Log4j的核心组件？

Log4j由三个重要的组件构成：Loggers(记录器)，Appenders (输出源)和Layouts(布局)，可以简单的理解为：

  • 日志类别
  • 日志要输出的地方
  • 日志以何种形式输出

1、Loggers(记录器)

Logger是记录日志的主体，描述它可以改变日志记录的表现。

Loggers组件在此系统中被分为五个级别：

  1. FATAL：重大错误，例如系统崩溃；
  2. ERROR：错误，例如某模块瘫痪；
  3. WARN：警告，程序的隐患，如果不处理，将来可能就是错误；
  4. INFO：信息，可以用来查看程序执行的流程；
  5. DEBUG：调试，用来调试程序的bug。

日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度，这五个级别顺序为：DEBUG < INFO < WARN < ERROR < FATAL。

Log4j有一个规则：只输出级别不低于设定级别的日志信息，假设Loggers级别设定为INFO，则INFO、WARN、ERROR和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

 

2、Appenders (输出源)

Appender则是用来指明将所有的log信息存放到什么地方，比如允许把日志输出到不同的地方：

  1. ConsoleAppender（控制台）
  2. FileAppender（文件）
  3. DailyRollingFileAppender（每天产生一个日志文件）
  4. WriterAppender（将日志信息以流格式发送到任意指定的地方）

可以根据天数或者文件大小产生新的文件，可以以流的形式发送到其它地方等等。

 

3、Layouts(布局)

Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息，Log4j可以在Appenders的后面附加Layouts来完成这个功能。

Layouts提供四种日志输出样式，比如:

  1. org.apache.Log4j.HTMLLayout（以HTML表格形式布局）
  2. org.apache.Log4j.PatternLayout（可以灵活地指定布局模式）
  3. org.apache.Log4j.SimpleLayout（包含日志信息的级别和信息字符串）
  4. org.apache.Log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

 

Log4j使用流程

1、引入Log4j相关jar包

<!--添加Log4j相关jar包-->
<dependency>
    <groupId>Log4j</groupId>
    <artifactId>Log4j</artifactId>
    <version>1.2.17</version>
</dependency>

2、加上配置文件

#日志配置
Log4j.rootLogger = DEBUG,stdout,file
 
#控制台输出
Log4j.appender.stdout=org.apache.Log4j.ConsoleAppender
Log4j.appender.stdout.Target=System.out
Log4j.appender.stdout.Threshold=DEBUG
Log4j.appender.stdout.layout=org.apache.Log4j.PatternLayout
Log4j.appender.stdout.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss}[ %p ]%m%n
 
#所有文件输出
Log4j.appender.file = org.apache.Log4j.FileAppender
Log4j.appender.file.File = D:/logs/log.log
Log4j.appender.file.Encoding=UTF-8
Log4j.appender.file.name = fileLogDemo
Log4j.appender.file.Threshold=DEBUG
Log4j.appender.file.layout=org.apache.Log4j.PatternLayout
Log4j.appender.file.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c {Num}] [%l] [ %t:%r ] - [ %p ]  %m%n
Log4j.appender.file.append = true

Log4j.properties:(这个是约定的名字，放在resource文件下)，如下图所示：

Log4j使用配置文件详解(手把手教你Log4j使用)-mikechen

3、使用日志记录对象

import org.apache.Log4j.Logger;public class Log4jTest {
    //获取日志记录器Logger，名字为本类类名
    private static Logger logger = Logger.getLogger(Log4jTest.class);
  
    public static void main(String[] args) {
        for(int i=0;i<3;i++){
            // 记录debug级别的信息
            logger.debug("Log4j日志输出：This is debug message.");
            // 记录info级别的信息
            logger.info("Log4j日志输出：This is info message.");
            // 记录error级别的信息
            logger.error("Log4j日志输出：This is error message.");
        }
    }
}

 

Log4j的配置详解

Log4j包含三个组件,分别是: Logger(记录器)、Appender(输出目的地)、Layout(日志布局)。可分别简单理解为”日志类别”、”日志要输出的地方”和”日志以何种形式输出”。

1、配置根Logger

Log4j.rootLogger = [level],appenderName,appenderName2,... 

level是日志记录的优先级，分为 OFF,TRACE,DEBUG,INFO,WARN,ERROR,FATAL,ALL 

Log4j建议只使用四个级别，优先级从低到高分别是DEBUG,INFO,WARN,ERROR
  • 通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。
  • 比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
  • appenderName就是指定日志信息输出到哪个地方，可同时指定多个输出目的。

2、配置日志信息输出目的地Appender

Log4j.appender.appenderName = fully.qualified.name.of.appender.class 
Log4j.appender.appenderName.optionN = valueN 

Log4j提供的appender有以下几种：

1)org.apache.Log4j.ConsoleAppender(输出到控制台) 
2)org.apache.Log4j.FileAppender(输出到文件) 
3)org.apache.Log4j.DailyRollingFileAppender(每天产生一个日志文件) 
4)org.apache.Log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件) 
5)org.apache.Log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) 

1)ConsoleAppender选项属性 
-Threshold = DEBUG:指定日志消息的输出最低层次 
-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
-Target = System.err:默认值System.out,输出到控制台(err为红色,out为黑色) 

2)FileAppender选项属性 
-Threshold = INFO:指定日志消息的输出最低层次 
-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
-File = C:\Log4j.log:指定消息输出到C:\Log4j.log文件 
-Append = FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容 
-Encoding = UTF-8:可以指定文件编码格式 


3)DailyRollingFileAppender选项属性 
-Threshold = WARN:指定日志消息的输出最低层次 
-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
-File = C:\Log4j.log:指定消息输出到C:\Log4j.log文件 
-Append = FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容 
-DatePattern='.'yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。还可以按用以下参数: 
#              '.'yyyy-MM:每月 
#              '.'yyyy-ww:每周 
#              '.'yyyy-MM-dd:每天 
#              '.'yyyy-MM-dd-a:每天两次 
#              '.'yyyy-MM-dd-HH:每小时 
#              '.'yyyy-MM-dd-HH-mm:每分钟 
-Encoding = UTF-8:可以指定文件编码格式 

4)RollingFileAppender选项属性 
-Threshold = ERROR:指定日志消息的输出最低层次 
-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
-File = C:/Log4j.log:指定消息输出到C:/Log4j.log文件 
-Append = FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容 
-MaxFileSize = 100KB:后缀可以是KB,MB,GB.在日志文件到达该大小时,将会自动滚动.如:Log4j.log.1 
-MaxBackupIndex = 2:指定可以产生的滚动文件的最大数 
-Encoding = UTF-8:可以指定文件编码格式

3、配置layout日志布局

org.apache.Log4j.HTMLLayout（HTML表格形式）
org.apache.Log4j.SimpleLayout（简单格式的日志，只包括日志信息的级别和指定的信息字符串 ，如:DEBUG - Hello）
org.apache.Log4j.TTCCLayout（日志的格式包括日志产生的时间、线程、类别等等信息）
org.apache.Log4j.PatternLayout（灵活地自定义日志格式）

4、配置文件写法

Log4j.rootLogger=INFO

#输出到debug文件 
Log4j.logger.fordebug=DEBUG,fordebug
Log4j.appender.fordebug = org.apache.Log4j.FileAppender 
Log4j.appender.fordebug.layout = org.apache.Log4j.PatternLayout 
Log4j.appender.fordebug.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
Log4j.appender.fordebug.Threshold = DEBUG 
Log4j.appender.fordebug.ImmediateFlush = TRUE 
Log4j.appender.fordebug.Append = TRUE 
Log4j.appender.fordebug.File = ../Struts2/WebRoot/log/File/Log4j_Struts.log 
Log4j.appender.fordebug.Encoding = UTF-8 

#输出到info文件 
Log4j.logger.forinfo=DEBUG,forinfo
Log4j.appender.forinfo = org.apache.Log4j.FileAppender 
Log4j.appender.forinfo.layout = org.apache.Log4j.PatternLayout 
Log4j.appender.forinfo.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
Log4j.appender.forinfo.Threshold = INFO 
Log4j.appender.forinfo.ImmediateFlush = TRUE 
Log4j.appender.forinfo.Append = TRUE 
Log4j.appender.forinfo.File = ../Struts2/WebRoot/log/File/Log4j_Struts.log 
Log4j.appender.forinfo.Encoding = UTF-8

 

陈睿mikechen

10年+大厂架构经验，资深技术专家，就职于阿里巴巴、淘宝、百度等一线互联网大厂。

关注「mikechen」公众号，获取更多技术干货！

后台回复【面试】即可获取《史上最全阿里Java面试题总结》，后台回复【架构】，即可获取《阿里架构师进阶专题全部合集》

相关推荐

Java架构师最新学习路线图

阿里P8架构师面试系列专题

手把手带你大型项目实战落地

Java进阶架构师18大技能专题

相关面试

2024最新大厂Spring考题解析

2024最新大厂Java面试题解析

2024大厂MySQL面试题解析

2024大厂Redis面试考题解析

评论交流
    说说你的看法
❯
返回顶部