1. 介绍
-
描述：主要由三个模块构成
logback-core：核心代码块（不介绍） logback-classic：实现了slf4j的api，加入该依赖可以实现log4j的api。 logback-access：访问模块与servlet容器集成提供通过http来访问日志的功能（也就是说不需要访问服务器，直接在网页上就可以访问日志文件,实现HTTP访问日志的功能）
2. 配置详解
-
configuration：有scan、sacnPeriod、debug、packagingData等属性。-
debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -
scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -
scanPeriod: 设置扫描配置文件的时间间隔，默认单位为毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -
示例：
<configuration scan="true" scanPeriod="60 seconds" debug="false"> <!-- 其他配置信息 --> </configuration>
-
-
子节点
contextName：用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。<configuration scan="true" scanPeriod="60 seconds" debug="false"> <contextName>myAppName</contextName> <!-- 其他配置省略--> </configuration> -
property:用来定义变量值，它有两个属性name和value，定义的值会被插入到logger上下文中，可以使${}来使用变量。<configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="APP_Name" value="myAppName" /> <contextName>${APP_Name}</contextName> <!-- 其他配置省略--> </configuration> -
timestamp：获取时间戳字符串，他有两个属性key和datePattern，遵循java.txt.SimpleDateFormat的格式。<configuration scan="true" scanPeriod="60 seconds" debug="false"> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> <contextName>${bySecond}</contextName> <!-- 其他配置省略--> </configuration> -
Appender：负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。appender class类型主要有三种：ConsoleAppender、FileAppender、RollingFileAppender-
ConsoleAppender：把日志输出到控制台-
encoder：对日志进行格式化 -
target：字符串System.out或System.err，默认System.out -
示例：
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> <Pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] --%mdc{client}%msg%n</Pattern> </encoder> </appender>
-
-
FileAppender：把日志输出到控制台file：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值append：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是trueencoder：对记录事件进行格式化prudent：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是false
-
RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。<configuration> <!--日志路径，当前是在项目的根下生成logs文件夹--> <property name="PATH" value="logs"/> <!--打印到控制台--> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> <Pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] --%mdc{client}%msg%n</Pattern> </encoder> </appender> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${PATH}/info.log</file> <!-- 最受欢迎的政策，可以按照天或者按照月 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!--归档的日志文件路径--> <FileNamePattern>${PATH}/info.%d{yyyy-MM-dd}.log</FileNamePattern> <!--设置日志的清理周期--> <maxHistory>10</maxHistory> </rollingPolicy> <layout> <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line]--%mdc{client} %msg%n</pattern> </layout> <!-- 过滤器，执行一个过滤器会有返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之一。 DENY：日志将立即被抛弃不再经过其他过滤器 NEUTRAL：有序列表里的下个过滤器过接着处理日志 ACCEPT：日志会被立即处理，不再经过剩余过滤器 --> <!-- 级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据 onMath 和 onMismatch 接收或拒绝日志 <level> : 设置过滤级别 <onMatch> : 用于配置符合过滤条件的操作 <onMismatch> : 用于配置不符合过滤条件的操作 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> </configuration>
-
3. 使用流程
-
修改pom文件，排除自带的日志：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <!-- 排除默认的日志，统一使用logback --> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <!-- 使用logback日志 --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-access</artifactId> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> </dependency> -
在项目根路径下创建
config文件夹，添加logback-spring.xml文件<?xml version="1.0" encoding="UTF-8"?> <configuration> <!--日志路径，当前是在项目的根下生成logs文件夹--> <property name="PATH" value="logs"></property> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> <Pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] --%mdc{client}%msg%n</Pattern> </encoder> </appender> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${PATH}/info.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${PATH}/info.%d{yyyy-MM-dd}.log</FileNamePattern> <maxHistory>10</maxHistory> </rollingPolicy> <layout> <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line]--%mdc{client} %msg%n</pattern> </layout> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${PATH}/debug.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${PATH}/debug.%d{yyyy-MM-dd}.log</FileNamePattern> <maxHistory>10</maxHistory> </rollingPolicy> <layout> <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line]--%mdc{client} %msg%n</pattern> </layout> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>DEBUG</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${PATH}/warn.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${PATH}/warn.%d{yyyy-MM-dd}.log</FileNamePattern> <maxHistory>10</maxHistory> </rollingPolicy> <layout> <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line]--%mdc{client} %msg%n</pattern> </layout> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>WARN</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${PATH}/error.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${PATH}/error.%d{yyyy-MM-dd}.log</FileNamePattern> <maxHistory>10</maxHistory> </rollingPolicy> <layout> <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line]--%mdc{client} %msg%n</pattern> </layout> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <root level="DEBUG"> <appender-ref ref="STDOUT" /> </root> <root level="INFO"> <appender-ref ref="STDOUT" /> <appender-ref ref="INFO_FILE" /> <appender-ref ref="WARN_FILE" /> <appender-ref ref="ERROR_FILE" /> </root> </configuration> -
在application配置文件中添加：
logging: config: config/logback-spring.xml