SpringBoot 第三章 日志

市面上的日志框架

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:底层是Spring框架,Spring框架默认是用JCL;
    SpringBoot选用 SLF4j和logback;

2、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以后,配置文件还是做成日志实现框架自己本身的配置文件;

开发过程

  • a(slf4j+logback): Spring(底层是要用commons-logging【没有就会报错】)、Hibernate(jboss-logging)、MyBatis、xxxx 别的框架有自己的日志框架
    统一日志记录,即使是别的框架和我一起统一使用slf4j进行输出?

  • 解决方案
    图片说明

  • 用偷天换日包 用jct-over-slf4j.jar 来适配器【里面还是有common的东西】 中间适配层架包

  • 如何让系统中所有的日志都统一到slf4j;
    1、将系统中其他日志框架先排除出去;
    2、用中间包来替换原有的日志框架;
    3、我们导入slf4j其他的实现

使用idea的依赖表 观看pom依赖情况

  • 右键 ==>选择==> diagram==> show Dependencies
    图片说明
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.1.3.RELEASE</version>
        <scope>compile</scope>
      </dependency>

    将其他日志框架转为slf4j
    SpringBoot使用它来做日志功能;
    <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>

总结:

1) SpringBoot底层也是使用slf4j+logback的方式进行日志记录
2) SpringBoot也把其他的日志都替换成了slf4j;
3) 中间替换包?
4) 如果我们要引入其他框架?一定要把这个框架的默认日志依赖移除掉?Spring框架用的是commons-logging;

  • 转化为->slf4j来处理 偷梁换柱

    @SuppressWarnings("rawtypes")
    public abstract class LogFactory {
    
      static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
    
      static LogFactory logFactory = new SLF4JLogFactory();//这里♥
  • SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;

使用日志功能

  • 代码

    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class springbootTest {
      //记录器  取代sysout
      Logger logger = LoggerFactory.getLogger(getClass());
      @Test
      public void myTest(){
          //日志级别  低到高 trace<debug<info<warn<error
          //可以调整输出的日志级别,日志就只会在这个级别以后的高级级别生效
          logger.trace("trace");
          logger.debug("debug");
          //SpringBoot默认给我们使用的是info级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别
          logger.info("info");
          logger.warn("warn");
          logger.error("error");
      }
    }

    图片说明

  • 修改日志级别后

    logging:
    level:
      com:  # 必须加到具体的项目路径
        project: trace

    图片说明

  • 生成springboot.log文件

    logging:
      file: springboot.log  # G:\springboot.log
  • 生成springboot 路径

    logging:
      path: springboot
  • 组合操作

    #  在控制台输出的日志的格式
    logging:
    file: springboot.log
    pattern:
      console: "%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n" #需要加""
      file: "%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n"
  • 二选一

    logging.file logging.path Example Description
    (none) (none) 只在控制台输出
    指定文件名 (none) my.log 输出日志到my.log文件
    (none) 指定目录 /var/log 输出到指定目录的 spring.log 文件中
  • 效果
    图片说明

3、指定配置

  • 有关的属性配置 base.xml 和 default.xml
    图片说明
    还有一些文件上的配置
    图片说明
  • 给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用默认配置的了
    放文件的规则如下:
    Logging System Customization
    Logback logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
    Log4j2 log4j2-spring.xml or log4j2.xml
    JDK (Java Util Logging) logging.properties

写自己的配置文件 定义自己配置文件

  • logback.xml:直接就被日志框架识别了; 下面情况日志框架不认识
  • 推荐===> 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来配置 开发环境符合就用这种情况--><!--spring.profiles.active=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功能,会有以下错误 , 直接识别就会报错dev他不懂
    no applicable action for [springProfile]

5、切换日志框架

  • 默认的是slf4j+log-back
    可以按照slf4j的日志适配图,进行相关的切换;
    图片说明
    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>

切换为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>

<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
全部评论

相关推荐

点赞 收藏 评论
分享
牛客网
牛客企业服务