log4j日志记录配置的小结

太过爱你忘了你带给我的痛 2024-02-17 22:39 24阅读 0赞

理论知识往往很枯燥，特别是一些技术性文章，读起来自然没有像小说那样情节丰富，充满了吸引力，根据我个人的一点经验，我觉得如果你想牢牢掌握并理解它，化为己用，首先搞清楚这几个问题：这个东西是什么，能干什么，为什么要这样做，不过也有例外，有时候相当难理解，这时候不妨从复制demo开始，先找到点信心后，再一点点去摸清楚理论，这样即使你过一些时间往了，看看以前自己笔记很快就能回想起来，不至于一点印象也没有，完全不知。

当然对于lo4j来说它的理论很简单。其应用也很简单。第一，你要先配置一下，第二，你要在项目运行时候加载，第三，你就可以在你的代码中随心所欲的记录下你要记录的东西。如果非要说哪里更复杂，就是在配置的时候稍微有点，如果你每次做项目都是从别的地方复制过来，再改一改也行，过如果你经常配，记忆力又好，这对于你来说压根不算事，直接默写出来就行。

那就先简单介绍Log4j三个主要的组件：Loggers(记录器)，Appenders(输出源)和Layouts(布局)。这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松地记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。

1. Loggers  
  
Loggers组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的，DEBUG< INFO < WARN < ERROR < FATAL，分别用来指定这条日志信息的重要程度，明白这一点很重要，Log4j有一个规则：只输出级别不低于设定级别的日志信息，假设Loggers级别设定为INFO，则INFO、WARN、ERROR和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

2. Appenders

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 = className  
log4j.appender.appenderName.Option1 = value1  
…  
log4j.appender.appenderName.OptionN = 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 =className  
log4j.appender.appenderName.layout.Option1 = value1  
…  
log4j.appender.appenderName.layout.OptionN = valueN

理论知识就这么，相当简单，就是不好记，配置的时候没有提示，不过细心一些就没有什么太大问题。  
  
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties属性文件。下面以properties属性文件为例介绍log4j.properties的配置。

1、 配置根Logger：  
log4j.rootLogger = \[ level \] , appenderName1,appenderName2, …  
log4j.additivity.org.apache=false：表示Logger不会在父Logger的appender里输出，默认为true。  
level ：设定日志记录的最低级别，可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别，Log4j建议只使用中间四个级别。通过在这里设定级别，您可以控制应用程序中相应级别的日志信息的开关，比如在这里设定了INFO级别，则应用程序中所有DEBUG级别的日志信息将不会被打印出来。  
appenderName：就是指定日志信息要输出到哪里。可以同时指定多个输出目的地，用逗号隔开。  
例如：log4j.rootLogger＝INFO,A1,B2,C3  
  
2、配置日志信息输出目的地（appender）：  
log4j.appender.appenderName = className  
appenderName：自定义appderName，在log4j.rootLogger设置中使用；  
className：可设值如下：  
(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：指定日志信息的最低输出级别，默认为DEBUG。  
ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。  
Target=System.err：默认值是System.out。  
(2)FileAppender选项：  
Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。  
ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。  
Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。  
File=D:/logs/logging.log4j：指定消息输出到logging.log4j文件中。  
(3)DailyRollingFileAppender选项：  
Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。  
ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。  
Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。  
File=D:/logs/logging.log4j：指定当前消息输出到logging.log4j文件中。  
DatePattern='.'yyyy-MM：每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j，前一个月的日志文件名为logging.log4j.yyyy-MM。  
另外，也可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：  
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：指定日志信息的最低输出级别，默认为DEBUG。  
ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。  
Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。  
File=D:/logs/logging.log4j：指定消息输出到logging.log4j文件中。  
MaxFileSize=100KB：后缀可以是KB,MB 或者GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到logging.log4j.1文件中。  
MaxBackupIndex=2：指定可以产生的滚动文件的最大数，例如，设为2则可以产生logging.log4j.1，logging.log4j.2两个滚动文件和一个logging.log4j文件。  
  
3、配置日志信息的输出格式（Layout）：  
log4j.appender.appenderName.layout=className  
className：可设值如下：  
(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：输出java文件名称和行号，默认值是false。  
Title=My Logging：默认值是Log4JLog Messages。  
(2)PatternLayout选项：  
ConversionPattern=%m%n：设定以怎样的格式显示消息。  
  
格式化符号说明：  
  
%p：输出日志信息的优先级，即DEBUG，INFO，WARN，ERROR，FATAL。  
%d：输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，如：%d\{yyyy/MM/ddHH:mm:ss,SSS\}。  
%r：输出自应用程序启动到输出该log信息耗费的毫秒数。  
%t：输出产生该日志事件的线程名。  
%l：输出日志事件的发生位置，相当于%c.%M(%F:%L)的组合，包括类全名、方法、文件名以及在代码中的行数。例如：test.TestLog4j.main(TestLog4j.java:10)。  
%c：输出日志信息所属的类目，通常就是所在类的全名。  
%M：输出产生日志信息的方法名。  
%F：输出日志消息产生时所在的文件名称。  
%L:：输出代码中的行号。  
%m:：输出代码中指定的具体日志信息。  
%n：输出一个回车换行符，Windows平台为"rn"，Unix平台为"n"。  
%x：输出和当前线程相关联的NDC(嵌套诊断环境)，尤其用到像javaservlets这样的多客户多线程的应用中。  
%%：输出一个"%"字符。  
另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如：  
1) c：指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐。  
2)%-20c："-"号表示左对齐。  
3)%.30c：指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格。

