180623-SpringBoot之logback配置文件

SpringBoot配置logback

项目的日志配置属于比较常见的case了，以前接触和使用的都是Spring结合xml的方式，引入几个依赖，而后写个 logback.xml 配置文件便可，那么在SpringBoot中能够怎么作？

<!-- more -->

I. 配置说明

在resource目录下，新建一个日志文件: logback-spring.xml，内容以下

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
    <!-- appender是configuration的子节点，是负责写日志的组件。 -->
    <!-- ConsoleAppender：把日志输出到控制台 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d [%t] %-5level %logger{36}.%M\(%file:%line\) - %msg%n</pattern>
            <!-- 控制台也要使用UTF-8，不要使用GBK，不然会中文乱码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="errorAlarm" class="com.git.hui.story.common.alarm.ServiceAlarm">
        <!--若是只是想要 Error 级别的日志，那么须要过滤一下，默认是 info 级别的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>

    <!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其余文件 -->
    <!-- 如下的大概意思是：1.先按日期存日志，日期变了，将前一天的日志文件名重命名为XXX%日期%索引，新的日志仍然是demo.log -->
    <!--             2.若是日期没有发生变化，可是当前日志的文件大小超过1KB时，对当前日志进行分割 重命名-->
    <appender name="story" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--若是只是想要 Error 级别的日志，那么须要过滤一下，默认是 info 级别的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <File>logs/story.log</File>
        <!-- rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。 -->
        <!-- TimeBasedRollingPolicy： 最经常使用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
            <!-- 文件名：log/demo.2018-06-23.0.log -->
            <fileNamePattern>logs/arch/story.%d.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件，该日志文件的保存期限为3天 -->
            <maxHistory>3</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，测试时可改为1KB看效果 -->
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <!-- pattern节点，用来设置日志的输入格式 -->
            <pattern>
                %d %p (%file:%line\)- %m%n
            </pattern>
            <!-- 记录日志的编码:此处设置字符集 - -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 指定项目中某个包，当有日志操做行为时的日志记录级别 -->
    <!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
    <!-- additivity=false 表示匹配以后，再也不继续传递给其余的logger-->
    <logger name="com.git.hui" level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="story"/>
        <appender-ref ref="errorAlarm"/>
    </logger>

    <logger name="com.github.hui" level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="story"/>
        <appender-ref ref="errorAlarm"/>
    </logger>

    <!-- 控制台输出日志级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

上面是一个基础的日志输出配置，额外说明几点：

• 配置文件名可否是其余的
• 在appender标签中对日志级别进行过滤
• 一个logger标签下有多个appender-ref
• 自定义的appender实现类

II. 扩展

1. 配置文件名

配置文件名默认为 logback-spring.xml，若是我但愿改为 mylog.xml 能够怎么办？

主要是修改 application.yml 配置文件中的参数指定

logging:
  config: classpath:mylog.xml

2. logger标签

logger标签下能够接上多个<appender-ref>, 即表示命中的日志，会采用这多个appender,都打印一遍，好比上面的，来一条日志，在控制台会输出，在日志文件会输出，若是是error日志，还会触发ServiceAlarm的逻辑

所以就有一个问题，咱们可能但愿不一样的<appender>内部有个日志级别的控制，好比控制台能够输出debug日志，而日志文件中只输出info级别的，这就须要在appender标签内添加filter属性了

<appender name="errorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--若是只是想要 Error 级别的日志，那么须要过滤一下，默认是 info 级别的，ThresholdFilter-->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>WARN</level>
    </filter>
</appender>

3. 自定义appender实现类

前面的配置文件中，使用了一个自定义的 AlarmService, 主要是在接收到错误日志时，实现自定义报警,对应的简单实现以下

/**
 * 报警
 * Created by @author yihui in 16:43 18/6/23.
 */
public class ServiceAlarm extends AppenderBase<ILoggingEvent> {
    private static final long INTERVAL = 10 * 1000 * 60;
    private long lastAlarmTime = 0;

    @Override
    protected void append(ILoggingEvent iLoggingEvent) {
        if (canAlarm()) {
            doAlarm(iLoggingEvent.getFormattedMessage());
        }
    }

    private boolean canAlarm() {
        long now = System.currentTimeMillis();
        if (now - lastAlarmTime >= INTERVAL) {
            lastAlarmTime = now;
            return true;
        } else {
            return false;
        }
    }

    private void doAlarm(String content) {
        try {
            EmailWrapper.sendMail("异常报警", "bangzewu@126.com", content);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

4. 其余

关于logback的配置文件中的详细参数，能够参考博文:

• Logback 简明使用手册

III. 其余

1. 一灰灰Blog： https://liuyueyi.github.io/hexblog

一灰灰的我的博客，记录全部学习和工做中的博文，欢迎你们前去逛逛

2. 声明

尽信书则不如，已上内容，纯属一家之言，因我的能力有限，不免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

• 微博地址: 小灰灰Blog
• QQ： 一灰灰/3302797840

3. 扫描关注