系统日志框架搭建

1. 市面是最通用的是 log4j2+slf4j。理由是用slf4j实现借口便于日后可能的日志框架迁移，用log4j2实现日志核型。毕竟是2.0版本,取长补短过。需要注意的是， log4j2 和 log4j的版本groupId、artifactId都是一样的，区别是version不一样-- 1.X / 2.X。让我疑惑了很久。官网也找不到1.X的介绍了，看来是不再维护了。

用log4j2+slf4j配置的写法是

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private Logger logger = LoggerFactory.getLogger(getClass());

如果只用log4j2,不用slf4j，写法是

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;

private static Logger logger = LogManager.getLogger(getClass());

2.需要用到的最低配置jar包下。需要注意的事，大概率会出现jar包冲突，如slf4j-simple、slf4j-log4j-imp等，会显示Class path contains multiple SLF4J bindings。找到冲突的jar包排除即可。

<!--日志 slf4j 核心包  -->
 <dependency>
     <groupId>org.slf4j</groupId>
     <artifactId>slf4j-api</artifactId>
     <version>1.7.12</version>
 </dependency>
 <dependency>
     <groupId>org.slf4j</groupId>
     <artifactId>jcl-over-slf4j</artifactId>
     <version>1.7.1</version>
 </dependency>
 <!--日志 log4j2 核心包  -->
 <dependency>
     <groupId>org.apache.logging.log4j</groupId>
     <artifactId>log4j-core</artifactId>
     <version>2.5</version>
 </dependency>
 <!--日志 log4j-slf4j 集合包  -->
 <dependency>
     <groupId>org.apache.logging.log4j</groupId>
     <artifactId>log4j-slf4j-impl</artifactId>
     <version>2.5</version>
 </dependency>

如果想用异步记录日志，还需要

<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.3.2</version>
</dependency>

3. 官网的文档很坑，找了半天没有找到log4j2.xml的默认路径。对于maven、gradle项目，百度找到了默认路径是src-main-resources下。

4. log4j2配置项的意义中 <Appenders> <Loggers>

Appenders是定义一个日志输出格式，需要在loggers里使用ref进行引号才是一个日志系统的完整闭环。这么做的好处是appender可以重复使用了，可以应付复杂的日志配置。

Loggers里面有个很有用的配置项Logger，可以对不同包路径的下的logger差异化配置。比如我引用了spring的包，只想看到spring的info级别的，就用下面这样配置。

<Loggers>
    <Logger name="org.springframework" level="info">
        <AppenderRef ref="Console"/>
    </Logger>
    <Root level="debug">
        <AppenderRef ref="console"/>
        <AppenderRef ref="log"/>
    </Root>
</Loggers>

5. 异步配置

使用异步配置代替同步，提高服务器性能

用<asyncRoot>代替<Root> ,用<asyncLogger>代替<Logger>

6. slf4j的设计模式--门面模式

private static String STATIC_LOGGER_BINDER_PATH = "org/slf4j/impl/StaticLoggerBinder.class";

static Set<URL> findPossibleStaticLoggerBinderPathSet() {
    // use Set instead of list in order to deal with bug #138
    // LinkedHashSet appropriate here because it preserves insertion order
    // during iteration
    Set<URL> staticLoggerBinderPathSet = new LinkedHashSet<URL>();
    try {
        ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();
        Enumeration<URL> paths;
        if (loggerFactoryClassLoader == null) {
            paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
        } else {
            paths = loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);
        }
        while (paths.hasMoreElements()) {
            URL path = paths.nextElement();
            staticLoggerBinderPathSet.add(path);
        }
    } catch (IOException ioe) {
        Util.report("Error getting resources from path", ioe);
    }
    return staticLoggerBinderPathSet;
}

约定各个日志系统的开发者需要实现org/slf4j/impl/StaticLoggerBinder.class，即在各自的jar包实现这个类，对LoggerFactory类进行绑定。

约定各个日志系统的使用者只使用LoggerFactory。门面模式带来的好处就是对使用者来说，系统相当简单，容易上手。

7.最后，附上2个log4j.xml的配置文件，最简单的和项目实用的。

最简单的

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别 OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!-- status属性配置log4j2自身的日志信息打印级别 -->
<!-- packages插件类搜索目录 -->
<!-- monitorInterval配置文件重新加载间隔，单位为秒，最小间隔5秒 -->
<Configuration status="warn">
    <Appenders>
        <!-- 输出到控制台 -->
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="debug">
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

项目实用的：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别 OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!-- status属性配置log4j2自身的日志信息打印级别 -->
<!-- monitorInterval配置文件重新加载间隔，单位为秒，最小间隔5秒 -->
<Configuration status="info" packages="utry.core.log.appender" monitorInterval="5">
  <!-- 自定义属性 -->
  <Properties>
    <!-- 日志文件统一存放路径 -->
    <Property name="LOG_HOME">D://</Property>
    <!-- 模块名,使用子站名称 -->
    <Property name="SERVER_NAME">moduleName</Property>
  </Properties>
  <Appenders>
    <!-- 输出到控制台 -->  
    <Console name="console" target="SYSTEM_OUT">
        <PatternLayout pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n"/>
    </Console>
    <!-- 错误日志，输出到滚动保存的文件，按天切分 -->
    <RollingRandomAccessFile name="errorLog" immediateFlush="true" fileName="${LOG_HOME}/${SERVER_NAME}.log"  
            filePattern="${LOG_HOME}/${SERVER_NAME}.%d{yyyy-MM-dd}.log.gz">  
        <PatternLayout pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n" /> 
        <Policies>
            <TimeBasedTriggeringPolicy interval="1" modulate="true" />
        </Policies>
    </RollingRandomAccessFile>
    <!-- 调试日志，输出到滚动保存的文件，按大小切分 -->
    <RollingRandomAccessFile name="debugLog" immediateFlush="true" fileName="${LOG_HOME}/${SERVER_NAME}-debug.log"  
            filePattern="${LOG_HOME}/${SERVER_NAME}-debug.%i.log.gz">  
        <PatternLayout pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n" /> 
        <Policies>
            <SizeBasedTriggeringPolicy size="50 MB"/>
        </Policies>
        <DefaultRolloverStrategy max="10"/>
    </RollingRandomAccessFile>
  </Appenders>
  <Loggers>
    <!-- spring日志 -->
    <AsyncLogger name="org.springframework" level="info"></AsyncLogger>
    <!-- mybaits日志，debug级别可以看到执行的sql及参数 -->
    <AsyncLogger name="org.mybatis" level="error"></AsyncLogger>
    <AsyncRoot level="all">
        <!-- 控制台 -->
        <AppenderRef ref="console" level="off"/>
        <!-- 错误日志 -->
        <AppenderRef ref="errorLog" level="info"/>
        <!-- 调试日志，生产环境请注释 -->
        <!--<AppenderRef ref="debugLog" level="debug"/>-->
    </AsyncRoot>
  </Loggers>
</Configuration>

系统日志框架搭建

猜你喜欢