java中log4j的使用入门

一、log4j是什么？有什么用？

Log4j由非营利的阿帕奇软件基金会免费提供，已被下载数百万次，是一种从企业计算机网络、网站和应用程序中收集信息的广泛使用工具。该软件目前由阿帕奇的志愿者维护。

Log4j框架可以用来记录用户操作和应用程序行为以供后续审查。这些数据在程序发生bug时，是非常有用的，可以帮助快速定位到问题在哪行代码，尤其是在线上生产环境下。

目前很多框架都使用log4j，以至于当时阿里发现log4j漏洞后，影响面积那么大。

二、引入log4j框架

这里使用Maven配置来引入。
创建完Maven项目后，在pom.xml文件中写入如下配置：

<dependencies> <!-- 若已存在，则在其内容中追加以下内容 -->
  	<!-- log -->
  	<dependency>  	
  		<groupId>org.apache.logging.log4j</groupId>
  		<artifactId>log4j-core</artifactId>
  		<version>2.17.0</version> <!-- 要引入的版本号，若有主框架parent节点，且主框架有指定，可不写 -->
  	</dependency>
</dependencies>

内容写入完成后保存，若网络正常或本地Maven库有资源，则项目中将自动导入2个jar包，完成log4j框架的引入。

三、配置log4j

引入后，还不能直接使用，否则会报错：

// 调用，getLogger有多种参数，与log4j2.xml中的logger节点配置有关
org.apache.logging.log4j.Logger logger= org.apache.logging.log4j.LogManager.getLogger("XWeb");
logger.debug("debug!!!!!");
// 报错
ERROR StatusLogger No Log4j 2 configuration file found.

在src/main/resources文件夹下创建log4j2.xml文件。

创建完之后，就需要开始写配置了，如果配置内容不正确，会报错，无法正常使用。下面是基本配置内容：

<configuration status="warn" monitorInterval="5">
	<!-- 属性，如果有需要重复使用的值，可以先设置，再通过${name}来使用 -->
	<Properties>
		<Property name="XLogDir">G:/logs/familyTV</Property>
	</Properties>
	
	<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
	<appenders>
		<!-- 这个设置控制台输出哪些级别的日志 -->
		<console name="Console" target="SYSTEM_OUT">
			<Filters>
				<!--控制台只输出level及其以上级别的信息（onMatch匹配），其他的直接拒绝（onMismatch）-->
				<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY" />
			</Filters>
			<!--输出日志的格式-->
			<PatternLayout pattern="[%d{DEFAULT}] [%p] - %l- %m%n" />
		</console>
		
		<!-- 这个配置会将ERROR、WARN、INFO的日志写到文件，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
		<RollingFile name="RollingFileInfoWarn" fileName="${XLogDir}/infoWarn.log" filePattern="${XLogDir}/$${date:yyyy-MM}/infoWarn-%d{yyyyMMdd}-%i.log">
			<Filters>
				<ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL" />
				<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />
			</Filters>
			<PatternLayout pattern="[%d{DEFAULT}] [%p] - %l- %m%n" />
			<Policies>
				<!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
				<SizeBasedTriggeringPolicy size="200MB" />
			</Policies>
			<!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
			<DefaultRolloverStrategy max="10" />
		</RollingFile>
		
		<!-- 这个配置会将ERROR以上的日志写到文件，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
		<RollingFile name="RollingFileError" fileName="${XLogDir}/error.log" filePattern="${XLogDir}/$${date:yyyy-MM}/error-%d{yyyyMMdd}-%i.log">
			<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY" />
			<PatternLayout pattern="[%d{DEFAULT}] [%p] - %l- %m%n" />
			<Policies>
				<!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
				<SizeBasedTriggeringPolicy size="200MB" />
			</Policies>
			<!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
			<DefaultRolloverStrategy max="10" />
		</RollingFile>
	</appenders>
	
	<!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
	<loggers>
		<!--监控系统信息-->
        <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
        <logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        
		<!--过滤掉spring和mybatis的一些无用的DEBUG信息，所以level=info -->
		<!--若是additivity设为false，则子Logger只会在自己的appender里输出，为true时则会追加父Logger的appender。-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        
		<!-- name值可作为创建Logger时的参数，对应的Logger对象将使用level指定的等级 -->
		<!-- 注意，若appender中的level级高，则以appender的level为准 -->
		<logger name="AihumanWeb" level="DEBUG" additivity="false"/><!-- false则无appender不输出，true则追加root的appender -->
		<logger name="org.hibernate" level="ERROR" />
		<!-- rootLogger(根记录器)的配置，可被子logger继承追加，未匹配子logger时记录器将使用该level -->
		<root level="ERROR">
			<appender-ref ref="Console" />
			<appender-ref ref="RollingFileInfoWarn" />
			<appender-ref ref="RollingFileError" />
		</root>
	</loggers>
</configuration>

四、说明

Log4j有三个主要的组件：Loggers(记录器)，Appenders(输出源)和Layouts(布局)。其中：
Logger负责记录日志；
Appender负责输出到什么地方；
Layout负责以什么格式输出，输出哪些附加信息等。
综合使用这三个组件可以轻松的记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。