利用上面的说明配置一个比较简单的log4j，只是向你的控制台输出你的日志记录

log4j.rootLogger=DEBUG,console\#配置根记录器

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.consloe.ThresholdFlush=true

log4j.appender.console.ImmediateFlush=true

log4j.appender.console.Target=System.out

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

log4j.appender.console.layout.ConversionPattern=\[%-5p\]%d(%r) --> \[%t\] %l: %m %x %n

其他再高级点配置也跟这个很类似，只不过是功能更丰富了一些。理论加实践，是不是让你印象更深刻了呢，下面在输出到控制台的基本上配置一个可以生成本地日志文件

log4j.rootLogger=DEBUG,console,A

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.consloe.ThresholdFlush=true

log4j.appender.console.ImmediateFlush=true

log4j.appender.console.Target=System.out

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

log4j.appender.console.layout.ConversionPattern=\[%-5p\]%d(%r)\-->\[%t\]%l:%m%x%n

log4j.appender.A=org.apache.log4j.FileAppender

log4j.appender.A.Threshold=DEBUG

log4j.appender.A.ImmediateFlush=true

log4j.appender.A.Append=true

log4j.appender.A.File=D:/gaox.txt

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

log4j.appender.A.layout.ConversionPattern=\[%-5p\]%d(%r)\-->\[%t\]%l:%m%x%n

再稍微高级一点的配置就是为某一个包下或者某一个类定制一个日志记录

log4j.rootLogger=DEBUG,console,A

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.consloe.ThresholdFlush=true

log4j.appender.console.ImmediateFlush=true

log4j.appender.console.Target=System.out

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

log4j.appender.console.layout.ConversionPattern=\[%-5p\]%d(%r)\-->\[%t\]%l:%m%x%n

log4j.appender.A=org.apache.log4j.FileAppender

log4j.appender.A.Threshold=DEBUG

log4j.appender.A.ImmediateFlush=true

log4j.appender.A.Append=true

log4j.appender.A.File=D:/gaox.txt

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

log4j.appender.A.layout.ConversionPattern=\[%-5p\]%d(%r)\-->\[%t\]%l:%m%x%n

log4j.logger.com.gaox.entity.Student=Debug,B

log4j.appender.B=org.apache.log4j.FileAppender

log4j.appender.B.Threshold=DEBUG

log4j.appender.B.ImmediateFlush=true

log4j.appender.B.Append=true

log4j.appender.B.File=D:/student.txt

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

log4j.appender.B.layout.ConversionPattern=\[%-5p\]%d(%r)\-->\[%t\]%l:%m%x%n

配置文件配置好了还有最后一个非常关键的地方就是配置文件的加载，不管你建的是什么项目，lo4j会项目启动时默认加载项目src根目录下的log4j.properties配置文件，如果你的配置文件不在根目录下，比如你在src下面建了一个config的文件件来放各种配置文件，包括有log4j.properties,这时就需要你在项目启动的时候手动来加载这个配置文件了。加载配置文件方法有很多，这里介绍一种最基础的加载方式，就一行代码：PropertyConfigurator.configure(“配置文件的绝对路径”);

配置完成，然后在项目启动的时候加载，最后在项目使用了需要输出日志的类里声明一个记录器：

