SpringBoot使用记录之日志Logback

最新推荐文章于 2022-04-16 10:59:39 发布

youngljx

最新推荐文章于 2022-04-16 10:59:39 发布

阅读量172

点赞数

分类专栏： SpringBoot

本文链接：https://blog.csdn.net/YOUNGljx/article/details/105074630

版权

SpringBoot 专栏收录该内容

24 篇文章 0 订阅

订阅专栏

一个Java小白的学习之路个人博客 youngljx.top

SpringBoot实现使用日志

日志框架

日志门面	日志实现
JCL（Jakarta Commons Logging）、SLF4j（Simple Logging Facade for Java）、 jboss-logging	Log4j 、JUL（java.util.logging）、Log4j2 、 Logback

上表的日志门面对应了门面模式中的 Facede 对象，它们只是一个接口层，并不提供日志实现；而日志实现则对应着各个子系统或者模块，日志记录的具体逻辑实现，就写在这些右边的框架里面；那我们的应用程序就相当于客户端。

SpringBoot 底层默认选用的就是 SLF4j 和 Logback 来实现日志输出，并用INFO级别输出到控制台。
SpringBoot 能自动适配所有的日志，而且底层使用 slf4j+logback 的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可。

日志的使用

logger的使用

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;

@SpringBootTest
@ExtendWith(SpringExtension.class)
public class LoggingTest {

    private final Logger logger= LoggerFactory.getLogger(LoggingTest.class);

    @Test
    void LoggingTest(){
        String name ="zhangsan";
        String password ="zs123456";
        //日志的级别；
        //由低到高   trace<debug<info<warn<error
        //可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
        logger.trace("这是trace日志...");
        logger.debug("这是debug日志...");
        // SpringBoot 默认给我们使用的是 info 级别的，没有指定级别的就用SpringBoot 默认规定的级别；root 级别
        logger.info("这是info日志..."+"name : " +name+" , password: "+ password);
         //{}占位符的使用，不用拼接字符串
        logger.info("这是info日志..."+"name: {},password: {}",name,password);
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }
}

@slf4j 之lombok注解的使用

导入lombok依赖使用 @slf4j注解

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

@SpringBootTest
@ExtendWith(SpringExtension.class)
@Slf4j
public class LoggingTest {

   @Test
    void LoggingTest(){    //直接使用log对象调用 效果同上
        log.debug("debug-----");
        log.info("info-------");
        log.error("error-----");
    }
 }

application.properties或yml配置日志属性

logging.level.* :  *为包名或Logger名的前缀来设置日志级别。
logging.file :配置日志输出的文件名，也可以配置文件名的绝对路径。
logging.path :配置日志的路径。如果没有配置logging.file,Spring Boot 将默认使用spring.log作为文件名。
logging.pattern.console :定义console中logging的样式。
logging.pattern.file :定义文件中日志的样式。

#root日志以WARN级别输出
 logging.level.root=WARN    
#springframework.web日志以DEBUG级别输出
 logging.level.org.springframework.web=DEBUG
 
# 在当前磁盘的根路径下创建 spring 文件夹和里面的 log 文件夹；使用 spring.log 作为默认文件
logging.path=/spring/log
# 指定完整的文件名
#logging.file=D:/springboot.log

#logging.file.path=指定路径和文件名

#  在控制台输出的日志的格式
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

在这里插入图片描述

自定义日志配置

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

框架	命名方式
Logback	logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j2	log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
JDK (Java Util Logging)	logging.properties

上面是默认的命名规则，并且放在src/main/resources下面即可。

如果想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以在application.properties配置文件里面通过logging.config属性指定自定义的名字：

logging.config=classpath:logging-config.xml

logback-spring.xml：日志框架就不直接加载日志的配置项，由 SpringBoot 解析日志配置，可以使用 SpringBoot 的高级 Profile 功能。

<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">
        
               <!--指定在 dev 环境下，控制台使用该格式输出日志-->
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>       
               <!--指定在非 dev 环境下，控制台使用该格式输出日志-->
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            
        </layout>
    </appender>

logback-spring.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="nasus-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">
            <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>
    </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.nasus" 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>

切换日志框架

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

参考原文链接：
https://www.jianshu.com/p/a27de9b7d297
http://tengj.top/2017/04/05/springboot7/

youngljx

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot使用记录之日志Logback

SpringBoot实现使用日志日志框架日志的使用logger的使用@slf4j 之lombok注解的使用application.properties或yml配置日志属性自定义日志配置logback-spring.xml 的详细配置切换日志框架日志框架日志门面日志实现JCL（Jakarta Commons Logging）、SLF4j（Simple Logging Faca...
复制链接

扫一扫

专栏目录