日志的作用
主要作用包括:
1、出问题后定位当时问题
2、显示程序当前运行状态
我们知道市面上有很多的开源日志框架如 slf4j, logback, log4j, JCL(Apache Common Logging), JUL(JDK自带的java.util.logging)等
日志级别介绍
level 定义简直就是一门艺术, 好的定义应该遵循以下原则:
debug:完整详细的记录流程的关键路径. 应该用于开发人员比较感兴趣的跟踪和调试信息, 生产环境中正常都不会打开debug状态
info:应该简洁明确让管理员确认状态。记录相当重要的,对于最终用户和系统管理员有意义的消息。关键系统参数的回显、后台服务的初始化状态、需要系统管理员知会确认的关键信息都需要使用INFO级别
warn:能清楚的告知所有人发生了什么情况.能引起人的重视,指示潜在问题,但不一定需要处理。
error:系统出现了异常或不期望出现的问题,希望及时得到关注的处理。需要注意的一个点,不是所有的异常都需要记录成error。
这么多日志框架我们该怎么选择呢?
其实上面的日志框架中有些是 日志框架的抽象层 相当于门面 它不包含日志的具体实现
比如
在上面3个门面当中我们选择slf4j jcl听说2014就已经不维护了,jboos-logging只有个别框架使用
slf4j提供了众多的适配器可以适配其他所有开源日志框架
这样让我们在代码中只需面对slf4j的API,然后可以任意切换日志的实现。
你可能会讲我们并不需要切换日志框架这种功能,但是我们项目中需要使用大量的第三方库,而这些第三方库使用的日志框架各不相同,不同的日志框架需要不同的配置,不同的配置会导致日志输出到不同的位置。
在这些日志实现框架中又数logback性能最优,所以在选择日志实现的时候推荐使用logback,或者log4j
上边选一个门面(抽象层)、下边来选一个实现;
日志门面: SLF4J; 日志实现:Logback;
springboot 采用的就是这种组合
那我们在springboot中如何使用slf4j+logback呢?
其实实际开发中我们不需要直接添加该依赖。
你会发现spring-boot-starter其中包含了 spring-boot-starter-logging,该依赖内容就是 Spring Boot 默认的日志框架 logback。如下图所示
我们发现这些日志依赖包都依赖于slf4j日志接口
那为什么需要这2个依赖呢呢?
我们知道其实springboot 依赖spring 而spring默认实现的日志是JCL Hibernate(jboss-logging)还有别的框架用的也是别的日志框架
我们如何来统一都用slf4j呢
如何让系统中所有的日志都统一到slf4j;
1、将系统中其他日志框架先排除出去;
2、用中间包来替换原有的日志框架;
3、我们导入slf4j其他的实现
我们首先排除这些框架所需的日志包 排除掉当然会报错
这时就必须用到这些适配包
springboot 导入spring依赖时其实也排除了spring所依赖的日志包
SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,所以当我们引入其他框架的时候,只需要 把这个框架依赖的日志框架排除掉即可;
private static final Logger log = LoggerFactory.getLogger(Springboot01ApplicationTests.class);
@Test
public void log() {
// System.out.println();
// 日志的级别;
// 由低到高 trace
因为springboot默认打印的级别时info 所以控制台只会输出info和info级别以上的信息
我们可以在application.properties中配置一些简单的日志相关属性:
级别控制
所有支持的日志记录系统都可以在Spring环境中设置记录级别(例如在application.properties中)格式为:‘logging.level.* = LEVEL’
logging.level:日志级别控制前缀,*为包名或Logger名
LEVEL:选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
举例:
logging.level.com.dudu=DEBUG:com.dudu包下所有class以DEBUG级别输出
logging.level.root=WARN:root日志以WARN级别输出
控制台输出
日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。您还可以通过启动您的应用程序–debug标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:
1.在运行命令后加入–debug标志,如:$ java -jar springTest.jar --debug
2.在application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别。
文件输出
默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。
如果要编写除控制台输出之外的日志文件,则需在application.properties中设置logging.file或logging.path属性。
logging.file,设置文件,可以是绝对路径,也可以是相对路径。如:logging.file=my.log
logging.path,设置目录,会在该目录下创建spring.log文件,并写入日志内容,
如:logging.path=/var/log
如果只配置 logging.file,会在项目的当前路径下生成一个 xxx.log 日志文件。
如果只配置 logging.path,在 /var/log文件夹生成一个日志文件为 spring.log
注:二者不能同时使用,如若同时使用,则只有logging.file生效
默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件,
默认级别为:ERROR、WARN、INFO
自定义日志配置
由于日志服务一般都在ApplicationContext创建前就初始化了,它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。
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使用不同的日志配置,这个功能会很有用。
下面我们来看看一个普通的logback-spring.xml例子
logback
info
DENY
ACCEPT
%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
${log.path}
logback.%d{yyyy-MM-dd}.log
90
1GB
UTF-8
%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
根节点< configuration>包含的属性
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
根节点
的子节点:
下面一共有2个属性,3个子节点,分别是:
属性一:设置上下文名称< contextName>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
属性二:设置变量< property>
用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
子节点一 < appender>
appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
#####控制台输出ConsoleAppender:
info
DENY
ACCEPT
%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
表示对日志进行编码:
%d{HH: mm:ss.SSS}——日志输出时间
%thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
%-5level——日志级别,并且使用5个字符靠左对齐
%logger{36}——日志输出者的名字
%msg——日志消息
%n——平台的换行符
ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~
输出到文件
RollingFileAppender :另一种常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志:
logback.%d{yyyy-MM-dd}.log
30
1GB
其中重要的是rollingPolicy的定义,上例中
logback.%d{yyyy-MM-dd}.log
定义了日志的切分方式——把每一天的日志归档到一个文件中,
表示只保留最近30天的日志,以防止日志填满整个磁盘空间
同理,可以使用%d{yyyy-MM-dd_HH-mm}
来定义精确到分的日志切分方式。
用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
子节点二< root>
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。可以包含零个或多个元素,标识这个appender将会添加到这个loger。
子节点三< loger>
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性,一个可选的level和一个可选的addtivity属性。
name:用来指定受此loger约束的某一个包或者具体的某一个类。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
addtivity:是否向上级loger传递打印信息。默认是true。
如果我们把logger结点配置成这样
它将控制controller包下的所有类的日志的打印,但是并没有设置打印级别,所以继承他的上级的日志级别“info”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
将root的打印级别设置为“info”,指定了名字为“console”的appender。
当执行com.web包下类的方法时,首先执行
,将级别为“info”及大于“info”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“console”的appender处理,“console” appender 将信息打印到控制台
如果我们配置成这样
当执行com.web包下类的方法时,
先执行
将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。 如果把additivity设置为true那么日志坑底就会执行2遍
据不同环境(prod:生产环境,test:测试环境,dev:开发环境)来定义不同的日志输出,在 logback-spring.xml中使用 springProfile 节点来定义,方法如下:
文件名称不是logback.xml,想使用spring扩展profile支持,要以logback-spring.xml命名
可以启动服务的时候指定 profile (如不指定使用默认),如指定prod 的方式为:
java -jar xxx.jar --spring.profiles.active=prod
也可以在application.yml中指定
spring:
profiles:
active: dev
参考:
https://juejin.im/post/58f86981b123db0062363203
http://blog.csdn.net/vitech/article/details/53812137
https://www.imooc.com/article/21178
尚硅谷springboot教程