SpringBoot日志

Posted 咸鱼吐泡泡

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot日志相关的知识，希望对你有一定的参考价值。

日志是程序的重要组成部分，如果没有日志，那么程序出现了错误，我们便无法知晓错误发生在哪里。

日志的功能：

1.快速的定位和排查问题；

2.记录用户信息；

3.记录操作信息，可以帮助恢复数据或者定位责任人；

4.记录程序的执行时间，方便获取优化和分析；

在SpringBoot中它是内置了日志框架的，所以只要我们运行SpringBoot日志就会被打印在控制台上。但是输出的日志并不是开发者自己定义和打印的，还有一个问题就是控制台上面的日志是不能保存的，所以从这两个角度出发，提出来两个问题：1.开发者自定义打印日志；2.日志的持久化

开发者自定义打印日志

自定义打印日志的步骤：

1.在程序中得到日志对象； 

2.使用日志对象的相关语法输出要打印的对象

上面在获取日志对象时，需要使用日志工厂LoggerFactory，日志工厂需要将每一个类的类型传递进去，这样才知道日志的归属类，才能更方便、更直观定位到文体类。这里的Logger对象是在org.slf4j包小面的。 

日志的持久化 

日志持久化的方式有两种：

方式一：设置日志的保存路径 

#配置日志目录
logging:
  file:
    path: C:\\Users\\86158\\Desktop\\SSM框架\\ssm-framework\\

 上面这段代码的意思就是在指定路径下面创建spring.log日志文件

执行程序以后找到指定文件：

默认情况下springboot会有一个最大的日志大小限制，如果日志的文件大于默认的最大日志大小，那么springboot会从新启动一个日志 

方式二：设置日志文件的文件名

#方式二：设置日志文件的文件名
logging:
  file:
    name: spring.log

上面因为没有指定保存路径，所以它默认是保存在当前项目所在的目录里面：

当然上面也可以指定全路径名 

使用lombok的方式来输出日志

当我们现在每一个类里面都要输出打印日志时，每回都去执行

private static Logger logger = LoggerFactory.getLogger(类名.class);这个命名比较麻烦，为了更加方便的输出打印日志，就可以使用lombok的方式：

一：首先添加lombok框架，如果是在创建SpringBoot项目时就添加过lombok框架这里就不用再添加了，pom.xml文件中可以检查自己有没有添加该框架

我这里是添加过了的，如果没有添加的话可以手动添加，这里推荐一个插件，使用该插件可以很方便的添加各种框架：

去设置里面的插件中下载EditStarters这个插件，下载好以后安转插件然后重启IDEA

然后在你的IDEA窗口中右键，选择Generate，然后点击刚才安转好的插件，再点击OK

然后你就可以输入框架的名称，双击响应的框架到项目中

二：使用@Slf4j注解输出日志

lombok的原理 

lombok框架他其实就是对代码的一次简化，让程序员不用再重复的编写那些冗余的代码，而是在编译器编译期间lombok自己将那些代码添加进程序。

 

通过看上面使用lombok框架来打印日志的字节码文件就可以看出，他其实就是一次代码的简化操作：

 

lombok里面还有更多的注解：

注解                            作用
@Getter                        自动添加getter方法
@Setter                        自动添加setter方法
@ToString                      自动添加toString方法
@EqualsAndHashCode             自动添加equals和hashCode方法

组合注解                         作用
@Data                           @Getter+@Setter+@ToString+@EqualsAndHashCode
@Slf4j                          添加一个名为log的日志，使用slf4j

 

日志结构 

我们只有在认识清楚日志结构以后才能准确定位程序中的问题所在。

 

日志的级别 

在SpringBoot项目中日志一共有6个级别，它们的关系如下图：

 

trace:微量，少许的意思，级别最低；

debug:需要调试的时候关键信息打印；

info:普通的打印信息；

warn:警告，不影响使用，但需要注意的问题；

error:错误信息，级别较高的错误日志信息；

fatal:致命的，因为代码异常导致程序退出执行的事件 

日志使用 

一：日志级别配置只需要在配置文件中设置logging.level配置项即可：

#配置日志级别
logging:
  level:
    root: info

对上面的配置文件做出解释：logging表示一个这个配置文件是一个日志，level表示日志级别的层级，而root则表示要作用的路径，这里表示根路径，当然也可以配置为其他路径，比如像下面这样

logging:
  level:
    com:
      example:
        springboot:
          controller: info

info则表示配置的日志级别是普通日志。

二：打印日志

 

 

可以看到因为我配置的日志级别是info的，所以打印的时候它只打印了比他高的日志级别的信息，而比它低的日志级别的信息则没有被打印。 

 

 

 

 

 

 

SpringBoot.06.SpringBoot日志管理

SpringBoot.06.SpringBoot日志管理

SpringBoot日志介绍

概念

