java logLevel设置

转载

轩辕 2024-07-09 10:21:25

文章标签 java logLevel设置 log4j java j2ee spring 文章分类 Java 后端开发

1 Log4j配置说明

Log4j可以通过java程序动态设置，该方式明显缺点是：如果需要修改日志输出级别等信息，则必须修改java文件，然后重新编译，很是麻烦；

log4j也可以通过配置文件的方式进行设置，目前支持两种格式的配置文件：

xml文件
properties文件（推荐）

下面是一个log4j配置文件的完整内容：

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout
 
### stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n
 
### set package ###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

1.2 配置根Logger

根logger主要定义log4j支持的日志级别及输出目的地，其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。

建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

appenderName指定日志信息输出到哪个地方，可同时指定多个输出目的地。

1.3 配置输出目的地Appender

Appender主要定义日志信息输出在什么位置，主要语法为：

log4j.appender.appenderName = classInfo
log4j.appender.appenderName.option1 = value1
　　…
log4j.appender.appenderName.optionN = valueN

Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

以ConsoleAppender为例，如：

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Target=System.out

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out

输出级别的种类
[html] view plaincopy
OFF 、FATAL 、ERROR、WARN、INFO、DEBUG、TRACE 、ALL  
 OFF 为最高等级 关闭了日志信息  
 FATAL  为可能导致应用中止的严重事件错误  
 ERROR 为严重错误 主要是程序的错误  
 WARN 为一般警告，比如session丢失  
 INFO 为一般要显示的信息，比如登录登出  
 DEBUG 为程序的调试信息  
 TRACE 为比DEBUG更细粒度的事件信息  
 ALL 为最低等级，将打开所有级别的日志

1.4 配置日志信息的格式Layout

　　Layout 负责格式化Appender的输出，其语法为：

log4j.appender.appenderName.layout = classInfo
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN

　其中，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

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

 <strong>FileAppender 选项</strong>
 Threshold=DEBUF:指定日志消息的输出最低层次。
 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
 File=mylog.txt:指定消息输出到mylog.txt文件。
 Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

 <strong>RollingFileAppender 选项</strong>
 Threshold=DEBUG:指定日志消息的输出最低层次。
 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.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字符，就从左边较远输出的字符截掉。

1.5 设置package输出级别

可以设置不同package的日志输出级别，语法为：

log4j.logger.packageName=level

其中，packageName为实际的包名，level为日志级别，例如：

log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

2 Log4j与J2ee结合

2.1 使用spring架构

Spring真是不错，替我们做了很多事情，如果系统使用了spring框架，则要集成log4j就很简单了，主要分为3个步骤，如下：

2.1.1 定义log4j配置文件

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout
 
### stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n
 
### log to file ###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

2.1.2 定义监听器

监听器需要定义在web.xml，主要包括：定义log4j配置文件目录、log4j监听器，如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
   
    <!--由Spring载入的Log4j配置文件位置-->
    <context-param>
       <param-name>log4jConfigLocation</param-name>
       <param-value>/WEB-INF/log4j.properties</param-value>
    </context-param>
   
    <context-param>
       <param-name>contextConfigLocation</param-name>
       <param-value>
           /WEB-INF/classes/applicationContext*.xml
       </param-value>
    </context-param>
   
    <!--Spring log4j Config loader-->
    <listener>
       <listener-class>
           org.springframework.web.util.Log4jConfigListener
       </listener-class>
    </listener>
   
    <listener>
       <listener-class>
           org.springframework.web.context.ContextLoaderListener
       </listener-class>
    </listener>
   
    <servlet>
       <servlet-name>InitiaServlet</servlet-name>
    <servlet-class>chb.test.web.InitiaServlet</servlet-class>
       <load-on-startup>1</load-on-startup>
    </servlet>
   
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

2.1.3 测试类

package com.dheaven.mip.web;
 
 
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
 
import org.apache.log4j.Logger;
 
public class InitiaServlet extends HttpServlet {
   
    protected Logger log = Logger.getLogger(InitiaServlet.class);
 
    private static final long serialVersionUID = 8550329576989690578L;
 
    /**
     * Constructor of the object.
     */
    public InitiaServlet() {
       super();
    }
 
    /**
     * Destruction of the servlet. <br>
     */
    public void destroy() {
       super.destroy();
    }
 
    /**
     * Initialization of the servlet. <br>
     *
     * @throws ServletException if an error occure
     */
    public void init() throws ServletException {
       log.debug("服务器启动了，log4j开始工作了");
    }
}

2.2不使用spring架构

如果系统没有使用spring，我们以servlet为例，很简单，大家按照步骤执行即可，只贴代码，不说废话。

2.2.1 定义log4j配置文件

放在web工程的WEB-INF目录下，内容如：

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout
 
### stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n
 
### set package ###
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.com.dheaven=debug