public Loggerlogger = Logger.getLogger(Student.class)

在需要日志输出的地方就可以用logger.info("")输出日志了

下面附上源码例子：

项目结构

![Center][]

pom.xml:

Student.java:

package com.gaox.entity;
    
    import org.apache.log4j.Logger;
    
    /**
     * @author gaox
     * @createTime 2017年6月10日 下午5:14:04
     */
    public class Student {
    	private String name;
    	private Integer age;
    	public Logger logger = Logger.getLogger(Student.class);
    
    	public Student(String name, Integer age) {
    		super();
    		this.name = name;
    		this.age = age;
    	}
    
    	public Student() {
    		super();
    	}
    
    	public String getName() {
    		return name;
    	}
    
    	public void setName(String name) {
    		this.name = name;
    	}
    
    	public Integer getAge() {
    		return age;
    	}
    
    	public void setAge(Integer age) {
    		this.age = age;
    	}
    
    	public void show() {
    		logger.info("我叫" + this.name + ",今年" + this.age + "岁。");
    	}
    }

Person.java:

package com.gaox.entity;
    
    import org.apache.log4j.Logger;
    
    /**
     * @author gaox
     * @createTime 2017年6月6日 上午9:41:42
     */
    public class Person {
    	public Logger logger=Logger.getLogger(Person.class);
    	private String name;
    	private String sex	;
    	private String address;
    	public Person(String name, String sex, String address) {
    		super();
    		this.name = name;
    		this.sex = sex;
    		this.address = address;
    		logger.info("有参数构造方法被调用");
    	}
    	public Person() {
    		super();
    		logger.info("无参构造方法被调用");
    	}
    	public String getName() {
    		return name;
    	}
    	public void setName(String name) {
    		this.name = name;
    	}
    	public String getSex() {
    		return sex;
    	}
    	public void setSex(String sex) {
    		this.sex = sex;
    	}
    	public String getAddress() {
    		return address;
    	}
    	public void setAddress(String address) {
    		this.address = address;
    	}
    	public String say(String str){
    		logger.info("say方法被调用了");
    		return str;
    	}
    	public String  show (String str	){
    		return str;
    	}
    }

log4j.properties:

log4j.rootLogger=DEBUG,console,A
    
    log4j.appender.console=org.apache.log4j.ConsoleAppender
    log4j.appender.consloe.ThresholdFlush=true
    log4j.appender.console.ImmediateFlush=true
    log4j.appender.console.Target=System.out
    log4j.appender.console.layout=org.apache.log4j.PatternLayout
    log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    
    log4j.appender.A=org.apache.log4j.FileAppender
    log4j.appender.A.Threshold=DEBUG
    log4j.appender.A.ImmediateFlush=true
    log4j.appender.A.Append=true
    log4j.appender.A.File=D:/gaox.txt
    log4j.appender.A.layout=org.apache.log4j.PatternLayout
    log4j.appender.A.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    
    log4j.logger.com.gaox.entity.Student=Debug,B
    log4j.appender.B=org.apache.log4j.FileAppender
    log4j.appender.B.Threshold=DEBUG
    log4j.appender.B.ImmediateFlush=true
    log4j.appender.B.Append=true
    log4j.appender.B.File=D:/student.txt
    log4j.appender.B.layout=org.apache.log4j.PatternLayout
    log4j.appender.B.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

Test.java:

package com.gaox.test;
    
    import org.apache.log4j.PropertyConfigurator;
    
    import com.gaox.entity.Person;
    
    /**
     * @author gaox
     * @createTime 2017年6月6日 上午9:45:21
     */
    public class Test {
    	public static void main(String[] args) {
    		PropertyConfigurator.configure(Test.class.getResource("/").getPath()+"/config/log4j.properties");
    		System.out.println(new Person("明明","女","郑州").say("hello"));
    	}
    }

Test2.java

package com.gaox.test;
    
    import org.apache.log4j.PropertyConfigurator;
    
    import com.gaox.entity.Student;
    
    /**
     * @author gaox
     * @createTime 2017年6月10日 下午5:20:45
     */
    public class Test2 {
    	public static void main(String[] args) {
    		PropertyConfigurator.configure(Test2.class.getResource("/").getPath()+"/config/log4j.properties");
    		Student s=new Student("明明", 18);
    		s.show();
    	}
    }

[Center]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/e65ecdaa040f4675be3f3fe08f7975d4.png