log4j 具体解释

Posted 2020-09-27 yxysuanfa

通常，我们都提供一个名为 log4j.properties的文件。在第一次调用到Log4J时，Log4J会在类路径（../web-inf/class/当然也能够放到其他不论什么文件夹。仅仅要该文件夹被包括到类路径中就可以）中定位这个文件，并读入这个文件完毕的配置。这个配置文件告 诉Log4J以什么样的格式、把什么样的信息、输出到什么地方。

　　Log4j有三个基本的组件：Loggers(记录器)。Appenders(输出源)和Layouts(布局)，这里可简单理解为日志类别。日志要输出的地方和日志以何种形式输出。综合使用这三个组件能够轻松的记录信息的类型和级别，并能够在执行时控制日志输出的样式和位置。以下对三个组件分别进行说明：

　　

　　1、 Loggers

　 　Loggers组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL。分别用来指定这条日志信息的重要程度,明确这一点非常重要。这里Log4j有一个规则：如果Loggers级别为P。如果在Loggers中发生了一个级别Q比P高，则能够启动，否则屏蔽掉。

如果你定义的级别是info，那么error和warn的日志能够显示而比他低的debug信息就不显示了。

 　

　　Java程序举例来说：

　　

　　//建立Logger的一个实例，命名为“com.foo”

　　　Loggerlogger = Logger.getLogger("com.foo"); //"com.foo"是实例进行命名。也能够随意

　　//设置logger的级别。通常不在程序中设置logger的级别。

一般在配置文件里设置。

　　logger.setLevel(Level.INFO);

　　Logger barlogger = Logger.getLogger("com.foo.Bar");

　　//以下这个请求可用，由于WARN >= INFO

　　logger.warn("Low fuel level.");

　　//以下这个请求不可用，由于DEBUG < INFO

　　logger.debug("Starting search for nearest gas station.");

　　//命名为“com.foo.bar”的实例barlogger会继承实例“com.foo”的级别。因此，以下这个请求可用。由于INFO >= INFO

　　barlogger.info("Located nearest gas station.");

　　//以下这个请求不可用，由于DEBUG < INFO

　　barlogger.debug("Exiting gas station search");

　　这里“是否可用”的意思是是否能输出Logger信息。

　　　　在对Logger实例进行命名时，没有限制。能够取随意自己感兴趣的名字。普通情况下建议以类的所在位置来命名Logger实例。这是眼下来讲比較有效的Logger命名方式。

这样能够使得每一个类建立自己的日志信息，便于管理。比方：

　　

　　static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());

　　

　　2、Appenders

　　禁用与使用日志请求仅仅是Log4j当中的一个小小的地方，Log4j日志系统同意把日志输出到不同的地方，如控制台（Console）、文件（Files）、依据天数或者文件大小产生新的文件、以流的形式发送到其他地方等等。

　　

　　其语法表示为：

　　

　　org.apache.log4j.ConsoleAppender（控制台）

　　org.apache.log4j.FileAppender（文件）

　　org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

    org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

　　org.apache.log4j.WriterAppender（将日志信息以流格式发送到随意指定的地方）

　　

　　配置时使用方式为：

　　log4j.appender.appenderName = fully.qualified.name.of.appender.class

　　log4j.appender.appenderName.option1 = value1

　　…

    log4j.appender.appenderName.option = valueN

　　这样就为日志的输出提供了相当大的便利。

　　

　　3、Layouts

　 　有时用户希望依据自己的喜好格式化自己的日志输出。Log4j能够在Appenders的后面附加Layouts来完毕这个功能。Layouts提供了 四种日志输出样式，如依据html样式、自由指定样式、包括日志级别与信息的样式和包括日志时间、线程、类别等信息的样式等等。

　　

　　其语法表示为：

　　

　　org.apache.log4j.HTMLLayout（以HTML表格形式布局），

　　org.apache.log4j.PatternLayout（能够灵活地指定布局模式），

　　org.apache.log4j.SimpleLayout（包括日志信息的级别和信息字符串）。

　　org.apache.log4j.TTCCLayout（包括日志产生的时间、线程、类别等等信息）

　　

　　配置时使用方式为：

　　

　　log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class

　　log4j.appender.appenderName.layout.option1 = value1

　　…

　　log4j.appender.appenderName.layout.option = valueN

 

>>>>  4 . Log4j的配置 <<<<

　　

　　以上是从原理方面说明Log4j的用法，在详细Java编程使用Log4j能够參照下面演示样例：

　　

　　1、 建立Logger实例：

　　语法表示：public static Logger getLogger( String name)

　　实际使用：static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;

　　

　　2、 读取配置文件：

　　获得了Logger的实例之后。接下来将配置Log4j使用环境：

　　语法表示：

　　BasicConfigurator.configure()：自己主动高速地使用缺省Log4j环境。

　　PropertyConfigurator.configure(String configFilename)：读取使用Java的特性文件编写的配置文件。

　　DOMConfigurator.configure(String filename)：读取XML形式的配置文件。

　　实际使用：

    PropertyConfigurator.configure("ServerWithLog4j.properties");

　　

