log4j简单的配置

朱雀 2022-05-24 03:57 191阅读 0赞

文章转自:[https://blog.csdn.net/qq\_35787138/article/details/81009056][https_blog.csdn.net_qq_35787138_article_details_81009056]

# **简介** #

Log4J 是 Apache 的一个开源项目（官网 http://jakarta.apache.org/log4j），通过在项目中使用 Log4J，我们可以控制日志信息输出到控制台、文件、GUI 组件、甚至是数据库中。我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以更灵活的控制日志的输出过程。方便项目的调试。

# **组成** #

Log4J 主要有 Loggers (日志记录器)、Appenders（输出端）和 Layout（日志格式化器）组成。其中 Loggers 控制日志的输出级别与日志是否输出；Appenders 指定日志的输出方式（输出到控制台、文件等）；Layout 控制日志信息的输出格式。

# **日志级别** #

Log4J 在 org.apache.log4j.Level 类中定义了OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL七种日志级别：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>OFF</td> 
   <td>最高日志级别，关闭左右日志</td> 
  </tr> 
  <tr> 
   <td>FATAL</td> 
   <td>将会导致应用程序退出的错误</td> 
  </tr> 
  <tr> 
   <td>ERROR</td> 
   <td>发生错误事件，但仍不影响系统的继续运行</td> 
  </tr> 
  <tr> 
   <td>WARN</td> 
   <td>警告，即潜在的错误情形</td> 
  </tr> 
  <tr> 
   <td>INFO</td> 
   <td>一般和在粗粒度级别上，强调应用程序的运行全程</td> 
  </tr> 
  <tr> 
   <td>DEBUG</td> 
   <td>一般用于细粒度级别上，对调试应用程序非常有帮助</td> 
  </tr> 
  <tr> 
   <td>ALL</td> 
   <td>最低等级，打开所有日志记录</td> 
  </tr> 
 </tbody> 
</table>

注：一般只使用4个级别，优先级从高到低为 ERROR > WARN > INFO > DEBUG

# **Appender（输出端）**   Appender 用来指定日志输出到哪个地方，可以同时指定日志的输出目的地。Log4j 常用的输出目的地有以下几种： #

org.apache.log4j.ConsoleAppender：将日志输出到控制台  
org.apache.log4j.FileAppender：将日志输出到文件中  
org.apache.log4j.DailyRollingFileAppender：将日志输出到一个日志文件，并且每天输出到一个新的文件  
org.apache.log4j.RollingFileAppender：将日志信息输出到一个日志文件，并且指定文件的尺寸，当文件大 小达到指定尺寸时，会自动把文件改名，同时产生一个新的文件  
org.apache.log4j.jdbc.JDBCAppender：把日志信息保存到数据库中

# **Layout（日志格式化器）** #

HTMLLayout：格式化日志输出为HTML表格形式  
SimpleLayout：简单的日志输出格式化，打印的日志格式为（info - message）  
PatternLayout：最强大的格式化期，可以根据自定义格式输出日志，如果没有指定转换格式，就是用默认的转换格式。

# 快速入门 #

首先在 maven 中引入 log4j 的依赖

创建 Log4jTest 类，测试 Log4j 的使用：

public class Log4JTest {
        public static void main(String[] args) {   
            //获取Logger对象的实例         
            Logger logger = Logger.getLogger(Log4JTest.class);
            //使用默认的配置信息，不需要写log4j.properties
            BasicConfigurator.configure();
            //设置日志输出级别为WARN，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
            logger.setLevel(Level.WARN);
            logger.debug("这是debug");
            logger.info("这是info");
            logger.warn("这是warn");
            logger.error("这是error");
            logger.fatal("这是fatal");
        }
    }

这里首先通过 Logger.getLogger(Log4Test.class) 创建 Logger 实例，然后调用 BasicConfigurator.configure() 方法指定该 Logger 使用默认的配置信息，接着调用 looger.setLevel(Level.WARN) 设置 Logger 的日志输出级别为 WARN 。运行 main 函数，控制台将会输出 warn 以上的错误信息。控制台输出如下：

0 [main] WARN com.huang.log4j.Log4JTest - 这是warn
    0 [main] WARN com.huang.log4j.Log4JTest - 这是error
    0 [main] WARN com.huang.log4j.Log4JTest - 这是fatal

注：如果没有调用 BasicConfigurator.configure() 方法，则运行 main 函数的时候则会报错，因为 Log4j 框架在运行的时候会加载项目路径下的 log4j.properties 配置文件（关于配置文件的使用，会在后面讲解）。而我们此时的项目中是没有该文件的。如果配置文件的名称不是log4j.properties，则可以通过 PropertyConfigurator.configure(String configFilename) 指定配置文件的名称。

# 格式化器的使用 #

修改 Log4JTest 中的代码：

public class Log4JTest {
        public static void main(String[] args) {
            Logger logger = Logger.getLogger(Log4JTest.class);
            BasicConfigurator.configure();
            HTMLLayout layout = new HTMLLayout();
            // SimpleLayout layout = new SimpleLayout();
            try {
                FileAppender appender = new FileAppender(layout, "D:\\out.html", false);
                logger.addAppender(appender);
                //设置日志输出级别为info，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
                logger.setLevel(Level.WARN);
                logger.debug("这是debug");
                logger.info("这是info");
                logger.warn("这是warn");
                logger.error("这是error");
                logger.fatal("这是fatal");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

首先创建一个HTML格式的格式化器（HTMLLayout），然后创建文件输出端（FileAppender）指定输出端的格式为 HTML 格式，输出路径为 D 盘下的 out.html 文件。然后通过 logger.addAppender(appender) 将文件输出端加载到 Logger 中。运行 main 函数，在 D 盘下会生成一个 out.html 文件，打开文件，里面的信息就是代码中输出的日志信息：

# log4j.properties 配置文件的使用 #

上面使用代码的方式设置 Logger 的输出格式，这样在我们每个要输出日志的类上都得设置一遍配置未免也太麻烦了吧。有一种更加方便的方法，我们只需要在项目路径下新建 log4j.properties 配置文件，并配置日志的输出格式等信息，Log4J 框架会自动的加载配置文件，并将配置信息设置到 Logger 中。最简单的配置文件如下：

# 控制台输出配置
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout
    log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
     
    # 文件输出配置
    log4j.appender.A = org.apache.log4j.DailyRollingFileAppender
    #指定日志的输出路径
    log4j.appender.A.File = D:/log.txt 
    log4j.appender.A.Append = true
    log4j.appender.A.Threshold = DEBUG
    #使用自定义日志格式化器
    log4j.appender.A.layout = org.apache.log4j.PatternLayout 
    #指定日志的输出格式
    log4j.appender.A.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n 
    #指定日志的文件编码
    log4j.appender.A.encoding=UTF-8 
     
    #指定日志的输出级别与输出端
    log4j.rootLogger=DEBUG,Console,A

在 log4j.properties 配置文件中，我们定义了日志输出级别与输出端，在输出端中分别配置日志的输出格式。

然后编写测试类 Log4JTest.java ：

public class Log4JTest {
        public static void main(String[] args) {   
            //获取Logger对象的实例         
            Logger logger = Logger.getLogger(Log4JTest.class);
            logger.debug("这是debug");
            logger.info("这是info");
            logger.warn("这是warn");
            logger.error("这是error");
            logger.fatal("这是fatal");
        }
    }

程序运行后控制台输出文本：

2018-07-12 14:36:36,114 [main] WARN  [com.huang.log4j.Log4JTest] - 这是warn
    2018-07-12 14:36:36,114 [main] ERROR [com.huang.log4j.Log4JTest] - 这是error
    2018-07-12 14:36:36,114 [main] FATAL [com.huang.log4j.Log4JTest] - 这是fatal

并会在 D 盘生成一份 log.txt 文件。文本内容如下

# 配置属性详解 #

关于配置文件的各个属性，可以参照以下配置

################################################################################
    #配置根Logger，其语法为：
    #log4j.rootLogger = [level],appenderName,appenderName2,...
    #level是日志记录的优先级，分为OFF,TRACE,DEBUG,INFO,WARN,ERROR,FATAL,ALL
    ##Log4j建议只使用四个级别，优先级从低到高分别是DEBUG,INFO,WARN,ERROR
    #appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的
    ################################################################################
    ################################################################################
    #②配置日志信息输出目的地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:可以指定文件编码格式
    ################################################################################
    ################################################################################
    #③配置日志信息的格式(布局)，其语法为：
    #
    #log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
    #log4j.appender.appenderName.layout.optionN = valueN
    #
    #Log4j提供的layout有以下几种：
    #5)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
    #6)org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
    #7)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
    #8)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
    #9)org.apache.log4j.xml.XMLLayout(以XML形式布局)
    #
    #5)HTMLLayout选项属性
    # -LocationInfo = TRUE:默认值false,输出java文件名称和行号
    # -Title=Struts Log Message:默认值 Log4J Log Messages
    #
    #6)PatternLayout选项属性
    # -ConversionPattern = %m%n:格式化指定的消息(参数意思下面有)
    #
    #9)XMLLayout选项属性
    # -LocationInfo = TRUE:默认值false,输出java文件名称和行号
    #
    #Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
    # %m 输出代码中指定的消息
    # %p 输出优先级，即DEBUG,INFO,WARN,ERROR,FATAL
    # %r 输出自应用启动到输出该log信息耗费的毫秒数
    # %c 输出所属的类目,通常就是所在类的全名
    # %t 输出产生该日志事件的线程名
    # %n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”
    # %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式
    #    如：%d{yyyy年MM月dd日 HH:mm:ss,SSS}，输出类似：2012年01月05日 22:10:28,921
    # %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数
    #    如：Testlog.main(TestLog.java:10)
    # %F 输出日志消息产生时所在的文件名称
    # %L 输出代码中的行号
    # %x 输出和当前线程相关联的NDC(嵌套诊断环境),像java servlets多客户多线程的应用中
    # %% 输出一个"%"字符
    #
    # 可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
    #  %5c: 输出category名称，最小宽度是5，category<5，默认的情况下右对齐
    #  %-5c:输出category名称，最小宽度是5，category<5，"-"号指定左对齐,会有空格
    #  %.5c:输出category名称，最大宽度是5，category>5，就会将左边多出的字符截掉，<5不会有空格
    #  %20.30c:category名称<20补空格，并且右对齐，>30字符，就从左边交远销出的字符截掉
    ################################################################################
    ################################################################################
    #④指定特定包的输出特定的级别
    #log4j.logger.org.springframework=DEBUG
    ################################################################################
     
    #OFF,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB,ALL
    log4j.rootLogger =ALL,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB
     
    #输出到控制台
    log4j.appender.systemOut = org.apache.log4j.ConsoleAppender
    log4j.appender.systemOut.layout = org.apache.log4j.PatternLayout
    log4j.appender.systemOut.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
    log4j.appender.systemOut.Threshold = DEBUG
    log4j.appender.systemOut.ImmediateFlush = TRUE
    log4j.appender.systemOut.Target = System.out
     
    #输出到文件
    log4j.appender.logFile = org.apache.log4j.FileAppender
    log4j.appender.logFile.layout = org.apache.log4j.PatternLayout
    log4j.appender.logFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
    log4j.appender.logFile.Threshold = DEBUG
    log4j.appender.logFile.ImmediateFlush = TRUE
    log4j.appender.logFile.Append = TRUE
    log4j.appender.logFile.File = ../Struts2/WebRoot/log/File/log4j_Struts.log
    log4j.appender.logFile.Encoding = UTF-8
     
    #按DatePattern输出到文件
    log4j.appender.logDailyFile = org.apache.log4j.DailyRollingFileAppender
    log4j.appender.logDailyFile.layout = org.apache.log4j.PatternLayout
    log4j.appender.logDailyFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
    log4j.appender.logDailyFile.Threshold = DEBUG
    log4j.appender.logDailyFile.ImmediateFlush = TRUE
    log4j.appender.logDailyFile.Append = TRUE
    log4j.appender.logDailyFile.File = ../Struts2/WebRoot/log/DailyFile/log4j_Struts
    log4j.appender.logDailyFile.DatePattern = '.'yyyy-MM-dd-HH-mm'.log'
    log4j.appender.logDailyFile.Encoding = UTF-8
     
    #设定文件大小输出到文件
    log4j.appender.logRollingFile = org.apache.log4j.RollingFileAppender
    log4j.appender.logRollingFile.layout = org.apache.log4j.PatternLayout
    log4j.appender.logRollingFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
    log4j.appender.logRollingFile.Threshold = DEBUG
    log4j.appender.logRollingFile.ImmediateFlush = TRUE
    log4j.appender.logRollingFile.Append = TRUE
    log4j.appender.logRollingFile.File = ../Struts2/WebRoot/log/RollingFile/log4j_Struts.log
    log4j.appender.logRollingFile.MaxFileSize = 1MB
    log4j.appender.logRollingFile.MaxBackupIndex = 10
    log4j.appender.logRollingFile.Encoding = UTF-8
     
    #用Email发送日志
    log4j.appender.logMail = org.apache.log4j.net.SMTPAppender
    log4j.appender.logMail.layout = org.apache.log4j.HTMLLayout
    log4j.appender.logMail.layout.LocationInfo = TRUE
    log4j.appender.logMail.layout.Title = Struts2 Mail LogFile
    log4j.appender.logMail.Threshold = DEBUG
    log4j.appender.logMail.SMTPDebug = FALSE
    log4j.appender.logMail.SMTPHost = SMTP.163.com
    log4j.appender.logMail.From = test@163.com
    log4j.appender.logMail.To = test@gmail.com
    #log4j.appender.logMail.Cc = test@gmail.com
    #log4j.appender.logMail.Bcc = test@gmail.com
    log4j.appender.logMail.SMTPUsername = test
    log4j.appender.logMail.SMTPPassword = 1234567
    log4j.appender.logMail.Subject = Log4j Log Messages
    #log4j.appender.logMail.BufferSize = 1024
    #log4j.appender.logMail.SMTPAuth = TRUE
     
    #将日志保存到MySQL数据库
    log4j.appender.logDB = org.apache.log4j.jdbc.JDBCAppender
    log4j.appender.logDB.layout = org.apache.log4j.PatternLayout
    log4j.appender.logDB.Driver = com.mysql.jdbc.Driver
    log4j.appender.logDB.URL = jdbc:mysql://127.0.0.1:3306/test
    log4j.appender.logDB.User = root
    log4j.appender.logDB.Password = 123456
    log4j.appender.logDB.Sql = INSERT INTO log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values('Struts2','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

[https_blog.csdn.net_qq_35787138_article_details_81009056]: https://blog.csdn.net/qq_35787138/article/details/81009056