服务热线:13616026886

技术文档 欢迎使用技术文档,我们为你提供从新手到专业开发者的所有资源,你也可以通过它日益精进

位置:首页 > 技术文档 > JAVA > 新手入门 > 基础入门 > 查看文档

log4j日志管理系统简单使用说明


  log4j有三个主要的组件:loggers,appenders和layouts,这里可简单理解为日志类别,日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别,并可以在运行时控制日志输出的样式和位置。下面对三个组件分别进行说明:
  
  1、 loggers
  loggers组件在此系统中被分为五个级别:debug、info、warn、error和fatal。这五个级别是有顺序的,debug < info < warn < error < fatal,明白这一点很重要,这里log4j有一个规则:假设loggers级别为p,如果在loggers中发生了一个级别q比p高,则可以启动,否则屏蔽掉。
  
  java程序举例来说:
  
  //建立logger的一个实例,命名为“com.foo”
  
  logger logger = logger.getlogger("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
  
  以上是从原理方面说明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.info("serversocket before accept: " + server);
  
  在实际编程时,要使log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对logger、appender及layout的分别使用,具体如下:
  
  1、 配置根logger,其语法为:
  log4j.rootlogger = [ level ] , appendername, appendername, …
  这里level指logger的优先级,appendername是日志信息的输出地,可以同时指定多个输出地。如:log4j.rootlogger= info,a1,a2
  
  2、 配置日志信息输出目的地,其语法为:
  log4j.appender.appendername = fully.qualified.name.of.appender.class
  可以指定上面所述五个目的地中的一个。
  
  3、 配置日志信息的格式,其语法为:
  log4j.appender.appendername.layout = fully.qualified.name.of.layout.class
  这里上面三个步骤是对前面log4j组件说明的一个简化;下面给出一个具体配置例子,在程序中可以参照执行:
  log4j.rootlogger=info,a1
  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
  这里需要说明的就是日志信息格式中几个符号所代表的含义:
  -x号: x信息输出时左对齐;
  %p: 日志信息级别
  %d{}: 日志信息产生时间
  %c: 日志信息所在地(类名)
  %m: 产生的日志具体信息
  %n: 输出日志信息换行
  
  根据上面的日志格式,某一个程序的输出结果如下:
  0  info 2003-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

扫描关注微信公众号