ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

SpringBoot(三) -- SpringBoot与日志

2019-11-28 22:02:22  阅读:175  来源: 互联网

标签:logging SpringBoot 框架 slf4j 日志 logger


一.日志的起源
  现在假设一个开发人员在开发一个大型系统,由于这个系统过于庞大没在很多的地方将关键的数据使用System.out.println()打印,但是当我们在项目正式上线时又需要去除,在项目bug修复时又需要重新打印,那么我们是不是可以将这些实用的输出信息保存到一个文件中.我们可以用一个自定义的框架将一些自定义的信息输出出来.同时我们还希望在日志输出的时候,通常日志输出都是阻塞的,我们试图启用异步输出,而且启用自动归档(将每天的日志信息存放起来在一个统一的文件夹中).但是这时候有更好的日志框架产生了部分的API需要改动,显得十分麻烦.我们可以知道JDBC和数据库驱动有联系,我们也可以参照这个实现,为所有的日志框架来写一个统一的接口层,即日志门面,即日志的抽象层.给项目导入具体的日志实现即可.我们之前的日志框架都是实现的日志抽象层,市面上的日志框架:JUL JCL Jboss-logging logback log4j log4j2 slf4j
  日志门面(日志的抽象层):JCL(Jakarta commons logging) SLF4J(simple logging facade for java) jboss-logging
  日志实现:log4j JUL(java,util.logging) log4j2 logback
  使用:选择一个日志门面以及一个日志实现.例如slf4j 和 logback,SpringBoot使用的是JCL,SpringBoot默认使用的是SLF4J和logback;

二,如何使用SLF4J
  1.在开发的时候日志记录即日志方法的调用,我们不应该来直接调用日志的实现类,而是调用日志抽象层的方法,详情可以参看Slf4j官网.首先我们需要导入SLF4j的jar包以及logback的实现jar

1 import org.slf4j.Logger;
2 import org.slf4j.LoggerFactory;
3 
4 public class HelloWorld {
5   public static void main(String[] args) {
6     Logger logger = LoggerFactory.getLogger(HelloWorld.class);
7     logger.info("Hello World");
8   }
9 }

  2.每一个日志的实现框架都有自己的配置文件,使用slf4j以后,配置文件还是做成日志实现框架的配置文件.
  3.遗留问题:A系统在开发过程中使用了(slf4j框架logback框架),但是这个项目依赖于Spring(commons-logging),Mybatis(log4j)框架,他们在底层也都使用了日志框架,我们如何统一日志框架,即使是别的框架,也统一使用slf4j和logback框架?

  4.如何让系统中所有的日志都统一到slf4j?
    a.将系统中其他日志框架先排除出去
    b.用中间包来替换原有的日志框架
    c.我们导入slf4j其他的实现

三.SpringBoot的日志关系 

1         <dependency>
2             <groupId>org.springframework.boot</groupId>
3             <artifactId>spring-boot-starter</artifactId>
4         </dependency>

 --SpringBoot使用它来做日志功能

1         <dependency>
2             <groupId>org.springframework.boot</groupId>
3             <artifactId>spring-boot-starter-logging</artifactId>
4         </dependency>

总结:
  1.SpringBoot底层也是使用slf4j+logback的方法进行日志记录
  2.SpringBoot也把其他的日志都替换成了slf4j;
  3.如果我们要引入其他的框架,一定要把这个框架的默认日志依赖移除掉.

四.SpringBoot默认配置

 1 package com.skukuqi.springboot.springboot_logging;
 2 
 3 import org.junit.Test;
 4 import org.junit.runner.RunWith;
 5 import org.slf4j.Logger;
 6 import org.slf4j.LoggerFactory;
 7 import org.springframework.boot.test.context.SpringBootTest;
 8 import org.springframework.test.context.junit4.SpringRunner;
 9 
10 @RunWith(SpringRunner.class)
11 @SpringBootTest
12 public class SpringbootLoggingApplicationTests {
13     //记录器
14     Logger logger = LoggerFactory.getLogger(getClass());
15 
16     @Test
17     public void testLogging() {
18         //日志的级别,由低到高,日志框架乐意调整需要输出的日志级别
19         logger.trace("这是trace日志...");
20         logger.debug("这是debug日志...");
21         logger.info("这是info日志...");
22         logger.warn("这是warn日志...");
23         logger.error("这是error日志...");
24     }
25 
26 }

--我们可以在application.properties中指定日志的级别,需要加上当前的包名和类名,例如logging.level.com.skukuqi=trace
  默认配置:
  logging.file     logging.path    example    description
  none        none                只在控制台输出
  指定文件名      none          my.log      日志输出到my.log文件中
  none        指定目录      /var/log     输出当指定目录的spring.log文件中

 1 #指定当前类的日志级别
 2 logging.level.com.skukuqi=trace
 3 #当前项目下生成日志
 4 #logging.file=mylog.log
 5 #指定路径
 6 #logging.file=C:/Users/Administrator/Desktop/mylog.log
 7 #指定目录
 8 logging.path=C:/spring/log
 9 #指定在控制台输出的日志的格式 默认:时间 级别 线程ID --- 主线程  全类名 :内容 -5level 级别从左显示5个宽度