在SpringBoot框架中默认集成的日志处理框架是Logback。Logback是由log4j创始人设计的又一个开源日志组件。目前logback分为三个模块：logback-core、logback-classic和logback-access。它是对log4j日志展示进一步改进，相比较与log4j，logback更加轻量！

日志的级别

在SpringBoot中日志分为以下8类：

  • Off：关闭，日志的最低级别，不打印日志
  • Fatal：致命错误，指明非常严重的可能会导致应用终止执行的错误时间
  • Error：错误，指明错误事件，但应用可能还能继续运行
  • Warn：警告，指明可能潜在的危险状况
  • Info：信息，指明描述信息，从粗粒度上描述了应用运行过程
  • Debug：调试，指明细致的事件信息，对调试应用最有用
  • Trace：跟踪，指明程序运行轨迹，比DEBUG级别的粒度更细
  • All：所有，所有日志级别，包括定制级别

日志级别由低到高，级别越高，输出的日志信息越多。如下图所示：

日志的分类

在项目中，日志分为两类：rootLogger与logger

  • rootLogger：根全局日志，用来监听项目中的所有运行日志，包括引入依赖jar中的日志
  • logger：指定包级别日志，用来监听项目中指定包的日志信息

SpringBoot日志基本使用

1.新建Module

打开IDEA，新建Module – springboot-05-logback，按下图所示填写相应信息，点击Next：

在Dependencies中勾选Spring Web，点击Finish，如下图所示：

2.项目配置

我们将项目springboot-04-mybatis中的代码拷贝过来，整理一下项目结构。如下图所示：

3.配置日志

在SpringBoot框架中默认的根日志级别为INFO，这个在项目启动时通过控制套打印输出能看出来。如下图所示：

如果我们想要更改默认的根日志级别，可以修改配置文件如下：

server:
  port: 8805

# datasource
spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/christy?characterEncoding=UTF-8
    username: root
    password: 123456

