Java程序员从笨鸟到菜鸟（十三）log4j和log4j2.xml配置详解

原创 于 2018-05-07 19:50:32 发布 · 527 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#log4j #log4j2

本文详述了Java项目中如何利用log4j和log4j2进行日志记录，包括所需jar包、配置文件设置、过滤器与web.xml的集成，以及如何将日志写入数据库和本地文件。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

一、描述

在做项目时候，通常需要记录操作日志，用于日常维护，该文中的log4j和log4j2配置文件中详细介绍了如何将操作日志写入数据库及记录到本地文档中。

二、log4j

2.1 需要的jar包

log4j-1.2.17.jar

2.2 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>
	<!-- 将日志信息输出到控制台 -->
	<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
		<!-- 设置日志输出样式 -->
		<layout class="org.apache.log4j.PatternLayout">
			<!-- 设置日志输出的格式 -->
			<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n"></param>
		</layout>
		<!-- 过滤器设置输出的级别 -->
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<!-- 设置日志输出的最小级别 -->
			<param name="levelMin" value="WARN"/>
			<!-- 设置日志输出的最大级别 -->
			<param name="levelMax" value="ERROR"/>
		</filter>
	</appender>
	
	<!-- 将日志信息输出到文件,但是当文件的大小达到某个阈值的时候，日志文件会自动回滚 -->
	<appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender">
		<!-- 设置日志文件输出文件路径名 -->
		<param name="File" value="D:/log/RollingFileAppender.log"/>
		<!-- 设置是否在重新启动服务时，在原有的基础上添加新日志 -->
		<param name="Append" value="true"/>
		<!-- 设置保存备份回滚日志的最大个数 -->
		<param name="MaxBackupIndex" value="10"/>
		<!-- 设置日志的阈值，单位可以是KB,MB,GB，默认是KB -->
		<param name="MaxFileSize" value="10MB"/>
		<!-- 设置日志的样式 -->
		<layout class="org.apache.log4j.PatternLayout">
			<!-- 设置日志输出的样式 -->
			<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n"/>
		</layout>
	</appender>
	
	<!-- 打印操作日志 -->
	<appender name="operatorlog" class="org.apache.log4j.RollingFileAppender">
		<!-- 设置日志文件输出文件路径名 -->
		<param name="File" value="D:/log/operatorlog.log"/>
		<!-- 设置是否在重新启动服务时，在原有的基础上添加新日志 -->
		<param name="Append" value="true"/>
		<!-- 设置保存备份回滚日志的最大个数 -->
		<param name="MaxBackupIndex" value="10"/>
		<!-- 设置日志的阈值，单位可以是KB,MB,GB，默认是KB -->
		<param name="MaxFileSize" value="10MB"/>
		<!-- 设置日志的样式 -->
		<layout class="org.apache.log4j.PatternLayout">
			<!-- 设置日志输出的样式 -->
			<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] %d %p [%c] wang- %m>%n"/>
		</layout>
	</appender>
	
	<!-- 将日志输出到数据库 -->
	<appender name="database" class="org.apache.log4j.jdbc.JDBCAppender">
		<param name="URL" value="jdbc:mysql://localhost:3306/manage?characterEncoding=UTF-8"/>
		<param name="user" value="root"/>
		<param name="password" value="123456"/>
		<param name="driver" value="com.mysql.jdbc.Driver"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="insert into log(userid,username,class,method,createtime,loglevel,message)
			values('%X{userId}','%X{userName}','%c','%M','%d{yyyy-MM-dd HH:mm:ss}','%p','%m')"/>
		</layout>
	</appender>
	
	<!-- 将日志输出到文件，可以配置日志生成的时间 -->
	<appender name="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender">
		<!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="D:/log/DailyRollingFileAppender.log" />
        <!-- 设置日志每分钟回滚一次，即产生一个新的日志文件 -->
        <!-- <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" /> -->
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
        </layout>
	</appender>
	
	<!-- 指定logger的设置 -->
	<!-- <logger name="controller.UserController" additivity="false">
        <level value ="WARN"/>
        <appender-ref ref="DailyRollingFileAppender"/>
    </logger> -->
    
	    <!-- <logger name="controller" additivity="true">
	    	<level value="INFO"/>
	    	<appender-ref ref="database"/>
	    </logger>
	    
	    <logger name="" additivity="true">
	    	<level value="INFO"/>
	    	<appender-ref ref="operatorlog"/>
	    </logger>
	    
	    <logger name="" additivity="true">
	        <level value ="ERROR"/>
	        <appender-ref ref="RollingFileAppender"/>
	    </logger> -->
	    <root>
	        <level value ="INFO"/>
	        <appender-ref ref="ConsoleAppender"/>
	        <appender-ref ref="database"/>
	        <appender-ref ref="DailyRollingFileAppender"/>
	    </root>
   
    
</log4j:configuration>

2.3 写一个过滤器

package filter;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

import org.apache.log4j.MDC;

public class ResFilter implements Filter{
	@Override
	public void destroy() {
		// TODO Auto-generated method stub
		System.out.println("filter销毁了");
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
		MDC.put("userId", "日志记录"); // log4j可以通过%X{userId来获取}
		MDC.put("userName", "123");
		try{
			chain.doFilter(request, response);
		} finally {
			MDC.clear(); // 请求结束，注意清理MDC的内容
		}
	}

	@Override
	public void init(FilterConfig arg0) throws ServletException {
		System.out.println("filter初始化了");
	}
	
}

2.4 将过滤器配置到web.xml配置文件中

<!-- log4j写入数据库 -->
<filter>
    <filter-name>log4j MDC for log</filter-name>
    <filter-class>filter.ResFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>log4j MDC for log</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