　　3、 插入日志信息

　　完毕了以上连个步骤以后，以下就能够按日志的不同级别插入到你要记录日志的不论什么地方了。

　　语法表示：

　　Logger.debug(Object message);//调试信息

　　Logger.info(Object message);//一般信息

　　Logger.warn(Object message);//警告信息

　　Logger.error(Object message);//错误信息

　　Logger.fatal(Object message);//致命错误信息

 

　　实际使用：logger.info("ServerSocket before accept: " + server);

　　

　>>>> 5. 配置过程 <<<<

 

　在实际编程时。要使Log4j真正在系统中执行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用。

    Log4j支持两种配置文件格式。一种是XML格式的文件。一种是java properties（key=value）【Java特性文件（键=值）】。以下我们介绍使用Java特性文件做为配置文件的方法

   详细例如以下：

　　

　　1、配置根Logger。其语法为：

　　log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

         level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议仅仅使用四个级别。优先级从高到低各自是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您能够控制到应用程序中对应级别的日志信息的开关。比方在这里定 义了INFO级别，则应用程序中全部DEBUG级别的日志信息将不被打印出来。

　　     appenderName:就是指定日志信息输出到哪个地方。您能够同一时候指定多个输出目的地。

   比如：log4j.rootLogger＝info,A1,B2,C3

　　

　　2、配置日志信息输出目的地，其语法为：

　　log4j.appender.appenderName = fully.qualified.name.of.appender.class  //

　　  "fully.qualified.name.of.appender.class" 能够指定以下五个目的地中的一个：

          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=WARN:指定日志消息的输出最低层次。

                    ImmediateFlush=true:默认值是true,意谓着全部的消息都会被马上输出。

                    Target=System.err：默认情况下是：System.out,指定输出控制台

              2.FileAppender 选项

                    Threshold=WARN:指定日志消息的输出最低层次。

                    ImmediateFlush=true:默认值是true,意谓着全部的消息都会被马上输出。

                    File=mylog.txt:指定消息输出到mylog.txt文件。

                    Append=false:默认值是true,即将消息添加到指定文件里，false指将消息覆盖指定的文件内容。

            3.DailyRollingFileAppender 选项

                    Threshold=WARN:指定日志消息的输出最低层次。

                    ImmediateFlush=true:默认值是true,意谓着全部的消息都会被马上输出。

                    File=mylog.txt:指定消息输出到mylog.txt文件。

                    Append=false:默认值是true,即将消息添加到指定文件里。false指将消息覆盖指定的文件内容。

                    DatePattern=‘.‘yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也能够指定按月、周、天、时和分。即相应的格式例如以下：

                    1)‘.‘yyyy-MM: 每月

                    2)‘.‘yyyy-ww: 每周 

                    3)‘.‘yyyy-MM-dd: 每天

                    4)‘.‘yyyy-MM-dd-a: 每天两次

                    5)‘.‘yyyy-MM-dd-HH: 每小时

                    6)‘.‘yyyy-MM-dd-HH-mm: 每分钟

            4.RollingFileAppender 选项

                    Threshold=WARN:指定日志消息的输出最低层次。

                    ImmediateFlush=true:默认值是true,意谓着全部的消息都会被马上输出。

                    File=mylog.txt:指定消息输出到mylog.txt文件。

                    Append=false:默认值是true,即将消息添加到指定文件里，false指将消息覆盖指定的文件内容。

                    MaxFileSize=100KB: 后缀能够是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自己主动滚动，即将原来的内容移到mylog.log.1文件。

                    MaxBackupIndex=2:指定能够产生的滚动文件的最大数。

 

实际应用：

　　log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender

　　

　　3、配置日志信息的格式。其语法为：

　　A. log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

              "fully.qualified.name.of.layout.class" 能够指定以下4个格式中的一个：

               1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），

　　       2.org.apache.log4j.PatternLayout（能够灵活地指定布局模式），

　　       3.org.apache.log4j.SimpleLayout（包括日志信息的级别和信息字符串），

　　       4.org.apache.log4j.TTCCLayout（包括日志产生的时间、线程、类别等等信息）

                   1.HTMLLayout 选项

                      LocationInfo=true:默认值是false,输出java文件名和行号

                      Title=my app file: 默认值是 Log4J Log Messages.

                   2.PatternLayout 选项

                      ConversionPattern=%m%n :指定如何格式化指定的消息。

                   3.XMLLayout  选项

                      LocationInfo=true:默认值是false,输出java文件和行号

   实际应用：

   　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout

 

       B. log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

           这里须要说明的就是日志信息格式中几个符号所代表的含义：

　　         －X号: X信息输出时左对齐。

                   %p: 输出日志信息优先级。即DEBUG，INFO。WARN。ERROR，FATAL,

                   %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也能够在其后指定格式，比方：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

                   %r: 输出自应用启动到输出该log信息耗费的毫秒数

                   %c: 输出日志信息所属的类目，通常就是所在类的全名

                   %t: 输出产生该日志事件的线程名

                   %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包含类目名、发生的线程，以及在代码中的行数。

