springboot的默认日志管理
SprongBoot使用的默认日志框架是Logback,并用INFO级别输出到控制台。
SpringBoot的日志的级别有7个:
TRACE , DEBUG , INFO , WARN , ERROR , FATAL , OFF
日志级别从低到高为:
TRACE < DEBUG < INFO < WARN < ERROR < FATAL< OFF 。
在springboot中,日志的输出策略是,只输出当前配置的输出基本,即其以上级别的日志信息,默认输出基本是INFO级别。
在springboot的默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。如果要编写除控制台输出之外的日志文件,则需在application.properties中设置。
#配置日志
logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.file=e:\\springboot\\info.log
logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n
“logging.level.root=WARN"表示root日志以WARN级别输出;
“logging.level.org.springframework.web=DEBUG"表示springframework.web日志以DEBUG级别输出;
“logging.file=e:\springboot\info.log"表示日志输出的文件位置,并且可以使用"logging.path=/var/log"来替换,如果使用"logging.path=/var/log"时,会在该目录下创建spring.log文件,并写入日志内容。二者不能同时使用,如若同时使用,则只有logging.file生效;
“logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n"表示日志输出到控制台的格式。”%d{yyyy/MM/dd-HH:mm:ss}“表示输出系统当前时间,精确到毫秒;”[%thread] “表示输出当前线程名;”%-5level"表示输出线程的编号,”%logger"表示输出日志信息;”%msg"表示日志信息,”%n"表示换行。
"logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n"表示日志输出到日志文件中的格式。
注:默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件。
自定义日志配置
通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。
根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:
• Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
• Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
• Log4j2:log4j2-spring.xml, log4j2.xml
• JDK (Java Util Logging):logging.properties
Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项。
如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,可以通过logging.config属性指定自定义的名字:
logging.config=classpath:logging-config.xml
虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时Profile使用不同的日志配置,这个功能会很有用。
自定义日志配置信息
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>logback</contextName>
<property name="log.path" value="E:\\springboot\\info.log" />
<!--输出到控制台-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>-->
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<!--输出到文件-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="console" />
<appender-ref ref="file" />
</root>
<!-- loger的使用方法,
指定了具体的类,所有只有该类才能使用日志配置
-->
<logger name="com.qianfeng.controller.SpringController" level="WARN" additivity="false">
<appender-ref ref="console"/>
</logger>
</configuration>
根节点包含的属性:
• scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
• scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
• debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
<contextname>:每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
<property>:用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
<appender>:用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志。
RollingFileAppender用于切分文件日志:
<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>:定义了日志的切分方式——把每一天的日志归档到一个文件中,<maxHistory>30</maxHistory>:表示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
<root>节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
<loger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。
<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。name:用来指定受此loger约束的某一个包或者具体的某一个类(一般是springboot的启动类)。level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。addtivity:是否向上级loger传递打印信息。默认是true。
注:自定义的日志信息默认整个springboot项目都可以使用,但是如果在日志配置信息中配置了如下内容时,会覆盖掉默认配置。
<!-- loger的使用方法,指定了具体的类,
所有只有该类才能使用日志配置,
即当该类定义日志输出信息时,使用该日志输出级别。
-->
<logger name="com.qianfeng.controller.SpringController" level="WARN" additivity="false">
<appender-ref ref="console"/>
</logger>
</configuration>
loger的使用
在springboot的默认情况下,配置的日志信息,可以在整个springboot项目中使用;但是在使用日志时,需要使用代码来调用。
import org.slf4j.LoggerFactory;
import org.slf4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class OrderController {
//定义日志信息类对象
private Logger logger = LoggerFactory.getLogger(this.getClass());
@RequestMapping("/order")
@ResponseBody
public String show(){
//使用不同级别的日志输出
logger.debug("debuy日志");
logger.warn("warn日志");
logger.info("info日志");
logger.error("error日志");
return "order";
}
}
多环境日志输出
springboot还提支持不同环境的选择,当需要进行不同环境的配置时,可以在日志配置内容中通添加如下内容,在选择使用具体的环境时,在application.properties文件中使用" spring.profiles.active"属性来选择。
<!-- 测试环境+开发环境. 多个使用逗号隔开-->
<springProfile name="test,dev">
<logger name="com.yunxiang.controller" level="info" />
</springProfile>
<!-- 生产环境-->
<springProfile name="prod">
<logger name="com.yunxiang.controller" level="ERROR" />
</springProfile>
使用log4j配置日志
添加log4j的jar
<!-- log4j -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<!-- 排除springboot的默认日志jar -->
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j</artifactId>
<version>1.3.8.RELEASE</version>
</dependency>
log4j.properties
log4j.rootLogger=info,error,CONSOLE,DEBUG
#实现向控制台输出
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm} [%t] [%c] [%p] - %m%n
log4j.logger.info=info
#实现向文件输出
log4j.appender.info=org.apache.log4j.DailyRollingFileAppender
log4j.appender.info.layout=org.apache.log4j.PatternLayout
log4j.appender.info.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm} [%t] [%c] [%p] - %m%n
log4j.appender.info.datePattern='.'yyyy-MM-dd
log4j.appender.info.Threshold = info
log4j.appender.info.append=true
log4j.appender.info.File=e://springboot/api_services_info.log
log4j.logger.error=error
log4j.appender.error=org.apache.log4j.DailyRollingFileAppender
log4j.appender.error.layout=org.apache.log4j.PatternLayout
log4j.appender.error.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm} [%t] [%c] [%p] - %m%n
log4j.appender.error.datePattern='.'yyyy-MM-dd
log4j.appender.error.Threshold = error
log4j.appender.error.append=true
log4j.appender.error.File=e://springboot/api_services_error.log
log4j.logger.DEBUG=DEBUG
log4j.appender.DEBUG=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DEBUG.layout=org.apache.log4j.PatternLayout
log4j.appender.DEBUG.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm} [%t] [%c] [%p] - %m%n
log4j.appender.DEBUG.datePattern='.'yyyy-MM-dd
log4j.appender.DEBUG.Threshold = DEBUG
log4j.appender.DEBUG.append=true
log4j.appender.DEBUG.File=e://springboot/api_services_debug.log
log4j的使用
import org.apache.log4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class TestController {
private static Logger logger = Logger.getLogger(TestController.class);
@RequestMapping("/tests")
@ResponseBody
public String tests(){
logger.debug("debug日志");
logger.warn("warn日志");
logger.info("info日志");
logger.error("error日志");
return "log4j";
}
}