package com.dheaven.mip.web;
 
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
 
import org.apache.log4j.PropertyConfigurator;
 
public class InitLog4j extends HttpServlet {
 
    private static final long serialVersionUID = 1L;
 
    public void init() throws ServletException {
       String prefix = getServletContext().getRealPath("/");
       prefix = prefix.replace("//", "/");
       String file = getInitParameter("log4j-init-file");
       // if the log4j-init-file is not set, then no point in trying
       if (file != null) {
           PropertyConfigurator.configure(prefix + file);
       }
    }
}

2.2.3 在Web.xml中定义初始化类

<servlet>
       <servlet-name>log4j-init</servlet-name>
       <servlet-class>chb.test.web.InitLog4j</servlet-class>
 
       <init-param>
           <param-name>log4j-init-file</param-name>
           <param-value>WEB-INF/log4j.properties</param-value>
       </init-param>
      
       <load-on-startup>1</load-on-startup>
    </servlet>

2.2.4 测试类

package chb.test.web;
 
 
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
 
import org.apache.log4j.Logger;
 
public class InitiaServlet extends HttpServlet {
   
    protected Logger log = Logger.getLogger(InitiaServlet.class);
 
    private static final long serialVersionUID = 8550329576989690578L;
 
    /**
     * Constructor of the object.
     */
    public InitiaServlet() {
       super();
    }
 
    /**
     * Destruction of the servlet. <br>
     */
    public void destroy() {
       super.destroy();
    }
 
    /**
     * Initialization of the servlet. <br>
     *
     * @throws ServletException if an error occure
     */
    public void init() throws ServletException {
       log.debug("服务器启动了，log4j开始工作了");
    }
}

2.2.5 log4j.xml配置如下，log4j.xml存放在WEB-INF目录下

<?xml version="1.0" encoding="GBK" ?>  
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">    
  	<!-- 输出日志到控制台  ConsoleAppender --> 
        <appender name="console" 
  		class="org.apache.log4j.ConsoleAppender">
  		<param name="Threshold" value="info"></param>
  		<layout class="org.apache.log4j.TTCCLayout">
  			<param name="ConversionPattern" value="TTCCLayout"></param>
  		</layout>
  	</appender>

	<!-- 输出日志到文件  每天一个文件 -->
  	<appender name="dailyRollingFile"
  		class="org.apache.log4j.DailyRollingFileAppender">
  		<param name="Threshold" value="info"></param>
  		<param name="ImmediateFlush" value="true"></param>
  		<param name="File" value="c:/logs/dailyRollingFile.log"></param>
  		<param name="DatePattern" value="'.'yyyy-MM-dd'.log'"></param>
  		<layout class="org.apache.log4j.PatternLayout">
  			<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param>
  		</layout>
  	</appender> 
  	
  	<!-- 输出日志到文件  文件大小到达指定尺寸的时候产生一个新的文件 -->
  	<appender name="railyFile" 
  		class="org.apache.log4j.RollingFileAppender">
  		<param name="File" value="c:/logs/railyFile.log"></param>
  		<param name="ImmediateFlush" value="true"/>
  		<param name="Threshold" value="info"></param>
  		<param name="Append" value="true"></param>
  		<param name="MaxFileSize" value="30KB"></param>
  		<param name="MaxBackupIndex" value="100"></param>
  		<layout class="org.apache.log4j.PatternLayout">
  			<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param>
  		</layout>
  	</appender>

  	<!-- 输出日志到文件 -->
  	<appender name="file"
  		class="org.apache.log4j.FileAppender">
  		<param name="File" value="c:/logs/file.log"></param>
  		<param name="Threshold" value="info"></param>
  		<layout class="org.apache.log4j.PatternLayout">
  			<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param>
  		</layout>
  	</appender>

	<!-- 
	    定义全局的日志输出级别,但是在输出目的地的配置中配置的具体输出级别优先级高于全局定义的优先级。
	    如果在railyFile中定义<param name="Threshold" value="info"></param>，那么将会把info以上级别的信息输出
	 -->
 	<root>     
		<priority value="debug" />     
		<appender-ref ref="console" />  
        <appender-ref ref="dailyRollingFile" />  
        <appender-ref ref="railyFile" />  
        <appender-ref ref="file" />  
 	</root>    	

</log4j:configuration>

在web.xml中添加log4j.xml配置

<!-- log4j 系统日志-->
	<context-param> 
	  	<param-name>log4jConfigLocation</param-name> 
	 	<param-value>/WEB-INF/log4j.xml</param-value> 
	</context-param> 
	<listener> 
	  	<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> 
	</listener>

最后只需在代码中调用即可，格式如下：

public class HelloLog4j {

	private static Logger logger = Logger.getLogger(HelloLog4j.class);

	public  String getURL(){
		logger.info("getURL() ... ");
		return null;
	}
}

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。