2.5 在Controller控制层

MDC.put("userId", id);
MDC.put("userName", user.getUserName());
logger.info("登录成功");
通过这几步就可以将操作日志写入数据库及本地文件中，但是log4j 1.已经不更新了，主流还是使用log4j2配置进行记录日志操作日志。

三、log4j2

3.1 需要的jar包

log4j-api-2.11.0.jar

log4j-core-2.11.0.jar

log4j-web-2.11.0.jar

3.2 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别优先级，从低到高：all < trace < debug < info < warn < error < fatal < off -->
<!-- status用于设置log4j2自身内部信息输出，可以不设置 -->
<!-- monitorInterval:log4j能够自动检测修配置文件和重新配置本身，设置间隔秒数 -->
<configuration status="WARN" monitorInterval="1800">
	<!-- 先定义appender：日志需要输出的地方 -->
	<appenders>
		<!-- 输出到控制台的配置 -->
		<console name="Console" target="SYSTEM_OUT">
			<!-- 输出日志的格式 -->
			<PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%p] -%l -%m%n"/>
		</console>
		
		<!-- 日志文件打印出所有信息,这个log每次运行都会自动清空,由append属性决定，适合临时测试用 -->
		<File name="textlog" fileName="log/test.log" append="false">
			<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
		</File>
		
		<!-- 日志会打印出info及以下级别的信息,每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
		<RollingFile name="RollingFileInfo" fileName="D:/log/info.log"
				filePattern="${sys:user.home}/log/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
			<!-- 控制台只输出level及以上级别的信息(onMatch)，其它的直接拒绝(onMisMath) -->
			<ThresholdFilter level="info" onMatch="ACCEPT" onMisMatch="DENY"></ThresholdFilter>
			<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
			<Policies>
				<TimeBasedTriggeringPolicy/>
				<SizeBasedTriggeringPolicy size="100 MB"/>
			</Policies>
		</RollingFile>
		<RollingFile name="RollingFileWarn" fileName="D:/log/warn.log"
                      filePattern="${sys:user.home}/log/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
             <DefaultRolloverStrategy max="20"/>
         </RollingFile>
         <RollingFile name="RollingFileError" fileName="D:/log/error.log"
                      filePattern="${sys:user.home}/log/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
         
         <!-- 当日志文件超过一定大小。另起一个文件继续写入日志 -->
         <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/%d{yyyy-MM-dd HH-mm}-%i.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            <Policies>
                <!-- <TimeBasedTriggeringPolicy interval="1"/> --> <!-- 每隔一分钟产生一个文件，主要看filePattern中的%d -->
                <SizeBasedTriggeringPolicy size="10 MB"/> <!-- 指定当文件体积大于size指定的值时，触发Rolling -->
            </Policies>
            <DefaultRolloverStrategy max="20"/>
        </RollingRandomAccessFile>

        <Async name="AsyncAppender">
            <AppenderRef ref="RollingRandomAccessFile"/>
        </Async>
         
         <JDBC name="database" tableName="log">
         	<ConnectionFactory class="dbconnection.ConnectionFactory" method="getDatabaseConnection"/>
         	<Column name="userid" pattern="%X{userId}"/><!-- 获取Controller层中ThreadContext中定义的值 -->
         	<Column name="username" pattern="%X{userName}"/>
         	<Column name="class" pattern="%c"/><!-- 类名 -->
         	<Column name="method" pattern="%M"/><!-- 方法名 -->
         	<Column name="createtime" isEventTimestamp="true"/><!-- 日志创建时间 -->
         	<Column name="loglevel" pattern="%-5level"/><!-- 输出日志等级 -->
         	<Column name="message" pattern="%msg"/><!-- logger.里面的提示信息 -->
         </JDBC>
         
	</appenders>
	 <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
     <loggers>
         <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
         <logger name="org.springframework" level="INFO"></logger>
         <logger name="org.mybatis" level="INFO"></logger>
         <logger name="AsyncFileLogger" level="info" additivity="true">
         	<appender-ref ref="RollingRandomAccessFile" />
         </logger>
         
         <root level="all">
             <!-- <appender-ref ref="Console"/> -->
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
             <appender-ref ref="database"/>
             <appender-ref ref="AsyncAppender"/>
         </root>
     </loggers>
</configuration>

3.3 在web.xml配置文件中加入log4j2配置文件

加载配置文件

<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>classpath:log4j.xml</param-value>
</context-param>

加入spring监听

<listener>
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

3.4 配置数据量连接类

配置文件中是通过ConnectionFactory来引入对应包名下类和方法，在引入时需要注意包名、类名、方法名要完全一致

public static Connection getDatabaseConnection() throws SQLException {
    DriverManagerDataSource ds = new DriverManagerDataSource();
    ds.setDriverClassName("com.mysql.jdbc.Driver");
    ds.setUrl("jdbc:mysql://localhost:3306/manage?characterEncoding=utf-8");
    ds.setUsername("root");
    ds.setPassword("123456");
    return ds.getConnection();
}

3.5 在控制层写入相关代码

// 定义logger
private static Logger logger = LogManager.getLogger(UserController.class);

在相关读写操作中加入

ThreadContext.put("userId", String.valueOf(user.getUserId())); // “userId”的值再配置文件中通过%X{userId}获取
ThreadContext.put("userName", user.getUserName());
logger.info("添加成功");
经过上述步骤配置，就可以将相关的操作记录同步到数据库和本地文件之中。

版权声明：欢迎转载, 转载请保留原文链接。https://mp.youkuaiyun.com/postedit/80230512

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值