logback日志教程
发布时间：2019-11-14 08:28:03
一、为什么我们放弃传统的log4j，而选择logback
（1）执行速度快，耗内存少
因为logback拥有更快的执行速度，它重写了内部的实现，速度更快，所需内存更少。
（2）修改配置文件无须重启服务自动重新载入
使用xml或者Groovy风格的配置文件，同时支持自动重新载入配置文件，logback-classic包可以在配置文件被修改后，无须重启服务自动重新载入。这个扫描过程很快，无资源争用。
（3）FileAppender和它的子类，包括RollingFileAppender，可以优雅的从I/O错误中恢复
FileAppender和它的子类，包括RollingFileAppender，可以优雅的从I/O错误中恢复。所以，如果一个文件服务器临时宕机，你再也不需要重启你的应用，而日志功能就能正常工作。当文件服务器恢复工作，logback相关的appender就会透明地和快速的从上一个错误中恢复。
（4）自动清除旧的日志归档文件
通过设置TimeBasedRollingPolicy 或者 SizeAndTimeBasedFNATP的 maxHistory 属性，你就可以控制日志归档文件的最大数量。如果你的回滚策略是每月回滚的，并且你希望保存一年的日志，那么只需简单的设置maxHistory属性为12。对于12个月之前的归档日志文件将被自动清除。
（5）自动压缩归档日志文件
RollingFileAppender可以在回滚操作中，自动压缩归档日志文件。压缩通常是异步执行的，所以即使是很大的日志文件，你的应用都不会因此而被阻塞。
（6）配置文件中的条件处理
开发者通常需要在不同的目标环境中变换logback的配置文件，例如开发环境，测试环境和生产环境。这些配置文件大体是一样的，除了某部分会有不同。为了避免重复，logback支持配置文件中的条件处理，只需使用
（7）强大的过滤功能
Logback拥有远比log4j更丰富的过滤能力。例如，让我们假设，有一个相当重要的商业应用部署在生产环境。考虑到大量的交易数据需要处理，记录级别被设置为WARN，那么只有警告和错误信息才会被记录。现在，想象一下，你在开发环境遇到了一个bug，但是在测试平台中却很难发现，因为一些环境之间(生产环境/测试环境)的未知差异。
使用log4j，你只能选择在生产系统中降低记录的级别到DEBUG，来尝试发现问题。但是很不幸，这会生成大量的日志记录，让分析变得困难。更重要的是，多余的日志记录会影响到生产环境的性能。
使用logback，你可以选择保留只所有用户的WARN级别的日志，而除了某个用户，例如Alice，而她就是问题的相关用户。当Alice登录系统，她就会以DEBUG级别被记录，而其他用户仍然是以WARN级别来记录日志。这个功能，可以通过在配置文件的XML中添加 ：
（8）SiftingAppender是一个全能的追加器
它可以基于任何给定的实时属性分开（或者筛选）日志。例如，SiftingAppender可以基于用户会话分开日志事件，这样，可以为每一个用户建立一个独立的日志文件。 堆栈轨迹信息将快速的告诉读者，关于异常发生的类还有包和包的版本。当你的客户发送一个堆栈轨迹信息给你，作为一个开发人员，你就不需要让他们告诉你他们正在使用的包的版本。这项信息已经包括在堆栈轨迹信息中。
（9）logback-access模块,提供http访问日志的能力
该模块可与jetty或者tomcat进行集成，提供非常丰富而强大的通过http访问日志的功能。
二、logback三大模块
1）Logback 分为三个模块：Core 、Classic 、 Access。
2) Core模块是其他两个模块的基础。 Classic模块扩展了core模块。
Classic模块相当于log4j的显著改进版。Logback-classic 直接实现了 SLF4J API。要引入logback，由于Logback-classic依赖slf4j-api.jar和logback-core.jar，所以要把slf4j-api.jar、logback-core.jar、logback-classic.jar，添加到要引入Logback日志管理项目的maven pom.xml中。
3、logback的加载原理
我们通过maven工程引入logback所需jar包，以及slf4j包：
<dependency>
<groupId>ch.qos.logbackgroupId>
<artifactId>logback-classicartifactId>
<version>1.1.2version>
dependency>
<dependency>
<groupId>ch.qos.logbackgroupId>
<artifactId>logback-coreartifactId>
<version>1.1.2version>
dependency>
<dependency>
<groupId>org.slf4jgroupId>
<artifactId>slf4j-apiartifactId>
<version>1.7.5version>
dependency>
编写测试类：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.core.util.StatusPrinter;
public class HelloWorld {
public static void main(String[] args) {
//Logger logger = LoggerFactory.getLogger("HelloWorld");
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.debug("Hello world.");
// 查看加载状态
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
StatusPrinter.print(lc);
}
}
【没有配置logback文件的日志打印】
SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/C:/Documents%20and%20Settings/Administrator/.m2/repository/ch/qos/logback/logback-classic/1.1.2/logback-classic-1.1.2.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/C:/Documents%20and%20Settings/Administrator/.m2/repository/org/slf4j/slf4j-log4j12/1.7.5/slf4j-log4j12-1.7.5.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]
21:33:12.453 [main] DEBUG HelloWorld - Hello world.
21:33:12,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.groovy]
21:33:12,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback-test.xml]
21:33:12,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.xml]
21:33:12,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Setting up default configuration.
【分析】
1）首先红色的日志，由于logback-classic是调用内部的slf4j绑定logback配置文件，初始化工厂类(ps:作者未另起炉灶，客户端还是由slf4j调用，好像是在slf4j 1.56以后的版本的pom.xml中配置了移除调用初始化配置文件的org.slf4j.impl功能块，而将之加到了logback-classic中的，另外加入了它自己的方法，动态修改配置文件不重启。)，此时项目中还有一个slf4j-log4j12-1.7.5.jar中也有org.slf4j.impl功能块,重复绑定造成。
2）另外logback.classic.LoggerContext会在classpath 顺序查找logback.groovy,logback-test.xml,logback.xml文件，如果都未找到，就启用默认的配置。
3）配置文件在log4j里通常叫做log4j.xml，在logback里是logback.xml，或者，在测试环境里叫做logback-test.xml。
4）在Maven project里，logback.xml文件必须放在$PROJECT_HOME/src/main/resources目录中。logback-test.xml文件必须放在$PROJECT_HOME/src/test/resources目录中。简单的配置文件可以象这样来写：
4、logger有效级别
logback中一共有5种有效级别，分别是TRACE、DEBUG、INFO、WARN、ERROR，优先级依次从低到高，logger之间的级别也有继承关系，但这里就不阐述了。
5、配置文件语法规则
（1）简单配置分析
logback的配置文件还是非常简单，它的根节点是
word/media/image1.gif
图（1）
如下代码所示是一个最简单的配置：
以上配置中定义了一个appender和一个root，appender可以理解为logback输出的目的地，root节点是根logger的意思，这里定义了根logger的输出就是控制台。
pattern节点中定义的是输出的模式规则：
%d{HH:mm:ss.SSS}：当前时间
[%thread]：线程名
%-5level：logger定义的级别
%logger{36}：logger名称
-%msg%n：定义的输出
如下代码：
Loggerlogger = LoggerFactory.getLogger(LogBackAction.class);
logger.debug("Hellologback debug.");
输出：
13:13:51.625["http-apr-8080"-exec-6] DEBUG app.action.LogBackAction - Hellologback debug.
（2）控制输出级别
logback日志级别一共有5种，可以通过配置文件输出指定级别的日志信息。
在以上配置文件中添加如下代码：
表示命名为“app.action.LogBackAction”的logger只输出info级别的日志信息。
（3）配置appender
appender可以包含0过或多个layout节点，0个或多个encoder节点，0个或多个filter节点，如下图所示：
图（2）
输出到文件的appender，配置如下：
如上配置后日志信息将写入到myApp.log文件中,默认情况下logback会将日志信息追加到日志文件中，如果在appender中加入
logback配置文件中还可以设置时间戳，这样的话就可以将日志信息输出到日期的指定文件中，如下配置：
appender配置如下：
以上配置日志信息就会写入一个“myApp”+ “yyyy-MM-dd”的文件中。
以上appender中使用到的类是FileAppdener,也就是基本的文件输出，logback中还有RollingFileAppender继承FileAppender,能够滚动记录文件。也就是当符合某个条件时，可以将日志信息记录到其他日志文件中。如果想用RollingFileAppender则需要配置RollingPolicy和TriggerPolicy，分别表示滚动策略和触发策略。
示例如下：
以上代码配置了RollingFileAppender,rollingPolicy定义为FixedWindwoRollingPolicy，这个滚动策略表示当满足了一定的触发策略后，logback会将日志信息写入到其他的日志文件中。配置了FixedWindowRollingPolicy后需要配置以下节点信息：
假设生成三个日志归档文件，test.1.log、test.2.log、test.3.log,则test.1.log文件代表最先写入的那个文件，当三个文件都写满后会先删除test.3.log文件，依次循环。
logback中还有基于时间的rollingPolicy，配置如下：
以上配置的保存30天的根据fileNamePattern的命名规则创建归档文件，日志信息则写入新的文件中。
有时当你在按照日期进行归档时还想对日志文件大小进行限制，可以使用logback中的SizeAndTimeBasedFNATP，它是TimeBasedRollingPolicy的子组件，FNATP代表“文件命名和触发策略”。
配置如下：
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
以上配置表示媒体的日志文件不能超过100MB,一旦超过就要归档。
六、配置文件详解
（1）根节点
scan
当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod
设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug
当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
例如 ：
（2）根节点
2.1)设置上下文名称：
每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用
2.2)设置变量
用来定义变量值的标签，
例如使用
2.3)获取时间戳字符串
两个属性 key:标识此
例如将解析配置文件的时间作为上下文名称：
2.4)设置Logger、Appenders和 Layouts
name:
用来指定受此logger约束的某一个包或者具体的某一个类。
level:
用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
如果未设置此属性，那么当前loger将会继承上级的级别。
addtivity:
是否向上级logger传递打印信息。默认是true。
也是
level:
用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。
<2.4.1>如果是ConsoleAppender，填写
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>
%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
pattern>
encoder>
appender>
具体的参数说明对照第五条第一点。
<2.4.2>如果是FileAppender
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>myApp.logfile>
<encoder>
<pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%npattern>
encoder>
appender>
<2.4.3>如果是RollingFileAppender
滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
rollingPolicy：
TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
<fileNamePattern>:
必要节点，包含文件名及“%d”转换符， “%d”可以包含一个 java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。 RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory>:
可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且 <maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
FixedWindowRollingPolicy： 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
<fileNamePattern >:
必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip
triggeringPolicy:
SizeBasedTriggeringPolicy： 查看当前活动文件的大小，如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:
举例：
另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这些就不在这里讲解了，大家可以参考官方文档。当然大家可以编写自己的Appender。
总结
所有的
目前PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个
转换符 作用
格式修饰符，与转换符共同使用：
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐 标志，符号是减号“-”；接着是可选的最小宽度 修饰符，用十进制数表示。如果字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。如果字符大于最小宽度，字符永远不会被截断。最大宽度 修饰符，符号是点号"."后面加十进制数。如果字符大于最大宽度，则从前面截断。点符号“.”后面加减号“-”在加数字，表示从尾部截断。
例如：%-4relative 表示，将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。
七、项目实战
1. 准备工作：
以maven工程为例，在pom.xml引入slf4j的jar,logback-core ,logback-classic2个jar包，另外在 src/main/resources目录下新建logback. groovy或logback-test.xml或logback.xml ,不写配置文件也行，系统会默认以debug默认打印控制台。
2. 在项目中调用：
private static final Logger log = LoggerFactory.getLogger(CmsArticleController.class);
然后log可按过滤等级低-->高依次可调用trace(),debug(),info(),warn(),error。
另外可以在方法中引入{}占位符，比如 String aa="中药材电商"; log.trace("我的项目:{}",aa);
3.接下来直接上项目logback.xml
xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n
pattern>
encoder>
appender>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>c://1.logfile>
<encoder>
<pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n
pattern>
encoder>
appender>
<appender name="SYSLOG" class="ch.qos.logback.classic.net.SyslogAppender">
<syslogHost>10.3.1.161syslogHost>
<port>514port>
<facility>LOCAL7facility>
<suffixPattern>%date ${MODULE} job.log [%thread] %logger{0}\(%L\) %p
%msgsuffixPattern>
appender>
<logger name="com.jointown.zy.cms.controller" level="DEBUG">
<appender-ref ref="STDOUT" />
logger>
<logger name="com.ibatis" level="DEBUG" />
<logger name="com.ibatis.common.jdbc.SimpleDataSource" level="DEBUG"
/>
<logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG" />
<logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" level="DEBUG"
/>
<logger name="java.sql.Connection" level="DEBUG" />
<logger name="java.sql.Statement" level="DEBUG" />
<logger name="java.sql.PreparedStatement" level="DEBUG" />
<root level="DEBUG">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
root>
configuration>
4.配置额外分析
从配置文件来看，我们配置了3个appender，实际引用了2个,分别是控制台输出，文件输出，然后root归总执行生产日志（root默认level就是DEBUG,这里可直接
另外由于配置中提到SyslogAppender，为了远程syslog收集日志信息，在生产环境配置了syslog。利用之前提到的
这里简单说下SyslogAppender里面的几个参数：
syslogHost ： syslog所在服务器ip；
port ： 服务端口，通常情况下，默认514不需要修改，可省略；
facility ：该属性是确定消息的来源，可不设置。目前有：KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7。
suffixPattern ：指定输出内容格式。可参考6.2.4.3
* 如果还有对配置日志数据库感兴趣的，如下 (未实践)：
相关推荐
高三学生励志演讲稿
四年级作文：我喜欢秋天作文400字 - 1
高一散文：21克
古代汉语 - 被动句和被动表示法
《小雨落在我的胸口 太极》歌词 音乐合辑[港台]
终身做科学实验的爱迪生
（部编版）2020八年级语文下册第六单元24唐诗二首 - 茅屋为秋风所破歌杜甫教案新
初一作文：我心中的好声音作文800字 - 2
最新学前教育幼儿园小班社会教案我们都是好朋友 doc
一年级期末考试家长寄语范例精选