举例：Testlog4.main(TestLog4.java:10)

                   %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这种多客户多线程的应用中。

                   %%: 输出一个"%"字符

                   %F: 输出日志消息产生时所在的文件名

                   %L: 输出代码中的行号

                   %m: 输出代码中指定的消息,产生的日志详细信息

                   %n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"输出日志信息换行

            能够在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

                     1)%20c：指定输出category的名称，最小的宽度是20，假设category的名称小于20的话，默认的情况下右对齐。

                     2)%-20c:指定输出category的名称。最小的宽度是20。假设category的名称小于20的话。"-"号指定左对齐。

                     3)%.30c:指定输出category的名称，最大的宽度是30，假设category的名称大于30的话，就会将左边多出的字符截掉。但小于30的话也不会有空格。

                     4)%20.30c:假设category的名称小于20就补空格，而且右对齐。假设其名称长于30字符，就从左边交远销出的字符截掉。

 

　　这里上面三个步骤是对前面Log4j组件说明的一个简化；以下给出一个详细配置样例。在程序中能够參照运行：

　　log4j.rootLogger=INFO,A1，B2

　　log4j.appender.A1=org.apache.log4j.ConsoleAppender

　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout

　　log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

 　　依据上面的日志格式。某一个程序的输出结果例如以下：

　　0INFO2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]

         16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: ‘Java server with log4j, Fri Jun 13 13:23:46 CST 2003‘

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: ‘Command ‘HELLO‘ not understood.‘

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: ‘Vocabulary: HELP QUIT‘

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT

 

      4. # 当输出信息于回滚文件时

 

          log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   //指定以文件的方式输出日志

           log4j.appender.ROLLING_FILE.Threshold=ERROR 

           log4j.appender.ROLLING_FILE.File=rolling.log  //文件位置,也能够用变量${java.home}、rolling.log

           log4j.appender.ROLLING_FILE.Append=true 

           log4j.appender.ROLLING_FILE.MaxFileSize=10KB  //文件最大尺寸

           log4j.appender.ROLLING_FILE.MaxBackupIndex=1  //备份数

           log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 

           log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n  

 

××××××××××××××××××××××××××××××××××××××××××××××××

 

>>>> 6. Log4j比較全面的配置 <<<<

 

 LOG4J的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自己定义标签等全套功能。择其一二使用就够用了。 

 

 log4j.rootLogger=DEBUG,CONSOLE,A1,im 

 log4j.addivity.org.apache=true 

 

 # 应用于控制台 

 

 log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 

 log4j.appender.Threshold=DEBUG 

 log4j.appender.CONSOLE.Target=System.out 

 log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 

 log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

 #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n 

 

 #应用于文件 

 

 log4j.appender.FILE=org.apache.log4j.FileAppender 

 log4j.appender.FILE.File=file.log 

 log4j.appender.FILE.Append=false 

 log4j.appender.FILE.layout=org.apache.log4j.PatternLayout 

 log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

 # Use this layout for LogFactor 5 analysis 

 

 # 应用于文件回滚 

 

 log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender 

 log4j.appender.ROLLING_FILE.Threshold=ERROR 

 log4j.appender.ROLLING_FILE.File=rolling.log  //文件位置,也能够用变量${java.home}、rolling.log

 log4j.appender.ROLLING_FILE.Append=true       //true:加入  false:覆盖

 log4j.appender.ROLLING_FILE.MaxFileSize=10KB   //文件最大尺寸

 log4j.appender.ROLLING_FILE.MaxBackupIndex=1  //备份数

 log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 

 log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

 

 

 #应用于socket 

 log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender 

 log4j.appender.SOCKET.RemoteHost=localhost 

 log4j.appender.SOCKET.Port=5001 

 log4j.appender.SOCKET.LocationInfo=true 

 # Set up for Log Facter 5 

 log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout 

 log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n 

 

 

 # Log Factor 5 Appender 

 log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 

 log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000 

 

 # 发送日志给邮件 

 

 log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 

 log4j.appender.MAIL.Threshold=FATAL 

 log4j.appender.MAIL.BufferSize=10 

 [email protected] 

 log4j.appender.MAIL.SMTPHost=www.wusetu.com 

 log4j.appender.MAIL.Subject=Log4J Message 

 [email protected] 

 log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout 

 log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

 

 # 用于数据库 

 log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender 

 log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test 

 log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver 

 log4j.appender.DATABASE.user=root 

 log4j.appender.DATABASE.password= 

 log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES (‘[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n‘) 

 log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout 

 log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

 

 

 log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender 

 log4j.appender.A1.File=SampleMessages.log4j 

 log4j.appender.A1.DatePattern=yyyyMMdd-HH‘.log4j‘ 

 log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout 

 

 #自己定义Appender 

 

 log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender 

 

 log4j.appender.im.host = mail.cybercorlin.net 

 log4j.appender.im.username = username 

 log4j.appender.im.password = password 

 log4j.appender.im.recipient = [email protected] 

 

 log4j.appender.im.layout=org.apache.log4j.PatternLayout 

 log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n