美文网首页项目填坑
ssm框架使用slf4j+logback进行日志记录

ssm框架使用slf4j+logback进行日志记录

作者: 黄金矿工00七 | 来源:发表于2017-09-18 11:20 被阅读0次

    这几天使用使用ssm搭建项目框架时,开始使用log4j作为日志框架,但是springmvc已经不支持使用org.springframework.web.util.Log4jConfigListeners这个监听器,上网搜索了一番,果断采用了slf4j+logback进行日志记录,首先对他们做一个对比,slf4j是java的一个日志门面,实现了日志框架一些通用的api,log4j和logback是具体的日志框架。
    他们可以单独的使用,也可以绑定slf4j一起使用。
    单独使用。分别调用框架自己的方法来输出日志信息。
    绑定slf4j一起使用。调用slf4j的api来输入日志信息,具体使用与底层日志框架无关(需要底层框架的配置文件),具体关系如图

    使用slf4j绑定日志系统的优势
    软件工程的角度。抽象,解耦,便于维护
    语法设计角度。slf4j有{}占位符,而log4j需要用“+”来连接字符串,既不利于阅读,同时消耗了内存(heap memory)。

    • log4j与logback
      logback的优势:
    • 更快的执行速度
    • 充分的测试
    • logback-classic 非常自然的实现了SLF4J
    • 丰富的扩展文档
    • 可以使用使用XML配置文件或者Groovy
    • 自动重新载入配置文件
    • 优雅地从I/O错误中恢复
    • 自动清除旧的日志归档文件
    • 自动压缩归档日志文件

    好了下面进行详细的配置

    开发环境:

    • jdk1.8
    • maven3
    • idea2017
    • spring 4.3.9

    导入ssm所需jar包,此处不再进行叙述,
    日志管理所需jar包

          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-classic</artifactId>
          <version>1.1.11</version>
        </dependency>
        <dependency>
          <groupId>org.logback-extensions</groupId>
          <artifactId>logback-ext-spring</artifactId>
          <version>0.1.1</version>
        </dependency>
        <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>jcl-over-slf4j</artifactId>
          <version>1.7.25</version>
        </dependency>
    
    • 第一个logback-classic包含了logback本身所需的slf4j-api.jar、logback-core.jar及logback-classsic.jar
    • 第二个logback-ext-spring是由官方提供的对Spring的支持,它的作用就相当于log4j中的Log4jConfigListener;这个listener,网上大多都是用的自己实现的,原因在于这个插件似乎并没有出现在官方文档的显要位置导致大多数人并不知道它的存在
    • 第三个jcl-over-slf4j是用来把Spring源代码中大量使用到的commons-logging替换成slf4j,只有在添加了这个依赖之后才能看到Spring框架本身打印的日志,否则只能看到开发者自己打印的日志

    配置logback.xml

    使用maven,放置在resources目录下

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        <!-- 尽量别用绝对路径,如果带参数不同容器路径解释可能不同,以下配置参数在pom.xml里 -->
        <property name="log.root.level" value="${log.root.level}" /> <!-- 日志级别 -->
        <property name="log.other.level" value="${log.other.level}" /> <!-- 其他日志级别 -->
        <property name="log.base" value="${log.base}" /> <!-- 日志路径,这里是相对路径,web项目eclipse下会输出到eclipse的安装目录下,如果部署到linux上的tomcat下,会输出到tomcat/bin目录 下 -->
        <property name="log.moduleName" value="${log.moduleName}" />  <!-- 模块名称, 影响日志配置名,日志文件名 -->
        <property name="log.max.size" value="100MB" /> <!-- 日志文件大小,超过这个大小将被压缩 -->
    
        <!--控制台输出 -->
        <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <Pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level[%thread]%logger{56}.%method\(\):%L -%msg%n</Pattern>
            </encoder>
        </appender>
    
        <!-- 用来保存输出所有级别的日志 -->
        <appender name="file.all" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>${log.base}/${log.moduleName}.log</File><!-- 设置日志不超过${log.max.size}时的保存路径,注意如果 
                是web项目会保存到Tomcat的bin目录 下 -->
            <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <FileNamePattern>${log.base}/archive/${log.moduleName}_all_%d{yyyy-MM-dd}.%i.log.zip
                </FileNamePattern>
                <!-- 文件输出日志 (文件大小策略进行文件输出,超过指定大小对文件备份) -->
                <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log.max.size}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <!-- 日志输出的文件的格式 -->
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level[%thread]%logger{56}.%method\(\):%L -%msg%n</pattern>
            </layout>
        </appender>
        
        <!-- 这也是用来保存输出所有级别的日志 -->
        <appender name="file.all.other" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>${log.base}/${log.moduleName}_other.log</File>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <FileNamePattern>${log.base}/archive/${log.moduleName}_other_%d{yyyy-MM-dd}.%i.log.zip
                </FileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log.max.size}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{56}.%method\(\):%L -%msg%n</pattern>
            </layout>
        </appender>
    
        <!-- 只用保存输出error级别的日志 -->
        <appender name="file.error"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>${log.base}/${log.moduleName}_err.log</File>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <FileNamePattern>${log.base}/archive/${log.moduleName}_err_%d{yyyy-MM-dd}.%i.log.zip
                </FileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log.max.size}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{56}.%method\(\):%L - %msg%n</pattern>
            </layout>
            <!-- 下面为配置只输出error级别的日志 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
       <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <!-- 添加附加的appender,最多只能添加一个 -->
        <appender name="file.async" class="ch.qos.logback.classic.AsyncAppender">
            <discardingThreshold>0</discardingThreshold>
            <queueSize>256</queueSize>
            <includeCallerData>true</includeCallerData>
            <appender-ref ref="file.all" />
        </appender>
    
        <appender name="file.async.other" class="ch.qos.logback.classic.AsyncAppender">
            <discardingThreshold>0</discardingThreshold>
            <queueSize>256</queueSize>
            <includeCallerData>true</includeCallerData>
            <appender-ref ref="file.all.other" />
        </appender>
    
        <!-- 为某个包下的所有类的指定Appender 这里也可以指定类名称例如:com.aa.bb.ClassName -->
        <logger name="com.yyt" additivity="false">
            <level value="${log.root.level}" />
            <appender-ref ref="stdout" /> 
            <appender-ref ref="file.async" /><!-- 即com.li包下级别为 ${log.root.level}的才会使用file.async来打印 -->
            <appender-ref ref="file.error" />
        </logger>
        <logger name="org.apache.ibatis" level="DEBUG">
            <appender-ref ref="STDOUT"/>
        </logger>
    
        <logger name="java.sql" level="debug">
            <appender-ref ref="STDOUT"/>
        </logger>
        <!-- root将级别为${log.root.level}及大于${log.root.level}的日志信息交给已经配置好的名为“Console”的appender处理,“Console”appender将信息打印到Console,其它同理 -->
        <root level="${log.root.level}">
            <appender-ref ref="stdout" /> <!--  标识这个appender将会添加到这个logger -->
            <appender-ref ref="file.async.other" />
            <appender-ref ref="file.error" />
        </root>
    </configuration>
    

    注意mybatis日志管理
    logback.xml 中配置

    <logger name="java.sql" level="debug">
            <appender-ref ref="STDOUT"/>
        </logger>
    

    mybatis.xml中配置

        <!-- 设置日志打印 -->
        <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
        </settings>
    

    最后配置web.xml

    <!-- 日志记录,要配置在ContextLoaderListener之前 -->
    
      <context-param>
        <param-name>logbackConfigLocation</param-name>
        <param-value>classpath:log/logback.xml</param-value>
      </context-param>
      <listener>
        <listener-class>ch.qos.logback.ext.spring.web.LogbackConfigListener</listener-class>
      </listener>
    

    到这里,我们的配置已经完成了,可以使用了。

     private static final Logger logger = LoggerFactory.getLogger(监听的类.class);
    

    然后可以打印各个级别的日志信息了。

    相关文章

      网友评论

        本文标题:ssm框架使用slf4j+logback进行日志记录

        本文链接:https://www.haomeiwen.com/subject/cawvsxtx.html