# mybatis
mybatis:
  mapper-locations: classpath:com/christy/mapper/*.xml
  type-aliases-package: com.christy.entity

# logback
logging:
  level:
    root: debug

我们运行单元测试测试UserTest中的findAll()，可以发现控制台吗，明显多了很多DEBUG日志的输出，而且还打印输出了相应的sql语句。如下图所示：

那么问题来了，如果我想在控制台打印输出sql语句，但是又不想看到Debug信息怎么办？这就要用到我们上面所说的包级别日志了。我们修改配置文件如下：

server:
  port: 8805

# datasource
spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/christy?characterEncoding=UTF-8
    username: root
    password: 123456

# mybatis
mybatis:
  mapper-locations: classpath:com/christy/mapper/*.xml
  type-aliases-package: com.christy.entity

# logback
logging:
  level:
    root: info  # 指定全局根日志级别为INFO（默认）
    com.christy.mapper: debug   # 指定包级别日志为debug，在控制台不打印DEBUG日志时能看到sql语句

然后们再次运行上面的单元测试方法，可以看到控制台没有打印框架DEBUG日志，而只是打印了指定包级别日志的DEBUG信息，这个信息就是我们想要的sql信息。如下图所示：

SpringBoot日志切割

上面虽然能够打印我们想要的日志，但是在实际开发中我们不仅需要在控制台输出日志信息，还需要将运行日志输出到磁盘上，便于日常维护。这个时候就需要日志切割功能了。

在实际开发中我们的开发环境和生产环境配置文件和日志配置是不一样的，一半般都要做多环境配置。这里我们先调整一下resources的目录结构，如下图所示：

官方推荐使用的xml名字的格式为：logback-spring.xml而不是logback.xml，带spring后缀的可以使用<springProfile>这个标签。
这是因为logback.xml加载早于application.properties，所以如果你在logback.xml使用了变量时，而恰好这个变量是写在application.properties时，那么就会获取不到，只要改成logback-spring.xml就可以解决。

1.application.yml

# 指定当前为开发环境
spring:
  profiles:
    active: dev   # 开发环境端口号为8805

2.application-dev.yml

server:
  port: 8805

# datasource
spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/christy?characterEncoding=UTF-8
    username: root
    password: 123456
  ldap:
    template:
      ignore-name-not-found-exception:

# mybatis
mybatis:
  mapper-locations: classpath:com/christy/mapper/*.xml
  type-aliases-package: com.christy.entity

# logback
# logging:
#  level:
#    root: info  # 指定全局根日志级别为INFO（默认）
#    com.christy.mapper: debug   # 指定包级别日志为debug，在控制台不打印DEBUG日志时能看到sql语句

# 多环境下我们需要指定当前使用的日志文件
logging:
  config: classpath:logs/logback-dev.xml

3.logback-dev.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 从低到高 OFF -> FATAL -> ERROR -> WARN -> INFO -> DEBUG -> TRACE -> ALL -->

<!-- 属性描述
        scan：性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
        scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
        debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志文件输出位置：在当前项目根目录下的logs/spring-05-logback -->
    <property name="log_path" value="/logs/spring-05-logback" />
    <!-- 日志最大的历史 30天 -->
    <property name="maxHistory" value="30" />
    <!-- 文件输出格式 -->
    <!-- 格式化输出：
           %d：表示日期，
           %thread：表示线程名
           %-5level：级别从左显示5个字符宽度
           %msg：日志消息
           %n：是换行符
    -->
    <property name="PATTERN" value="%dyyyy-MM-dd HH:mm:ss [%thread] %-5level %logger -%msg%n" />

    <!-- ConsoleAppender用于在屏幕上输出日志-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--定义了一个过滤器,在LEVEL之下的日志输出会被打印出来-->
        <!-- 控制台只打印INFO及其以下级别的logger -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <!-- 定义控制台输出格式与编码 -->
        <encoder>
            <pattern>$PATTERN</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- ERROR级别日志 -->
    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 RollingFileAppender -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录ERROR级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <!-- 只接收与当前级别匹配的logger信息 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 拒绝与当前级别匹配的logger信息 -->
            <onMismatch>DENY</onMismatch>
        </filter>

        <!-- 最常用的滚动策略，它根据时间来制定滚动策略.既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>$log_path/%dyyyy-MM-dd/error-log.log</fileNamePattern>
            <!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件
                注意，删除旧文件是，那些为了归档而创建的目录也会被删除 -->
            <maxHistory>$maxHistory</maxHistory>
        </rollingPolicy>

        <!-- 按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。 -->
        <!--<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>$log_path/%dyyyy-MM-dd/.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
        </rollingPolicy>-->

        <!-- 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动  -->
        <!--<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>-->

        <encoder>
            <pattern>$PATTERN</pattern>
        </encoder>
    </appender>

    <!-- WARN级别日志appender -->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录WARN级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>$log_path/%dyyyy-MM-dd/warn-log.log</fileNamePattern>
            <!-- 日志最大的历史 -->
            <maxHistory>$maxHistory</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>$PATTERN</pattern>
        </encoder>
    </appender>

    <!-- INFO级别日志 appender -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录INFO级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>$log_path/%dyyyy-MM-dd/info-log.log</fileNamePattern>
            <!-- 日志最大的历史 -->
            <maxHistory>$maxHistory</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>$PATTERN</pattern>
        </encoder>
    </appender>

    <!-- DEBUG级别日志 appender -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录DEBUG级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>$log_path/%dyyyy-MM-dd/debug-log.log
            </fileNamePattern>
            <!-- 日志最大的历史 -->
            <maxHistory>$maxHistory</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>$PATTERN</pattern>
        </encoder>
    </appender>

    <!-- TRACE级别日志 appender -->
    <appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录TRACE级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>TRACE</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>$log_path/%dyyyy-MM-dd/trace-log.log</fileNamePattern>
            <!-- 日志最大的历史 60天 -->
            <maxHistory>$maxHistory</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>$PATTERN</pattern>
        </encoder>
    </appender>

    <!--
        <logger>用来设置某一个包或者具体的某一个类的日志打印级别以及指定<appender>。
        <logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。
        name:用来指定受此logger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别，大小写无关：TRACE、DEBUG、INFO、WARN、ERROR、ALL、OFF，
              还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
              如果未设置此属性，那么当前logger将会继承上级的级别。
        addtivity:是否向上级logger传递打印信息。默认是true。
    -->
    <!--<logger name="org.springframework.web" level="info"/>-->
    <!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->
    <!--
        使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
        第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
        第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：
     -->
    <!-- mybatis日志打印sql-->
    <logger name="com.christy.mapper" level="DEBUG"></logger>

    <!-- root级别 INFO -->
    <root level="INFO">
        <!-- 控制台输出 -->
        <appender-ref ref="CONSOLE" />
        <!-- 一般情况下我们只输出以下4种日志就可以了 -->
        <appender-ref ref="ERROR" />
        <appender-ref ref="INFO" />
        <appender-ref ref="WARN" />
        <appender-ref ref="DEBUG" />
        <!-- Trace一般情况下我们不输出 -->
        <appender-ref ref="TRACE" />
    </root>
</configuration>

对于配置文件和日志处理，目前开发和生产的环境是一样的，暂时不做区分处理

4.测试

我们再次运行上面的单元测试方法，注意观察控制台。效果如下：

本地磁盘上也已经记录下了详细的日志信息，如下图所示：

以上是关于SpringBoot日志的主要内容，如果未能解决你的问题，请参考以下文章

Java日志框架 -- SpringBoot中的日志使用

SpringBoot整合aop日志管理

springboot 集成 elk 日志收集功能

[SpringBoot] Spring Boot（10）Logback和Log4j2集成与日志发展史

[SpringBoot] Spring Boot（10）Logback和Log4j2集成与日志发展史

五SpringBoot整合log4j2