Springboot与日志
日志框架
比如开发一个大型系统;
1、System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?
2、框架来记录系统的一些运行时信息;日志框架 ;rizhi.jar;
3、高大上的几个功能?异步模式?自动归档?xxxx? rizhi.jar.jar?
4、将以前框架卸下来?换上新的框架,重新修改之前相关的API;rizhi.jar.jar;
5、JDBC---数据库驱动;
写了一个统一的接口层;日志门面(日志的一个抽象层);logging-abstract.jar;
给项目中导入具体的日志实现就行了;我们之前的日志框架都是实现的抽象层;
市面上的日志框架;
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....
左边选一个门面(抽象层)、右边来选一个实现;
日志门面: SLF4J;
日志实现:Logback;
jboss-loggin 用的很少 、JCL不更新了,太老了。 ---》日志门面: SLF4J;
Log4J 和 Logback 是一个人写的。接口 SLF4J也是同一个人写的。 适配性很好。选择这个
SpringBoot:底层是Spring框架,Spring框架默认是用JCL;‘
SpringBoot选用 SLF4j和logback; springboot 很机智啊
SLF4j使用
如何在系统中使用SLF4j https://www.slf4j.org
注意:
以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法;
给系统里面导入slf4j的jar和 logback的实现jar
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class HelloWorld { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(HelloWorld.class); logger.info("Hello World"); } }
图示:
注意适配器: 实现了接口方法 调用了其他的实际的方法
每一个日志的实现框架都有自己的配置文件。使用slf4j以后,配置文件还是做成日志实现框架自己本身的配置文
件;最上层框起来的是 抽象层。这就是SLF4J的使用问题
遗留问题
a(slf4j+logback): Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx
统一日志记录,即使是别的框架和我一起统一使用slf4j进行输出?
每个框架都有自己的日志记录,如何进行统一?
即使是别的框架和我一起使用slf4j进行输出
某个应用程序,以来了很多别的框架,别的框架采用了别的日志进行处理。
上面处理方式都是用了 适配器的模式。 取代了原来框架中的日志模式。 调用了统一的日志框架。
如何让系统中所有的日志都统一到slf4j
1、将系统中其他日志框架先排除出去;
2、用中间包来替换原有的日志框架;(适配器)
3、我们导入slf4j其他的实现
创建springboot后,我们进入pom文件,
可以查看关系图谱:
点击进入:
spring boot使用的日志功能: 封装所有的日志场景
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> <version>2.1.4.RELEASE</version> <scope>compile</scope> </dependency>
底层依赖关系:
1)、SpringBoot底层也是使用slf4j+logback的方式进行日志记录
2)、SpringBoot也把其他的日志都替换成了slf4j;
查看中间的替换包都是偷梁换柱的效果。
如果我们要引入其他框架?一定要把这个框架的默认日志依赖移除掉?Spring boot底层都是这么做的
Spring框架用的是commons-logging; springboot给排除了:
dependency> <groupId>org.springframework</groupId> <artifactId>spring‐core</artifactId> <exclusions> <exclusion> <groupId>commons‐logging</groupId> <artifactId>commons‐logging</artifactId> </exclusion> </exclusions> </dependency>
SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;
Spring boot 把其他日志框架转为slf4j 然后用logback的方式进行实现
我们启动时候就打印,说明Spring boot默认帮我们配置好了日志。直接使用就OK了
@RunWith(SpringRunner.class) @SpringBootTest public class LoggingApplicationTests { Logger logger = LoggerFactory.getLogger(getClass());//记录工厂 logger是日志记录的记录器 @Test public void contextLoads() { // 由低到高。 可以调整需要输出的日志级别。 日志就只会在这个以及高级别生效 logger.trace("这是trace日志"); logger.debug("这是degub日志"); logger.info("这是info日志"); //info是我们自己定义的日志信息 logger.warn("这是warn信息"); logger.error("这是error日志"); } }
运行:
spring boot默认输出的是info级别的!
可以调整!所有的日志级别都在配置文件中:
运行:
还有一些配置:
运行完毕后,当前项目下生成配置的文件。
可以指定生成文件位置:
运行后:
logging.path 指定目录
logging.path=/spring/log //在当前磁盘的根路径下创建spring文件和里面的log文件,使用spring.log作为默认文件
运行后:
查看同级别的目录下面:
还可以配置其他的:
我们的控制台打印都是默认的,我们也可以自己进行定义
logging.level.com.toov5=trace
logging.path=/spring/log
# 在控制台输出的日志的格式
logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %‐5level === %logger{50} ==== %msg%n
控制台:
文件:
按照指定的格式走了~~~
格式参数参考:
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%‐5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
‐‐>
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n
如何进行指定配置?
给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了
如果使用 logback 那就配置个logback.xml。logback.xml:直接就被日志框架识别了,绕过了spring boot 如果改成 logback-spring.xml 就由spring boot加载了
logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能! 只激活某一个环境
springProfile name="staging"> <!‐‐ configuration to be enabled when the "staging" profile is active ‐‐> 可以指定某段配置只在某个环境下生效 </springProfile>
比如:
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <!‐‐ 日志输出格式:
%d表示日期时间, %thread表示线程名, %‐5level:级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息, %n是换行符 ‐‐> <layout class="ch.qos.logback.classic.PatternLayout"> <springProfile name="dev"> <!-- dev 开发环境的输出格式!--> <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level%logger{50} ‐ %msg%n</pattern> </springProfile> <springProfile name="!dev"> <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level%logger{50} ‐ %msg%n</pattern> </springProfile> </layout> </appender>
如果使用logback.xml作为日志配置文件,还要使用profile功能,会有以下错误
no applicable action for [springProfile]
使用哪个日志框架,就配备哪个框架的日志配置文件,放置规则 如上表格所述
配置:
logback.xml :
<?xml version="1.0" encoding="UTF-8"?> <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。 debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 --> <configuration scan="false" scanPeriod="60 seconds" debug="false"> <!-- 定义日志的根目录 --> <property name="LOG_HOME" value="/app/log" /> <!-- 定义日志文件名称 --> <property name="appName" value="atguigu-springboot"></property> <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --> <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <!-- 日志输出格式: %d表示日期时间, %thread表示线程名, %-5level:级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息, %n是换行符 下面是控制台 --> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}--------》 [%thread] ------》%-5level %logger{50} - %msg%n</pattern> </layout> </appender> <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 --> <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 指定日志文件的名称 --> <file>${LOG_HOME}/${appName}.log</file> <!-- 当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名 TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动 %i:当文件大小超过maxFileSize时,按照i进行文件滚动 --> <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern> <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动, 且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是, 那些为了归档而创建的目录也会被删除。 --> <MaxHistory>365</MaxHistory> <!-- 当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 日志输出格式: --> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern> </layout> </appender> <!-- logger主要用于存放日志对象,也可以定义日志类型、级别 name:表示匹配的logger类型前缀,也就是包的前半部分 level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出, false:表示只用当前logger的appender-ref,true: 表示当前logger的appender-ref和rootLogger的appender-ref都有效 --> <!-- hibernate logger --> <logger name="com.atguigu" level="debug" /> <!-- Spring framework logger --> <logger name="org.springframework" level="debug" additivity="false"></logger> <!-- root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应, 要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。 --> <root level="info"> <appender-ref ref="stdout" /> <appender-ref ref="appLogAppender" /> </root> </configuration>
运行:
配置dev 和 非dev环境:
在上面的配置文件进行修改:
<!-- 日志输出格式: --> <layout class="ch.qos.logback.classic.PatternLayout"> <springProfile name = "dev"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}--------》 [%thread] ------》%-5level %logger{50} - %msg%n</pattern> </springProfile> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}========== [%thread] ======= %-5level %logger{50} - %msg%n</pattern> <springProfile name = "dev"> </springProfile> </layout>
运行:
注意此时的 文件名字!
logback-spring.xml
内容修改:
<layout class="ch.qos.logback.classic.PatternLayout"> <springProfile name="dev"> <pattern> %d{yyyy-MM-dd HH:mm:ss.SSS}-------- [%thread] ------ %-5level %logger{50} - %msg%n </pattern> </springProfile> <springProfile name="!dev"> <pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} ********* [%thread] ******* %-5level %logger{50} - %msg%n </pattern> </springProfile> </layout>
激活开发环境后:
运行:
非dev:
spring boot读取
logback-spring.xml ## 名字必须这样 不能修改!!! Sprig boot 读取识别!
高级功能就可以使用了。
Spring boot日志框架的切换(大概了解下吧)
slf4j + logback 的方式
如果要切换呢?
log4j
先分析依赖树:通过图形化界面挨个排除 log-back等依赖排除掉
虽然用slf4j 但是用 log4j实现
导入:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring‐boot‐starter‐web</artifactId> <exclusions> <exclusion> <artifactId>logback‐classic</artifactId> <groupId>ch.qos.logback</groupId> </exclusion> <exclusion> <artifactId>log4j‐over‐slf4j</artifactId> <groupId>org.slf4j</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j‐log4j12</artifactId> </dependency>
log4j的配置文件是被框架识别的
切换为log4j:
<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> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring‐boot‐starter‐log4j2</artifactId> </dependency>
log4j.properties:
### set log levels ###
log4j.rootLogger = debug , stdout , D , E
### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n
#### 输出到日志文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/log.log
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
#
#### 保存异常信息到单独文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/error.log ## 异常日志文件名
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
这个切换是没啥意义的。本来就是不如logback
切换思路: 按照slf4j的日志是配图进行引入和排除
不推荐 slf4j+log4j的方式