Spring Boot 配置 logback 实现【异常发送邮件提醒】

开篇

       强烈建议：本文来配合Spring Boot 配置 logback 实现【日志多环境下按指定条件滚动输出】 来一起掌握 SpringBoot项目中 logback 关于日志全方位监控。

1.本文可实现

       项目在出现异常时，能够及时通过邮件方式来发送报警信息。本文可配合Spring Boot 配置 logback 实现【日志多环境下按指定条件滚动输出】 来实现 logback 方式下的日志全放监控。

2.简单配置

Ⅰ.添加Maven依赖

<dependency>
	<groupId>javax.mail</groupId>
	<artifactId>mail</artifactId>
	<version>1.4.7</version>
</dependency>

Ⅱ.配置文件配置

       在application.properties配置文件中，配置一下内容，主要是为了下文 logback-spring.xml 中使用。具体配置介绍如下所示：

# logback 邮件相关配置
spring.mail.host=smtp.qq.com   #服务器地址
spring.mail.username=348110xxx@qq.com    #发送邮件用户
spring.mail.password=zkeujotaacvycaee    #密码
spring.mail.default-encoding=UTF-8    #编码
spring.mail.error.subject=[ERROR] in 项目名    #自定义邮件主题(填写项目名用于提示)
spring.mail.error.to=lzb348110xxx@163.com,lzb348110xxx@126.com     #接受者邮件地址

       Tips：服务器地址，密码等，并不是QQ密码，是一个授权码。详细介绍请参考：Spring Boot配置邮件发送)。spring.mail.error.subject、spring.mail.error.to 这两个属性名可以自定义，用于 logback-spring.xml 配置文件中使用。

Ⅲ.新建 logback-spring.xml 文件

       在 classpath 下创建 logback-spring.xml 文件。Spring Boot 在加载 logback 配置时，默认会读取 classpath 目录下的 logback-spring.xml 文件。如果文件名需要自定义，则需要在 application.properties 配置文件下通过该logging.config属性来指定。

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<configuration>
    <contextName>logback-email</contextName>
    
    <!--logback异常邮件发送-->
    <!-- 邮件配置 -->
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->
    <springProperty scope="context" name="smtpHost" source="spring.mail.host" />
    <springProperty scope="context" name="username" source="spring.mail.username" />
    <springProperty scope="context" name="password" source="spring.mail.password" />
    <springProperty scope="context" name="mailSubject" source="spring.mail.error.subject" />
    <springProperty scope="context" name="mailTo" source="spring.mail.error.to" />
    <springProperty scope="context" name="charsetEncoding" source="spring.mail.default-encoding" />

    <appender name="MAIL" class="ch.qos.logback.classic.net.SMTPAppender">
        <!--服务器地址-->
        <smtpHost>${smtpHost}</smtpHost>
        <!--端口(默认为25)-->
        <smtpPort>25</smtpPort>
        <!--用户名-->
        <username>${username}</username>
        <!--密码(授权码)-->
        <password>${password}</password>
        <!--是否开启SSL安全-->
        <SSL>false</SSL>
        <!--是否同步发送-->
        <asynchronousSending>true</asynchronousSending>
        <!--发送者-->
        <from>${username}</from>
        <!--接收者-->
        <to>${mailTo}</to>
        <!--邮件主题-->
        <subject>${mailSubject}: %logger{0} </subject>
        <!--编码-->
        <charsetEncoding>${charsetEncoding}</charsetEncoding>
        <cyclicBufferTracker class="ch.qos.logback.core.spi.CyclicBufferTracker">
            <!-- 每个电子邮件只发送一个日志条目 -->
            <bufferSize>1</bufferSize>
        </cyclicBufferTracker>
        <!--HTML展示-->
        <layout class="ch.qos.logback.classic.html.HTMLLayout"/>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!--错误级别(只会提示大于该级别的错误)-->
            <level>ERROR</level>
        </filter>
    </appender>
    
	
    <!-- 4. 最终的策略 -->
    <!--你可以来指定某些包来发邮件,也可以指定某个环境下都发邮件-->
    
    <!--4.0 指定某个包发送邮件-->
	<logger name="包名" level="INFO" additivity="false">
        <appender-ref ref="MAIL"/>
    </logger>

    <!-- 4.1 开发环境:打印控制台-->
    <springProfile name="dev">
        <root level="info">
            <!--代表开发环境，只打印日志到客户端-->
            <!--<appender-ref ref="CONSOLE" />--> <!--此处介绍邮件相关，这个 CONSOLE 未作配置-->
            <!--代表开发环境，有大于Error级别(级别自己配置)的，会通过邮件提醒-->
            <appender-ref ref="MAIL"/>
        </root>
    </springProfile>
    
	<!-- 4.2 测试环境+生产环境:输出到控制台 + 文档(如下CONSOLE、DEBUG_FILE 等未配置，这部分具体配置可参考：https://blog.csdn.net/lzb348110175/article/details/105437940) -->
    <springProfile name="test,prod">
        <root level="info">
            <!--控制台-->
            <appender-ref ref="CONSOLE" />
            <!--文档-->
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
			<appender-ref ref="MAIL" />
        </root>
    </springProfile>
</configuration>

3.简单测试一下

       Service 层，我们来手动一个错误。发送请求后，程序便会执行到 catch，然后触发 log.error进行日志输出。由于我们配置的日志级别为error，此时我们便会收到一条异常提醒邮件。邮件如下图所示

@Service
@Slf4j
public class UserServiceImpl implements UserService {

    @Autowired
    UserMapper userMapper;

    @Override
    public User getUserById(int id) {
        User user = null;
        try {
             userMapper.getUserById(id);
            System.out.println(1 / 0);
        } catch (Exception e) {
            log.error("出错了",e);
        }
        return user;
    }
}

4.附实例demo

       demo实现了 Spring Boot 整合 MyBatis ，多环境日志解决方案。下载后只需要修改一下数据源，便可以正常启动。

       Tips：该demo 已整合Spring Boot 配置 logback 实现【日志多环境下按指定条件滚动输出】这篇文章内容，是一个整合实例。

       请点击下载：Spring Boot 配置 logback 实现日志相关功能（提取码：dalr ）

---

Spring Boot 配置 logback 实现【异常发送邮件提醒】，介绍到此为止

如果本文对你有所帮助，那就给我点个赞呗

End

转载：https://blog.csdn.net/lzb348110175/article/details/105439689