Java日志框架概览
在日志处理上，Java采用的是一种可扩展的方式。既可以使用jul（java.util.logging），也可以使用其它的日志解决方案。
jul 有4个核心组件：
- Logger：获取日志事件并传递给适当的Handler
- Handler(Appender)：使用Layout格式化日志事件，并输出到最终目的地
- Layout（Formatter）：格式化日志事件
- Filter：比log levels更细化地控制哪些日志可以输出
除了jdk自带的jul，还有很多Java log 框架：
- Log4j（首选Log4j2）
- Logback
- tinylog
两种门面框架：
- SLF4J（首选）
- Apache Commons Logging
所以目前流行的组合是SLF4J+Log4j2
入门示例
阿里巴巴Java手册强制使用门面API，而不能使用具体日志框架的API
所以我们使用SLF4J作为统一的日志API
第一步：Maven依赖：
<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-slf4j-impl -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>2.11.2</version>
</dependency>第二步：使用Logger试试看
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Test {
private static final Logger logger = LoggerFactory.getLogger(Test.class);
public static void main(String[] args) {
String facedName="SLF4J";
String frameworkName="Log4j2";
logger.error("Hello Logging from {} and {},没有配置文件，仅打印errors到控制台",facedName,frameworkName);
}
}运行后输出如下：
第三步：Log4j2配置
从上面输出可以看到，我们需要配置Log4j2，配置方式有很多种：
- 配置文件（推荐），支持XML, JSON, YAML, properties等格式.
- 编程，使用ConfigurationFactory
- 编程，使用Configuration 接口
- 编程，使用Logger类方法
自动配置：
Log4j has the ability to automatically configure itself during initialization.
当Log4j启动时，会查找所有的ConfigurationFactory，并按顺序排列：
- 系统变量 log4j.configurationFile 指定的配置文件
- 类路径下的 log4j2-test.properties 文件
- 类路径下的 log4j2-test.yaml 或 log4j2-test.yml 文件
- 类路径下的 log4j2-test.json 或 log4j2-test.jsn 文件
- 类路径下的 log4j2-test.xml 文件
- 类路径下的 log4j2.properties 文件
- 类路径下的 log4j2.yaml 或 log4j2.yml 文件
- 类路径下的 log4j2.json 或 log4j2.jsn 文件
- 类路径下的 log4j2.xml 文件
- DefaultConfiguration
上面的示例因为使用的是DefaultConfiguration，所以它相当于是这样的配置：
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>Log4j2配置文件
以XML为例，基本格式为：
<?xml version="1.0" encoding="UTF-8"?>;
<Configuration>
<Properties>
<Property name="name1">value</property>
<Property name="name2" value="value2"/>
</Properties>
<Filter type="type" ... />
<Appenders>
<Appender type="type" name="name">
<Filter type="type" ... />
</Appender>
...
</Appenders>
<Loggers>
<Logger name="name1">
<Filter type="type" ... />
</Logger>
...
<Root level="level">
<AppenderRef ref="name"/>
</Root>
</Loggers>
</Configuration>配置Loggers
A LoggerConfig is configured using the logger element.
属性：
- name：必须
- level：取值为TRACE, DEBUG, INFO, WARN, ERROR（默认）, ALL或OFF
- additivity：布尔值，默认是true，此时该logger的记录的事件也会在父logger中记录，造成打印两条日志，所以一般要使用false
AppenderRef：
The LoggerConfig may also be configured with one or more AppenderRef elements.
每个关联的AppenderRef都会收到这个logger发布的日志事件
Root：
Every configuration must have a root logger.
如果没有配置Root，自动配置会使用默认的Root配置，level=ERROR，AppenderRef为Console。
Root 没有name属性，也没有additivity属性。
配置Appenders
An appender is configured using the specific appender plugin’s name
每个appender必须有一个唯一的name属性，以便loggers引用。
大部分appenders都支持配置Layout来格式化输出日志。
不同的appender还有一些特有的配置。
配置Filters
Filter可以在四种不同的位置配置：
- 与Appenders, Loggers和Properties元素平级，过滤规则对所有的loggers有效
- 在Logger元素中，过滤规则仅对该logger有效
- 在Appender元素中，过滤规则仅对该appender有效
- 在AppenderRef元素中，决定是否把该log发送给这个Appender
可以使用filters元素包含多个过滤器的定义。
一个简单配置示例
<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="WARN" monitorInterval="30">
<!--先定义所有的appender-->
<appenders>
<!--这个输出控制台的配置-->
<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式-->
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
</console>
<!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
<File name="log" 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="${sys:user.home}/logs/info.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
filePattern="${sys:user.home}/logs/$${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="${sys:user.home}/logs/error.log"
filePattern="${sys:user.home}/logs/$${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>
</appenders>
<!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
<loggers>
<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.mybatis" level="INFO"></logger>
<root level="all">
<!--其他logger输出所有的日志信息-->
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
