• SpringBoot Logback统一日志处理


    一、日志

    1、配置日志级别

    日志记录器(Logger)的行为是分等级的。如下表所示:

    分为:OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL

    默认情况下,spring boot从控制台打印出来的日志级别只有INFO及以上级别,可以配置日志级别

    # 设置日志级别
    logging:
      level: 
        root: WARN

    这种方式只能将日志打印在控制台上。

    二、Logback日志

    spring boot内部使用Logback作为日志实现的框架。

    Logback和log4j非常相似,如果你对log4j很熟悉,那对logback很快就会得心应手。

    1、配置logback日志

    注释掉application.yml中的日志配置

    resources 中创建 logback-spring.xml

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration  scan="true" scanPeriod="10 seconds">
        <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
        <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
        <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
        <!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
        <contextName>logback</contextName>
        <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
        <property name="log.path" value="E:/log/edu" />
    
        <!--控制台日志格式:彩色日志-->
        <!-- magenta:洋红 -->
        <!-- boldMagenta:粗红-->
        <!-- cyan:青色 -->
        <!-- white:白色 -->
        <!-- magenta:洋红 -->
        <property name="CONSOLE_LOG_PATTERN"
                  value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/>
    
        <!--文件日志格式-->
        <property name="FILE_LOG_PATTERN"
                  value="%date{yyyy-MM-dd HH:mm:ss} |%-5level |%thread |%file:%line |%logger |%msg%n" />
    
        <!--编码-->
        <property name="ENCODING"
                  value="UTF-8" />
    
        <!--输出到控制台-->
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <!--日志级别-->
                <level>DEBUG</level>
            </filter>
            <encoder>
                <!--日志格式-->
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                <!--日志字符集-->
                <charset>${ENCODING}</charset>
            </encoder>
        </appender>
    
        <!--输出到文件-->
        <appender name="INFO_FILE" 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>
            <!-- 正在记录的日志文件的路径及文件名 -->
            <file>${log.path}/log_info.log</file>
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>${ENCODING}</charset>
            </encoder>
            <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 每天日志归档路径以及格式 -->
                <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>500MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日志文件保留天数-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
        </appender>
    
        <appender name="WARN_FILE" 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>
            <!-- 正在记录的日志文件的路径及文件名 -->
            <file>${log.path}/log_warn.log</file>
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>${ENCODING}</charset> <!-- 此处设置字符集 -->
            </encoder>
            <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日志文件保留天数-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
        </appender>
    
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 日志过滤器:此日志文件只记录ERROR级别的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <!-- 正在记录的日志文件的路径及文件名 -->
            <file>${log.path}/log_error.log</file>
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>${ENCODING}</charset> <!-- 此处设置字符集 -->
            </encoder>
            <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日志文件保留天数-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
        </appender>
    
        <!--开发环境-->
        <springProfile name="dev">
            <!--可以灵活设置此处,从而控制日志的输出-->
            <root level="INFO">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="INFO_FILE" />
                <appender-ref ref="WARN_FILE" />
                <appender-ref ref="ERROR_FILE" />
            </root>
        </springProfile>
    
        <!--生产环境-->
        <springProfile name="pro">
            <root level="ERROR">
                <appender-ref ref="ERROR_FILE" />
            </root>
        </springProfile>
    
    </configuration>

    2、将错误日志输出到文件

    类上添加注解 @Slf4j

    异常输出语句 log.error(e.getMessage());

    package com.stu.service.base.handler;
    
    import com.stu.service.base.exception.CustomException;
    import com.stu.service.base.result.R;
    import com.stu.service.base.utils.ExceptionUtils;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    /******************************
     * 用途说明:统一异常处理
     * 作者姓名: Administrator
     * 创建时间: 2022-04-17 23:32
     ******************************/
    @Slf4j
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
    
        /***********************************
         * 用途说明:自定义异常
         * 返回值说明: com.stu.service.base.result.R
         ***********************************/
        @ExceptionHandler(CustomException.class)
        @ResponseBody
        public R customException(CustomException e){
    //        e.printStackTrace();
            log.error(e.getMessage());
            log.error(ExceptionUtils.getMessage(e));
            return R.error().message(e.getMessage()).code(e.getCode());
        }
        /***********************************
         * 用途说明:数字异常
         * 返回值说明: com.stu.service.base.result.R
         ***********************************/
        @ExceptionHandler(ArithmeticException.class)
        @ResponseBody
        public R arithmeticException(Exception e){
    //        e.printStackTrace();
            log.error("e.getMessage() ==START===      "+e.getMessage()+"  ==END=== ");
            log.error("ExceptionUtils.getMessage(e) ==========START===   "+ExceptionUtils.getMessage(e)+"  ==END=== ");
            log.error("eeeeeeeeeeee ==========START===   "+e+"  ==END=== ");
            return R.error().message(e.getMessage());
        }
        /***********************************
         * 用途说明:全局异常
         * 返回值说明: com.stu.service.base.result.R
         ***********************************/
        @ExceptionHandler(Exception.class)
        @ResponseBody
        public R error(Exception e){
            log.error(ExceptionUtils.getMessage(e));
            return R.error().message(e.getMessage());
        }
    
    }

    3、将日志堆栈信息输出到文件

    package com.stu.service.base.utils;
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.io.StringWriter;
    /******************************
     * 用途说明:
     * 作者姓名: Administrator
     * 创建时间: 2022-04-18 22:26
     ******************************/
    
    public class ExceptionUtils {
    
        /***********************************
         * 用途说明:
         * 返回值说明: java.lang.String
         ***********************************/
        public static String getMessage(Exception e) {
            StringWriter sw = null;
            PrintWriter pw = null;
            try {
                sw = new StringWriter();
                pw = new PrintWriter(sw);
                // 将出错的栈信息输出到printWriter中
                e.printStackTrace(pw);
                pw.flush();
                sw.flush();
            } finally {
                if (sw != null) {
                    try {
                        sw.close();
                    } catch (IOException e1) {
                        e1.printStackTrace();
                    }
                }
                if (pw != null) {
                    pw.close();
                }
            }
            return sw.toString();
        }
    }

    调用

    log.error(ExceptionUtil.getMessage(e));
    作者:
    出处:https://www.cnblogs.com/konglxblog//
    版权:本文版权归作者和博客园共有
    转载:欢迎转载,文章中请给出原文连接,此文章仅为个人知识学习分享,否则必究法律责任
  • 相关阅读:
    with一个对象,自动触发__enter__方法
    SQLAlchemy-Utils
    SQLAlchemy
    wtforms
    Python数据库连接池DBUtils(基于pymysql模块连接数据库)
    VMWare安装linux centos,安装中文输入法
    HttpServletRequest和ServletRequest的区别
    Java序列化
    mybatis循环取序列,值相同问题处理
    利用jdk将wsdl生成java代码
  • 原文地址:https://www.cnblogs.com/konglxblog/p/16794890.html
Copyright © 2020-2023  润新知