**这是我参与8月更文挑战的第5天，活动详情查看：[8月更文挑战](https://juejin.cn/post/6987962113788493831 "https://juejin.cn/post/6987962113788493831")** ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/458c063ee6ae459b86aa7ed1a596d12c~tplv-k3u1fbpfcp-zoom-1.image) > [SpringBoot实战基于异常日志的邮件报警](https://mp.weixin.qq.com/s?__biz=MzU3MTAzNTMzMQ==&mid=2247486608&idx=1&sn=78413e96a2b93f9bb973c002e9e1c542&chksm=fce7173ccb909e2adc663403ec212ac1e4f637eb4a72c75ee432cb5d84576756a9c5aa84eefa&token=1216962272&lang=zh_CN#rd) 相信所有奋斗在一线的小伙伴，会很关心自己的系统的运行情况，一般来说，基础设施齐全一点的公司都会有完善的报警方案，那么如果我们是一个小公司呢，不能因为基础设施没有，就失去对象的感知能力吧；如果我们的系统大量异常却不能实时的触达给我们，那么也就只会有一个结果--杀个程序猿祭天本文简单的介绍一种实现思路，基于error日志来实现邮件的报警方案 ## I. 项目环境 ### 1. 项目依赖本项目借助`SpringBoot 2.2.1.RELEASE` + `maven 3.5.3` + `IDEA`进行开发开一个web服务用于测试 ```xml org.springframework.boot spring-boot-starter-mail ``` ### 2. 配置邮件相关配置如下，注意使用自己的用户名 + 授权码填充下面缺失的配置 ```yaml spring: #邮箱配置 mail: host: smtp.163.com from: xhhuiblog@163.com # 使用自己的发送方用户名 + 授权码填充 username: password: default-encoding: UTF-8 properties: mail: smtp: auth: true starttls: enable: true required: true ``` ## II. 异常日志的邮件预警 ### 1. 设计思路接下来这个方案的主要出发点在于，当程序出现大量的异常，表明应用多半出现了问题，需要立马发送给项目owner 要实现这个方案，关键点就在于异常出现的感知与上报 - 异常的捕获，并输出日志（这个感觉属于标配了吧，别告诉我现在还有应用不输出日志文件的...） - 对于这个感知，借助logback的扩展机制，可以实现，后面介绍 - 异常上报：邮件发送关于email的使用姿势，推荐参考博文 [SpringBoot 系列之邮件发送姿势介绍](http://mp.weixin.qq.com/s?__biz=MzU3MTAzNTMzMQ==&mid=2247486591&idx=1&sn=04f18e2f313abd371947f9818e238067&chksm=fce717d3cb909ec575b8e521843eff04edfcf844e59ca976515bc29d8a23782c4d5d30580d0e&token=908878619&lang=zh_CN#rd) ### 2. 自定义appender 定义一个用于错误发送的Appender，如下 ```java public class MailUtil extends AppenderBase { public static void sendMail(String title, String context) { SimpleMailMessage simpleMailMessage = new SimpleMailMessage(); //邮件发送人 simpleMailMessage.setFrom(ContextUtil.getEnvironment().getProperty("spring.mail.from", "bangzewu@126.com")); //邮件接收人，可以是多个 simpleMailMessage.setTo("bangzewu@126.com"); //邮件主题 simpleMailMessage.setSubject(title); //邮件内容 simpleMailMessage.setText(context); JavaMailSender javaMailSender = ContextUtil.getApplicationContext().getBean(JavaMailSender.class); javaMailSender.send(simpleMailMessage); } private static final long INTERVAL = 10 * 1000 * 60; private long lastAlarmTime = 0; @Override protected void append(ILoggingEvent iLoggingEvent) { if (canAlarm()) { sendMail(iLoggingEvent.getLoggerName(), iLoggingEvent.getFormattedMessage()); } } private boolean canAlarm() { // 做一个简单的频率过滤 long now = System.currentTimeMillis(); if (now - lastAlarmTime >= INTERVAL) { lastAlarmTime = now; return true; } else { return false; } } } ``` ### 3. Spring容器上面的邮件发送中，需要使用`JavaMailSender`，写一个简单的SpringContext工具类，用于获取Bean/Propertiy ```java @Component public class ContextUtil implements ApplicationContextAware, EnvironmentAware { private static ApplicationContext applicationContext; private static Environment environment; @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { ContextUtil.applicationContext = applicationContext; } @Override public void setEnvironment(Environment environment) { ContextUtil.environment = environment; } public static ApplicationContext getApplicationContext() { return applicationContext; } public static Environment getEnvironment() { return environment; } } ``` ### 4. logback配置接下来就是在日志配置中，使用我们上面定义的Appender `logback-spring.xml`文件内容如下： ```xml %d [%t] %-5level %logger{36}.%M\(%file:%line\) - %msg%n UTF-8 ERROR

``` ### 5. 测试demo 接下来演示一下，是否可以达到我们的预期 ```java @Slf4j @RestController @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class); } @GetMapping("div") public String div(int a, int b) { try { return String.valueOf(a / b); } catch (Exception e) { log.error("div error! {}/{}", a, b, e); return "some error!"; } } } ``` ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d59cd8c37348407da11abb4f603c4751~tplv-k3u1fbpfcp-zoom-1.image) ### 5.小结本篇博文主要提供了一个思路，借助logback的扩展机制，来实现错误日志与预警邮件绑定，实现一个简单的应用异常监控上面这个实现只算是一个雏形，算是抛砖引玉，有更多可以丰富的细节，比如 - 飞书/钉钉通知（借助飞书钉钉的机器来报警，相比较于邮件感知性更高） - 根据异常类型，做预警的区分 - 更高级的频率限制等在这里推荐一个我之前开源的预警系统，可以实现灵活预警方案配置，频率限制，重要性升级等 - 一个可扩展的报警系统 [https://github.com/liuyueyi/quick-alarm](https://github.com/liuyueyi/quick-alarm) ## III. 不能错过的源码和相关知识点 ### 0. 项目 - 工程：[https://github.com/liuyueyi/spring-boot-demo](https://github.com/liuyueyi/spring-boot-demo) - 源码：[https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-case/430-mail-alarm](https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-case/430-mail-alarm) 推荐关联博文 - [SpringBoot 系列之邮件发送姿势介绍](http://mp.weixin.qq.com/s?__biz=MzU3MTAzNTMzMQ==&mid=2247486591&idx=1&sn=04f18e2f313abd371947f9818e238067&chksm=fce717d3cb909ec575b8e521843eff04edfcf844e59ca976515bc29d8a23782c4d5d30580d0e&token=908878619&lang=zh_CN#rd) ### 1. 微信公众号：一灰灰Blog 尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛 - 一灰灰Blog个人博客 [https://blog.hhui.top](https://blog.hhui.top) - 一灰灰Blog-Spring专题博客 [http://spring.hhui.top](http://spring.hhui.top)