在Java下利用log4j记录日志的方法_JAVA教程

在Java下利用log4j记录日志的方法

2020-06-17 12:00一路前行 JAVA教程

本文先对log4j进行了简短的介绍，而后通过安装、配置和普通项目和web项目几个方面来详细介绍了在Java下利用log4j记录日志的方法，有需要的朋友们可以参考借鉴。

1、前言

log4j是一个用Java编写的可靠，快速和灵活的日志框架（API），它在Apache软件许可下发布。 Log4j已经被移植到了C，C++，C＃，Perl，Python和Ruby等语言中。

Log4j是高度可配置的，并可通过在运行时的外部文件配置。它根据记录的优先级别，并提供机制，以指示记录信息到许多的目的地，例如：数据库，文件，控制台，UNIX系统日志等。

Log4j中有三个主要组成部分：

loggers: 负责捕获记录信息。

appenders : 负责发布日志信息，以不同的首选目的地。

layouts: 负责格式化不同风格的日志信息。

注意：本文是基于log4j 2.X及以上版本。

2、安装

log4j-core-xx.jar

log4j-api-xx.jar

log4j-web-xx.jar（web项目的需要引用）

3、配置

准备些日志的类添加如下引用：

				?

									import org.apache.logging.log4j.LogManager;

									import org.apache.logging.log4j.Logger;

				?

									static Logger logger = LogManager.getLogger(Test.class.getName());

配置文件位置位于：src根目录下，即使没有配置文件的话也不会报错，默认以console的形式进行输出。

log4j2配置文件与log4（1.X版本的有很大不同），只能采用.xml、.json或者 .jsn格式，具体配置如下（${web:rootDir} 表示web根目录）：

				?

									<?xml version="1.0" encoding="UTF-8"?>

									<configuration status="error">

									 <!--先定义所有的appender-->

									 <appenders>

									  <!--这个输出控制台的配置-->

									  <Console name="Console" target="SYSTEM_OUT">

									   <!--这个是输出日志的格式-->

									   <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>

									  </Console>

									  <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->

									  <File name="Error" fileName="${web:rootDir}/logs/error.log" append="false">

									   <!--文件只记录level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->

									   <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>

									   <PatternLayout charset="UTF-8" pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>

									  </File>

									  <!--这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->

									  <RollingFile name="RollingFile" fileName="${web:rootDir}/logs/history.log"

									      filePattern="log/$${date:yyyy-MM}/history-%d{MM-dd-yyyy}-%i.log.gz">

									   <PatternLayout charset="UTF-8" pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>

									   <SizeBasedTriggeringPolicy size="50MB"/>

									  </RollingFile>

									 </appenders>

									 <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->

									 <loggers>

									  <!--建立一个默认的root的logger-->

									  <root level="trace">

									   <appender-ref ref="Error"/>

									   <appender-ref ref="RollingFile"/>

									   <appender-ref ref="Console"/>

									  </root>

									 </loggers>

									</configuration>

4、普通项目和web项目

对于普通项目来讲，进行以上配置完成后即可以正常使用，对于web项目来讲，是不会生成日志文件的。需要在web.xml里面<web-app>根节点下添加如下配置：

				?

									<!-- log4j2.x start -->

									<listener>

									 <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>

									</listener>

									<filter>

									 <filter-name>log4jServletFilter</filter-name>

									 <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>

									</filter>

									<filter-mapping>

									 <filter-name>log4jServletFilter</filter-name>

									 <url-pattern>/*</url-pattern>

									</filter-mapping>

									<!-- log4j2.x end -->