多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
[TOC] # 根节点包含的属性 * scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 * scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 * debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 根节点`<configuration>`有5个子节点,下面一一会详细介绍。 # 子节点一 `<root>` root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。 level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。 默认是DEBUG。 可以包含零个或多个元素,标识这个appender将会添加到这个loger。 ~~~ <root level="debug"> <appender-ref ref="console" /> <appender-ref ref="file" /> </root> ~~~ # 子节点二:`<contextName>` 设置上下文名称 每个logger都关联到logger上下文,默认上下文名称为“default”。 但可以使用设置成其他名字,用于区分不同应用程序的记录。 一旦设置,不能修改,可以通过`%contextName`来打印日志上下文名称,一般来说我们不用这个属性,可有可无。 ~~~ <contextName>logback</contextName> ~~~ ![](https://img.kancloud.cn/51/26/51265b5b3f765555692da488744de995_491x460.png) # 子节点三:`<property>`设置变量 用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。 通过定义的值会被插入到logger上下文中。定义变量后,可以使`"${}"`来使用变量 ~~~ <property name="logback.logdir" value="/Users/inke/dev/log/tomcat"/> <property name="logback.appname" value="app"/> ~~~ # 子节点四:`<appender>` appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。 **控制台输出`ConsoleAppender`:** * 示例一: ~~~ <?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <contextName>logback-demo</contextName> <!--输出到控制台 ConsoleAppender--> <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender"> <!--展示格式 layout--> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%d -1 %msg%n</pattern> </layout> </appender> <!--输出到控制台 ConsoleAppender--> <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d -2 %msg%n</pattern> </encoder> </appender> <!--指定最基础的日志输出级别--> <root level="INFO"> <!--appender将会添加到这个loger--> <appender-ref ref="consoleLog1"/> <appender-ref ref="consoleLog2"/> </root> </configuration> ~~~ 可以看到`layout`和`encoder`,都可以将事件转换为格式化后的日志记录,但是控制台输出使用`layout`,文件输出使用`encoder` 具体原因可以看[http://blog.csdn.net/cw\_hello1/article/details/51969554](http://blog.csdn.net/cw_hello1/article/details/51969554) * 示例二: ~~~ <?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <contextName>logback-demo</contextName> <!--输出到控制台 ConsoleAppender--> <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender"> <!--展示格式 layout--> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern> <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern> </pattern> </layout> <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>ERROR</level> </filter> --> </appender> <!--指定最基础的日志输出级别--> <root level="INFO"> <!--appender将会添加到这个loger--> <appender-ref ref="consoleLog1"/> <appender-ref ref="consoleLog2"/> </root> </configuration> ~~~ `<encoder>`表示对日志进行编码: * `%d{HH: mm:ss.SSS}`——日志输出时间 * `%thread`——输出日志的进程名字,这在Web应用以及异步任务处理中很有用 * `%-5level`——日志级别,并且使用5个字符靠左对齐 * `%logger{36}`——日志输出者的名字 * `%msg`——日志消息 * `%n`——平台的换行符 ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~ # 输出到文件`RollingFileAppender` 另一种常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。`RollingFileAppender`用于切分文件日志: ~~~ <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--如果只是想要 Info 级别的日志,只是过滤 info 还是会输出 Error 日志,因为 Error 的级别高, 所以我们使用下面的策略,可以避免输出 Error 的日志--> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!--过滤 Error--> <level>ERROR</level> <!--匹配到就禁止--> <onMatch>DENY</onMatch> <!--没有匹配到就允许--> <onMismatch>ACCEPT</onMismatch> </filter> <!--日志名称,如果没有File 属性,那么只会使用FileNamePattern的文件路径规则 如果同时有<File>和<FileNamePattern>,那么当天日志是<File>,明天会自动把今天 的日志改名为今天的日期。即,<File> 的日志都是当天的。 --> <File>${logback.logdir}/info.${logback.appname}.log</File> <!--滚动策略,按照时间滚动 TimeBasedRollingPolicy--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间--> <FileNamePattern>${logback.logdir}/info.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern> <!--只保留最近90天的日志--> <maxHistory>90</maxHistory> <!--用来指定日志文件的上限大小,那么到了这个值,就会删除旧的日志--> <!--<totalSizeCap>1GB</totalSizeCap>--> </rollingPolicy> <!--日志输出编码格式化--> <encoder> <charset>UTF-8</charset> <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern> </encoder> </appender> <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--如果只是想要 Error 级别的日志,那么需要过滤一下,默认是 info 级别的,ThresholdFilter--> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>Error</level> </filter> <!--日志名称,如果没有File 属性,那么只会使用FileNamePattern的文件路径规则 如果同时有<File>和<FileNamePattern>,那么当天日志是<File>,明天会自动把今天 的日志改名为今天的日期。即,<File> 的日志都是当天的。 --> <File>${logback.logdir}/error.${logback.appname}.log</File> <!--滚动策略,按照时间滚动 TimeBasedRollingPolicy--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间--> <FileNamePattern>${logback.logdir}/error.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern> <!--只保留最近90天的日志--> <maxHistory>90</maxHistory> <!--用来指定日志文件的上限大小,那么到了这个值,就会删除旧的日志--> <!--<totalSizeCap>1GB</totalSizeCap>--> </rollingPolicy> <!--日志输出编码格式化--> <encoder> <charset>UTF-8</charset> <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern> </encoder> </appender> ~~~ 如果同时有`<File>`和`<FileNamePattern>`,根据日期分割日志,代码注释写的很清楚了 ![](https://img.kancloud.cn/d1/d7/d1d7d83727836d8eaff92cb200750e85_565x115.png) 如果要区分`Info`和`Error`级别的日志,那么需要使用过滤规则的策略 # 子节点五`<loger>` `<loger>`用来设置某一个包或者具体的某一个类的日志打印级别、以及指定`<appender>`。 `<loger>`仅有一个name属性,一个可选的level和一个可选的addtivity属性。 * name:用来指定受此loger约束的某一个包或者具体的某一个类。 * level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。 * addtivity:是否向上级loger传递打印信息。默认是true。 loger在实际使用的时候有两种情况 先来看一看代码中如何使用 ~~~ @Controller public class LearnController { private Logger logger = LoggerFactory.getLogger(this.getClass()); @RequestMapping(value = "/login",method = RequestMethod.POST) @ResponseBody public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){ //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。 logger.trace("日志输出 trace"); logger.debug("日志输出 debug"); logger.info("日志输出 info"); logger.warn("日志输出 warn"); logger.error("日志输出 error"); Map<String,Object> map =new HashMap<String,Object>(); String userName=request.getParameter("userName"); String password=request.getParameter("password"); if(!userName.equals("") && password!=""){ User user =new User(userName,password); request.getSession().setAttribute("user",user); map.put("result","1"); }else{ map.put("result","0"); } return map; } } ~~~ 这是一个登录的判断的方法,我们引入日志,并且打印不同级别的日志,然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。 第一种:带有`loger`的配置,不指定级别,不指定`appender` `logback-spring.xml`增加`loger`配置如下: ~~~ <logger name="com.dudu.controller"/> ~~~ `<logger name="com.dudu.controller" />`将控制controller包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“info”; 没有设置addtivity,默认为true,将此loger的打印信息向上级传递; 没有设置appender,此loger本身不打印任何信息。 `<root level="info">`将root的打印级别设置为“info”,指定了名字为“console”的appender。 当执行com.dudu.controller.LearnController类的login方法时,LearnController 在包com.dudu.controller中,所以首先执行`<logger name="com.dudu.controller"/>`,将级别为“info”及大于“info”的日志信息传递给root,本身并不打印; root接到下级传递的信息,交给已经配置好的名为“console”的appender处理,“console” appender 将信息打印到控制台; 打印结果如下: ~~~ 16:00:17.407 logback [http-nio-8080-exec-8] INFO com.dudu.controller.LearnController - 日志输出 info 16:00:17.408 logback [http-nio-8080-exec-8] WARN com.dudu.controller.LearnController - 日志输出 warn 16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - ~~~ 第二种:带有多个`loger`的配置,指定级别,指定`appender` `logback-spring.xml`增加`loger`配置如下: ~~~ <configuration> <!--logback.LogbackDemo:类的全路径 --> <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false"> <appender-ref ref="console"/> </logger> </configuration> ~~~ 控制com.dudu.controller.LearnController类的日志打印,打印级别为“WARN”; additivity属性为false,表示此loger的打印信息不再向上级传递; 指定了名字为“console”的appender; 这时候执行com.dudu.controller.LearnController类的login方法时,先执行`<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">`,将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。 打印结果如下: ~~~ 16:00:17.408 logback [http-nio-8080-exec-8] WARN com.dudu.controller.LearnController - 日志输出 warn 16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日志输出 error ~~~ 当然如果你把`additivity="false"`改成`additivity="true"`的话,就会打印两次,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。 ~~~ <configuration> <logger name="com.example.demo.controller" level="WARN" additivity="false"> <appender-ref ref="consoleLog"/> </logger> <logger name="com.example.demo.controller"/> <logger name="com.example.demo"/> </configuration> ~~~ 范围有重叠的话,范围小的,有效。 # 多环境日志输出 ~~~ <configuration> <!-- 测试环境+开发环境. 多个使用逗号隔开. --> <springProfile name="test,dev"> <logger name="com.example.demo.controller" level="DEBUG" additivity="false"> <appender-ref ref="consoleLog"/> </logger> </springProfile> <!-- 生产环境. --> <springProfile name="prod"> <logger name="com.example.demo.controller" level="INFO" additivity="false"> <appender-ref ref="consoleLog"/> </logger> </springProfile> </configuration> ~~~ `application.yml`增加环境选择的配置`active: dev` ~~~ server: port: 9010 spring: profiles: active: dev datasource: url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8 username: root password: root mybatis: type-aliases-package: org.larry.springboot.entity mapper-locations: classpath:mapper/**/*.xml check-config-location: true ~~~ `active: 【test、dev、prod】`,根据`active`的环境,自动采用上面配置的`springProfile`的`logger`日志 自定义日志路径(application.yml) `application.yml`增加日志相关自定义配置 ~~~ logback: logdir: /Users/inke/dev/log/tomcat/sell appname: sell ~~~ 在`logback-spring.xml` ~~~ <?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <!--application.yml 传递参数,不能使用logback 自带的<property>标签 --> <springProperty scope="context" name="appname" source="logback.appname"/> <springProperty scope="context" name="logdir" source="logback.logdir"/> <contextName>${appname}</contextName> <!--输出到控制台 ConsoleAppender--> <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender"> <!--展示格式 layout--> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern> <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern> </pattern> </layout> </appender> ~~~