在Spring Boot的官方文档中,咱们发现关于日志的描述仍是比较详细的:https://docs.spring.io/spring-boot/docs/2.0.4.RELEASE/reference/htmlsingle/#boot-features-logging 。Spring Boot使用Commons Logging进行全部内部日志记录,可是默认配置也提供了对经常使用日志框架的支持,如:Java Util Logging,Log4J, Log4J2和Logback。每种日志框架均可以经过配置使用控制台或者文件输出日志内容。若是咱们使用了Spring Boot的starters,那么Spring Boot会用Logback来记录日志并用INFO级别输出到控制台。html
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.5.2.RELEASE)
2018-08-07 21:29:38.556 INFO 4384 --- [ main] com.dudu.Application : Starting Application on DESKTOP-GVTQ3ND with PID 4384 (E:\IntelliProject\springboot_springclould\SpringBootDemo-master\chapter7-1\target\classes started by acer in E:\IntelliProject\springboot_springclould\SpringBootDemo-master\chapter7-1)
2018-08-07 21:29:38.560 INFO 4384 --- [ main] com.dudu.Application : No active profile set, falling back to default profiles: default
2018-08-07 21:29:39.045 INFO 4384 --- [ main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@5e57643e: startup date [Tue Aug 07 21:29:39 CST 2018]; root of context hierarchy
2018-08-07 21:29:40.770 INFO 4384 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat initialized with port(s): 8080 (http)
2018-08-07 21:29:40.779 INFO 4384 --- [ main] o.apache.catalina.core.StandardService : Starting service Tomcat
2018-08-07 21:29:40.780 INFO 4384 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache Tomcat/8.5.11
2018-08-07 21:29:40.877 INFO 4384 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2018-08-07 21:29:40.877 INFO 4384 --- [ost-startStop-1] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 1836 ms
2018-08-07 21:29:41.099 INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/]
2018-08-07 21:29:41.104 INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'characterEncodingFilter' to: [/*]
2018-08-07 21:29:41.104 INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
2018-08-07 21:29:41.104 INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'httpPutFormContentFilter' to: [/*]
2018-08-07 21:29:41.104 INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'requestContextFilter' to: [/*]
2018-08-07 21:29:41.465 INFO 4384 --- [ main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@5e57643e: startup date [Tue Aug 07 21:29:39 CST 2018]; root of context hierarchy
2018-08-07 21:29:41.521 INFO 4384 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/learn]}" onto public org.springframework.web.servlet.ModelAndView com.dudu.controller.LearnController.index()
2018-08-07 21:29:41.524 INFO 4384 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/login],methods=[POST]}" onto public java.util.Map<java.lang.String, java.lang.Object> com.dudu.controller.LearnController.login(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2018-08-07 21:29:41.527 INFO 4384 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2018-08-07 21:29:41.527 INFO 4384 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2018-08-07 21:29:41.544 INFO 4384 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/toLogin] onto handler of type [class org.springframework.web.servlet.mvc.ParameterizableViewController]
2018-08-07 21:29:41.556 INFO 4384 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/my/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-07 21:29:41.557 INFO 4384 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-07 21:29:41.557 INFO 4384 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-07 21:29:41.599 INFO 4384 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-07 21:29:42.031 INFO 4384 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
2018-08-07 21:29:42.099 INFO 4384 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
2018-08-07 21:29:42.103 INFO 4384 --- [ main] com.dudu.Application : Started Application in 3.941 seconds (JVM running for 5.251)
经过控制台日志输出咱们发现:java
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
添加这个依赖以后,Spring Boot应用将自动使用logback做为应用日志框架,Spring Boot启动的时候,由org.springframework.boot.logging.Logging-Application-Listener根据状况初始化并使用。可是通常在开发的时候咱们不必引入这个依赖,由于spring-boot-starter其中包含了 spring-boot-starter-logging,例以下面的两个依赖就包含此日志包:web
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
具体的依赖关系咱们能够经过IDEA工具去查看。spring
咱们只须要引入相关的依赖,Spring Boot就默认作了不少的配置,通常状况下咱们直接使用就能够了。固然咱们也能够在配置文件中去修改,相关属性以下:apache
# LOGGING
logging.config= # Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.
logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.
logging.file= # Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory.
logging.file.max-history=0 # Maximum of archive log files to keep. Only supported with the default logback setup.
logging.file.max-size=10MB # Maximum log file size. Only supported with the default logback setup.
logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`.
logging.path= # Location of the log file. For instance, `/var/log`.
logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup.
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS # Appender pattern for log date format. Supported only with the default Logback setup.
logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup.
logging.pattern.level=%5p # Appender pattern for log level. Supported only with the default Logback setup.
logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.
属性 | 解释 |
---|---|
logging.config= | 日志配置文件的位置。例如,classpath:logback.xml。 |
logging.exception-conversion-word=%wEx | 转换异常时使用的转换字。 |
logging.file= | 设置保存日志的日志文件 |
logging.file.max-history=0 | are neat |
logging.file.max-size=10MB | 设置日志文件最大大小 |
logging.level.*= | 设置日志等级 |
logging.path= | 日志文件的位置,例如/var/log |
logging.pattern.console= | 定义打印的日志格式 |
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS | 设置日志日期格式 |
logging.pattern.file= | 定义输出到日志文件的日志格式 |
logging.register-shutdown-hook=false | 当初始化日志系统时,为其注册一个关闭钩子。 |
下面咱们介绍几个经常使用属性的使用。springboot
日志的级别从低到高依次为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,若是设置为WARN,则低于WARN的信息都不会输出。默认状况下Spring Boot使用logback(logback没有FATAL级别),控制台会输出INFO及INFO以上的日志,咱们能够在配置文件中配置debug=true
或在启动时运行$ java -jar demo.jar --debug
核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,可是你本身应用的日志并不会输出为DEBUG级别。mybatis
默认状况下Spring Boot只会输出日志到控制台,若是咱们想要把日志输出到文件中,咱们能够经过设置logging.file
或logging.path
这两个属性来实现,两者不能同时使用,如若同时使用,则只有logging.file生效。mvc
logging.file=mylog.log
logging.path=/my/log/
,会在这个目录下生成名为spring.log的日志文件全部支持的日志记录系统均可以在Spring环境中设置记录级别(例如在application.properties中)
格式为:logging.level.* = LEVEL
,例如:app
#com.simon.controller包下全部class以DEBUG级别输出
logging.level.com.simon.controller=DEBUG
#root日志以WARN级别输出
logging.level.root=WARN
%d:表示日期时间
%thread:表示线程名
%‐5level:级别从左显示5个字符宽度
%logger{50}:表示logger名字最长50个字符,不然按照句点分割。
%msg:日志消息
%n:是换行符
示例:框架
# 设置在控制台输出的日志的格式
logging.pattern.console=[%d{yyyy‐MM‐dd}]-[%level]-[%msg]-%logger{50}%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %level === %logger{50} ==== %msg%n
因为日志服务通常都在ApplicationContext建立前就初始化了,它并非必须经过Spring的配置文件控制。所以经过系统属性和传统的Spring Boot外部配置文件依然能够很好的支持日志控制和管理。根据不一样的日志系统,你能够按以下规则组织配置文件名,就能被正确加载:
Spring Boot官方推荐优先使用带有-spring的文件名做为日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot能够为它添加一些spring boot特有的配置项。上面是默认的命名规则,而且放在src/main/resources下面便可。若是想彻底掌控日志配置,但又不想用logback.xml做为Logback配置的名字,能够在application.properties配置文件里面经过logging.config属性指定自定义的名字:
logging.config=classpath:logging-config.xml
下面咱们经过一个简单的例子来讲明自定义logback日志:
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>demo</contextName>
<property name="log.path" value="/my/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">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/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>
<!-- logback为java中的包 -->
<logger name="com.dudu.controller"/>
<!--logback.LogbackDemo:类的全路径 -->
<logger name="com.simon.controller" level="WARN" additivity="false">
<appender-ref ref="console"/>
</logger>
</configuration>
<configuration>
包含的属性根节点<configuration>
下面一共有2个属性,3个子节点,分别是:
1. 设置上下文名称<contextName>
每一个logger都关联到logger上下文,默认上下文名称为“default”。但可使用设置成其余名字,用于区分不一样应用程序的记录。一旦设置,不能修改,能够经过%contextName来打印日志上下文名称。
xml
<contextName>logback</contextName>
2. 设置变量<property>
用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。经过定义的值会被插入到logger上下文中。定义变量后,可使“${}”来使用变量。
xml
<property name="log.path" value="/my/log" />
子节点一<appender>
控制台输出ConsoleAppender
<!--输出到控制台-->
<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>
ThresholdFilter为系统定义的拦截器,例如咱们用ThresholdFilter来过滤掉ERROR级别如下的日志不输出到文件中。
文件输出RollingFileAppender
另外一种常见的日志输出到文件,随着应用的运行时间愈来愈长,日志也会增加的愈来愈多,将他们输出到同一个文件并不是一个好办法。RollingFileAppender
用于切分文件日志:
<!--输出到文件-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
其中重要的是rollingPolicy的定义,上例中<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
定义了日志的切分方式——把每一天的日志归档到一个文件中,<maxHistory>30</maxHistory>
表示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可使用%d{yyyy-MM-dd_HH-mm}
来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>
用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
子节点二<root>
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。level用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。能够包含零个或多个元素,标识这个appender将会添加到这个logger。
<root level="debug">
<appender-ref ref="console" />
<appender-ref ref="file" />
</root>
子节点三<logger>
<logger>
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性,一个可选的level和一个可选的addtivity属性。
logger在实际使用的时候有两种状况:
带有logger的配置,不指定级别,不指定appender
<logger name="com.simon.controller"/>
<logger name="com.simon.controller" />
将控制controller包下的全部类的日志的打印,可是并没用设置打印级别,因此继承他的上级的日志级别info
;没有设置addtivity,默认为true,将此logger的打印信息向上级传递;没有设置appender,此logger自己不打印任何信息。<root level="info">
将root的打印级别设置为info
,指定了名字为console
的appender。当执行com.simon.controller下类的方法时,首先执行<logger name="com.simon.controller"/>
,将级别为info
及大于info
的日志信息传递给root,自己并不打印;root接到下级传递的信息,交给已经配置好的名为console
的appender处理,console
appender将信息打印到控制台。
带有多个logger的配置,指定级别,指定appender
<!--logback.LogbackDemo:类的全路径 -->
<logger name="com.simon.controller.DemoController" level="WARN" additivity="false">
<appender-ref ref="console"/>
</logger>
控制com.simon.controller.DemoController
类的日志打印,打印级别为WARN
;additivity属性为false,表示此logger的打印信息再也不向上级传递;指定了名字为console
的appender;这时候执行com.simon.controller.DemoController
类的方法时,先执行<logger name="com.simon.controller.DemoController" level="WARN" additivity="false">
,将级别为“WARN”及大于WARN
的日志信息交给此logger指定的名为console
的appender处理,在控制台中打出日志,再也不向上级root传递打印信息。固然若是你把additivity=”false”改为additivity=”true”的话,就会打印两次,由于打印信息向上级传递,logger自己打印一次,root接到后又打印一次。
logback.xml与logback-spring.xml是有区别的,logback.xml会直接被日志框架识别使用,而logback-spring.xml会先通过springboot解析处理,以后才会被日志框架使用,可使用SpringBoot的高级Profile功能。咱们能够经过不一样环境来定义不一样日志的输出,若是咱们使用logback-spring.xml,那么springProfile节点来标识配置应用到哪些环境中。
<!-- 测试环境+开发环境. 多个使用逗号隔开. -->
<springProfile name="test,dev">
<logger name="com.simon.controller" level="info" />
</springProfile>
<!-- 生产环境. -->
<springProfile name="prod">
<logger name="com.simon.controller" level="ERROR" />
</springProfile>
这样以后,咱们在配置中指定环境,那么相关的日志就生效了
# 指定环境为dev
spring.profiles.active=dev
若是咱们不想使用logback日志框架,咱们能够安装以下方法作,以更换日志框架为log4j2,并使用log4j2配置文件进行日志打印为例。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!--排除默认日志框架-->
<exclusions>
<exclusion>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<!--引入log4j2依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,能够不设置,当设置成trace时,你会看到log4j2内部各类详细输出-->
<!--monitorInterval:Log4j可以自动检测修改配置 文件和从新配置自己,设置间隔秒数-->
<configuration status="WARN" monitorInterval="30">
<!--先定义全部的appender-->
<appenders>
<!--这个输出控制台的配置-->
<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式-->
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
</console>
<!--文件会打印出全部信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用-->
<File name="log" fileName="log/test.log" append="false">
<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
</File>
<!-- 这个会打印出全部的info及如下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份创建的文件夹下面并进行压缩,做为存档-->
<RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制台只输出level及以上级别的信息(onMatch),其余的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
</appenders>
<!--而后定义logger,只有定义了logger并引入的appender,appender才会生效-->
<loggers>
<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.mybatis" level="INFO"></logger>
<root level="all">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>