java中的日志组件-log4j

Posted 十三弦

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了java中的日志组件-log4j相关的知识,希望对你有一定的参考价值。

1.为什么使用日志组件

  Log4J是Apache的一个开放源代码项目,它是一个日志操作包,通过使用Log4J,可以指定日志信息输出的目的地,如控制台、文件、CUI组件、NT的事件记录器;还可以控制每一条日志输出格式。此外,通过定义日志信息的级别,能够非常细致地控制日志的输出,最令人感兴趣的是,这些功能可以通过一个配置文件来灵活进行配置,而不需要修改应程序代码。

在应用程序中输出日志有3个目的:

  • 监视代码中变量的变化情况,把数据周期性记录到文件中供其他应用进行统计分析工作;
  • 跟踪代码运行时轨迹,作为日后审计的依据;
  • 担当集成开发环境中的调试器的作用,向文件和控制台打印代码的调试信息;

Log4J主要由三大组件构成:

  • Logger:负责生成日志,并能够对日志信息进行分类筛选;
  • Appender:定义了日志信息输出的目的地,指定日志信息应该被输出到什么地方,这些地方可以是控制台、文件、网络设备等;
  • Layout: 指定日志信息的输出格式;

2.配置步骤

  引入jar文件;

  配置src/log4j.properties

#通过根元素指定日志输出的级别、目的地
#debug < info < warn < error
log4j.rootLogger =debug,console,file
##############日志输出到控制台#################
#日志输出到控制台使用的API类
log4j.appender.console=org.apache.log4j.ConsoleAppender
#日志输出的格式
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d %p %c.%M()-%m%n

##############日志输出到文件#################
log4j.appender.file=org.apache.log4j.RollingFileAppender
#指定日志文件的路径
log4j.appender.file.File=../logs/MyLog.log
#指定日志文件最大大小
log4j.appender.file.MaxFileSize=1024KB
#产生日志文件的最大数目
log4j.appender.file.MaxBackupIndex=10
#日志输出格式
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d %p %c.%M()-%m%n
  • 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(将日志信息以流格式发送到任意指定的地方)

A.ConsoleAppender选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err:默认情况下是:System.out,指定输出控制台
B.FileAppender 选项

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

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。

C.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: 每分钟
D.RollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.log:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。

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

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

  • layout组件可以指定下面四个目的地中的一个:

1.org.apache.log4j.htmlLayout(以HTML表格形式布局)包含选项:LocationInfo=true:默认值是false,输出java文件名称和行号Title=my app file: 默认值是 Log4J Log Messages

2.org.apache.log4j.PatternLayout(可以灵活地指定布局模式)包含选项:ConversionPattern=%m%n :指定怎样格式化指定的消息

3.org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
4.org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

 

  • 日志信息格式中几个符号所代表的含义:

-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"输出日志信息换行

 

%M  代表方法的名字
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:
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字符,就从左边交远销出的字符截掉。

 

3.使用日志组件

        Log log = LogFactory.getLog(Demo1.class);
        log.debug("调试");
        log.info("信息提示");
        log.warn("警告");
        log.error("异常");

 

以上是关于java中的日志组件-log4j的主要内容,如果未能解决你的问题,请参考以下文章

Java 使用Log4J进行日志操作

Java日志框架 -- LOG4J(Log4j入门案例日志级别Log4j组件(LoggersAppendersLayouts)配置文件内置日志记录自定义Logger)

Java日志框架 -- LOG4J(Log4j入门案例日志级别Log4j组件(LoggersAppendersLayouts)配置文件内置日志记录自定义Logger)

Log4j日志组件的使用

Java日志框架学习--JUL和Log4j--上

Java日志框架学习--LogBack和Log4j2--下