10 logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} -%msg%n
11 #指定文件中日志输出的格式
12 logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} === [%thread] === %-5level === %logger{50} === %msg%n

五.指定日志文件和日志profile功能
  在类路径下放上每个日志框架自己的配置文件即可,SpringBoot就不使用他默认的自动配置了.以下给出默认配置的修改命名规范:

  logback.xml:直接就被日志框架识别了.
  logback-spring.xml:日志框架不会直接识别,有springBoot加载,这样就可以使用到springProfile标签某段配置只在某个环境中生效

 1 <springProfile name="staging">
 2     <!-- configuration to be enabled when the "staging" profile is active -->
 3 </springProfile>
 4 
 5 <springProfile name="dev, staging">
 6     <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
 7 </springProfile>
 8 
 9 <springProfile name="!production">
10     <!-- configuration to be enabled when the "production" profile is not active -->
11 </springProfile>
 1 <!--scan:
 2 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
 3 scanPeriod:
 4 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
 5 debug:
 6 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。-->
 7 <configuration scan="false" scanPeriod="60 seconds" debuf="false">
 8     <!--定义日志的根目录-->
 9     <property name="LOG_HOME" value="/app/log"/>
10     <!--定义日志文件名称-->
11     <property name="appName" value="skykuqi_springboot_logging"/>
12     <!--ch.qos.logback.core.ConsoleAppender 表示控制台输出-->
13     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
14         <!--日志输出格式:
15             %d:表示日期时间;
16             %thread:表示线程名;
17             %-5level:级别从左显示5个字符宽度;
18             %logger{50}:表示logger名字最长50个字符,否则按照句点分隔;
19             %msg:日志消息;
20             %n:换行
21         -->
22         <layout class="ch.qos.logback.classic.PatternLayout">
23             <springProfile name="test">
24                 <pattern>%d{HH:mm:ss} --- [%thread] --- %-5level %logger{36} - %msg%n</pattern>
25             </springProfile>
26             <springProfile name="!test">
27                 <pattern>%d{HH:mm:ss} === [%thread] === %-5level %logger{36} - %msg%n</pattern>
28             </springProfile>
29         </layout>
30     </appender>
31     <!--日志文件最大的大小-->
32     <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
33         <MaxFileSize>10MB</MaxFileSize>
34     </triggeringPolicy>
35     <!-- 日志输出级别 -->
36     <root level="INFO">
37         <appender-ref ref="STDOUT"/>
38     </root>
39 </configuration>

六.切换日志框架
 SpringBoot默认使用的slf4j和logback的日志框架.如果我们需要使用log4j日志框架.根据上方配置图,对jar包依赖作出如下的调整:

 1 <!--scan:
 2 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
 3 scanPeriod:
 4 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
 5 debug:
 6 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。-->
 7 <configuration scan="false" scanPeriod="60 seconds" debuf="false">
 8     <!--定义日志的根目录-->
 9     <property name="LOG_HOME" value="/app/log"/>
10     <!--定义日志文件名称-->
11     <property name="appName" value="skykuqi_springboot_logging"/>
12     <!--ch.qos.logback.core.ConsoleAppender 表示控制台输出-->
13     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
14         <!--日志输出格式:
15             %d:表示日期时间;
16             %thread:表示线程名;
17             %-5level:级别从左显示5个字符宽度;
18             %logger{50}:表示logger名字最长50个字符,否则按照句点分隔;
19             %msg:日志消息;
20             %n:换行
21         -->
22         <layout class="ch.qos.logback.classic.PatternLayout">
23             <springProfile name="test">
24                 <pattern>%d{HH:mm:ss} --- [%thread] --- %-5level %logger{36} - %msg%n</pattern>
25             </springProfile>
26             <springProfile name="!test">
27                 <pattern>%d{HH:mm:ss} === [%thread] === %-5level %logger{36} - %msg%n</pattern>
28             </springProfile>
29         </layout>
30     </appender>
31     <!--日志文件最大的大小-->
32 <!--    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
33         <MaxFileSize>10MB</MaxFileSize>
34     </triggeringPolicy>-->
35 
36     <!-- 日志输出级别 -->
37     <root level="INFO">
38         <appender-ref ref="STDOUT"/>
39     </root>
40 </configuration>

  --而后则可以使用log4j的配置文件来完成我们日志的输出.

七.SpringBoot Starters

  在SpringBoot中默认log4j2,logback:

标签:logging,SpringBoot,框架,slf4j,日志,logger
来源: https://www.cnblogs.com/skykuqi/p/11946217.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有