今天翻笔记的时候突然翻到一个文档, 上面是logback的相关内容，也不知道从哪里搞的，贴到这里吧；噶昂才看到一篇比较好的关于logback的文章，帖在这里吧
一、logback的简介
- logback当前分成三个模块：
- logback-core是其它两个模块的基础模块；
- logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging；
- logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能；
二、logback的使用
-
添加依赖(logback-access.jar用到的时候再添加；实际上引用logback-classic即可，依赖的库会被maven自动导入):
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j.version}</version> <scope>compile</scope> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>${logback.version}</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>${logback.version}</version> </dependency> -
添加配置文件，下面是我项目中用到的，做了详细的注释：
<?xml version="1.0" encoding="UTF-8"?> <!-- 根节点configuration: - scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 - scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 - debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 --> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <!-- property：用来定义变量值，它有两个属性name和value，通过<property>定义的值会被插入到logger上下文中，可以使"${}"来获取变量。--> <!-- 应用名称 --> <property name="APP_NAME" value="<app-name>" /> <!-- 日志输出格式: [%d{HH:mm:ss.SSS}][%p][%c{40}][%t] %m%n --> <property name="ENCODER_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{80} - %msg%n" /> <!--日志文件的保存路径,首先查找系统属性-Dlog.dir,如果存在就使用其；否则，在当前目录下创建名为logs目录做日志存放的目录 --> <property name="LOG_HOME" value="${log.dir:-logs}/${APP_NAME}" /> <property name="MAX_HISTORY" value="1" /> <!-- contextName: 用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。 但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。--> <contextName>${APP_NAME}</contextName> <!-- timestamp：获取时间戳字符串，他有两个属性key和datePattern key: 标识此<timestamp> 的名字； datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。 <timestamp key="XMLParseTime" datePattern="yyyyMMdd'T'HHmmss"/> --> <!-- appender：负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名 --> <!-- ConsoleAppender 把日志输出到控制台 --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoding>UTF-8</encoding> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <Pattern>${ENCODER_PATTERN}</Pattern> </encoder> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>DEBUG</level> </filter> </appender> <!-- 各种Appender: 1. FileAppender：把日志添加到文件，有以下子节点： - <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。 - <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。 - <encoder>：对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。 * PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个<pattern>节点，用来设置日志的输入格式。 使用"%"加"转换符"方式，如果要输出"%"，则必须用"\"对"\%"进行转义。 * <prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。 --> <!-- 2. RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点： - <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。 - <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。 - <rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类: * class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点： ~ <fileNamePattern>：必要节点，包含文件名及"%d"转换符，"%d"可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。 如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file子节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置， 当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。 "/"或者"\"会被当做目录分隔符。 ~ <maxHistory>:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。 注意，删除旧文件时，那些为了归档而创建的目录也会被删除。 * class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动。只有一个节点: <maxFileSize>:这是活动文件的大小，默认值是10MB。 * <prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。 * <triggeringPolicy>: 告知 RollingFileAppender何时激活滚动。 * class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点： ~ <minIndex>:窗口索引最小值 ~ <maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。 ~ <fileNamePattern>: 必须包含"%i",例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。 还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip 其他的Appender(SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender)参考官方文档: http://logback.qos.ch/documentation.html --> <!-- 文件日志：输出全部日志到文件 --> <appender name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>${MAX_HISTORY}</maxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${ENCODER_PATTERN}</pattern> </encoder> </appender> <!-- 警告日志：用于将警告界别以上的日志输出到独立文件 --> <appender name="WARNING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME}/warning.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>${MAX_HISTORY}</maxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${ENCODER_PATTERN}</pattern> </encoder> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>WARN</level> </filter> </appender> <!-- logger：用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name必选属性，一个可选的level和一个可选的addtivity属性。 可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger name: 用来指定受此logger约束的某一个包或者具体的某一个类。 level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF， 还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。 addtivity: 是否向上级logger传递打印信息。默认是true。同<logger>一样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。 --> <logger name="<package-name>" additivity="false" level="DEBUG" > <appender-ref ref="ALL_FILE"/> </logger> <!-- mybatis log 日志 --> <logger name="org.apache.ibatis" level="TRACE" /> <logger name="java.sql.Connection" level="DEBUG" /> <logger name="java.sql.Statement" level="DEBUG" /> <logger name="java.sql.PreparedStatement" level="DEBUG" /> <!-- <root>: 是所有<logger>的上级, 只有一个level属性 level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。 --> <root level="DEBUG"> <appender-ref ref="STDOUT"/> <appender-ref ref="ALL_FILE"/> <appender-ref ref="WARNING_FILE"/> </root> </configuration> -
在代码中就可以使用Logger了
public class LogBackTest{ private final static Logger logger = LoggerFactory.getLogger(LogBackTest.class); public static void main(String[] args) { logger.info("logback 成功了"); logger.error("logback 成功了"); logger.debug("logback 成功了"); } }
三、logback的常用配置
-
Hibernate专属配置
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" /> <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" /> <logger name="org.hibernate.SQL" level="DEBUG" /> <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" /> <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" /> -
MyBatis专属配置
<logger name="org.apache.ibatis" level="TRACE"/> <logger name="java.sql.Connection" level="DEBUG"/> <logger name="java.sql.Statement" level="DEBUG"/> <logger name="java.sql.PreparedStatement" level="DEBUG"/> -
常用的logback.xml
- 开发环境的配置：
<?xml version="1.0" encoding="UTF-8"?> <!-- 开发环境的日志输出配置 --> <configuration debug="true"> <property name="LOG_HOME" value="${catalina.base}/logs" /> <property name="MESSAGE_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n" /> <appender name="LOG_STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>${MESSAGE_PATTERN}</pattern> <charset>UTF-8</charset> </encoder> </appender> <logger name="java.sql.Connection" level="DEBUG" /> <logger name="java.sql.Statement" level="DEBUG" /> <logger name="java.sql.PreparedStatement" level="DEBUG" /> <logger name="org.apache.ibatis" level="TRACE" /> <root level="DEBUG"> <appender-ref ref="LOG_STDOUT" /> </root> </configuration> - 线上环境的配置：
<?xml version="1.0" encoding="UTF-8"?> <!-- 生产环境的日志输出配置 --> <configuration debug="true"> <property name="LOG_HOME" value="${catalina.base}/logs" /> <property name="MESSAGE_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n" /> <!-- 日志记录器，日期滚动记录 --> <appender name="LOG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/inquiry_current.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME}/inquiry_%d{yyyy-MM-dd}_%i.log</fileNamePattern> <maxFileSize>50MB</maxFileSize> <maxHistory>30</maxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${MESSAGE_PATTERN}</pattern> <charset>utf-8</charset> </encoder> </appender> <logger name="java.sql.Connection" level="DEBUG" /> <logger name="java.sql.Statement" level="DEBUG" /> <logger name="java.sql.PreparedStatement" level="DEBUG" /> <logger name="org.apache.ibatis" level="TRACE" /> <root level="DEBUG"> <appender-ref ref="LOG_FILE" /> </root> </configuration>- 需要注意的是，文件名规则中%d和%i都是不可或缺的部分，如果少了这些配置，日志就会不正常，如：少了%i，就会导致文件到了50M就不会再生成新的文件了...
- 开发环境的配置：
