使用SpringMail写一个告警发送邮件系统
2019-08-05 本文已影响0人
精致的吴彦祖
没有bug的系统不是好系统！在我们日常的开发中系统报错了只会把错误信息打印在日志中，然后等着用户来反馈，程序员在着手处理，查日志，定位错误的代码行。
其实整个查看错误的过程是有好几步的，如果日志信息多了，那么排查错误就比较困难。那我们能不能程序发生错误了就马上通知程序员和运维人员呢？
答案是肯定能的，现在市面上有很多第三方类似的告警系统，甚至不止这一个发送邮件来告警，还有很多种方式。
但是我不想用第三方软件来做这么一个功能，我喜欢自己写一个，嘿嘿，程序员嘛，自己动手丰衣足食，足够满足自己的业务需求就好了。
为什么要使用发送邮件而不是发送验证码呢？因为发送验证码要钱，成本太高，发送邮件来告知是最方便也是成本最低的方案了。
好了，咱们开始动手写代码吧，先说说整个架构用的技术和版本，项目使用springBoot+springAop+springMail+SpringListener来搭建。
咱们使用的是smtp.163.com服务来发送邮件，所以咱们得有一个163邮箱账号，然后在设置页把POP3/SMTP/IMAP服务给开启。
配置好之后，咱们来开始写代码吧，我先把整个pom给贴出来。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.spring.mail</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springMail</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入aopjar-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>20.0</version>
</dependency>
<!--引入springMail jar包-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
主要的引入就是aop和springMail这两个dependency。
咱们再定义一个发送的模板消息实体类。
package com.spring.mail.bean;
import lombok.Data;
import lombok.ToString;
/**
* 定义发送信息模板
*/
@Data
@ToString
public class MailWarningBean {
/**
* 错误信息
*/
private String errorMsg;
/**
* 参数列表
*/
private String params;
/**
* 类路径
*/
private String path;
}
再把yml配置文件的代码贴出来
server:
port: 8080
tomcat:
uri-encoding: utf-8
spring:
aop:
auto: true
mail:
host: 220.181.12.11 #linux有时候不能有效的进行域名解析，所以我们直接用smtp.163.com来ping一下获取真实的ip地址
username: XXXXXX #填写你的邮箱地址(发送人)
password: XXXXXX #你的邮箱密码
default-encoding: UTF-8
properties:
mail:
smtp:
auth: true
port: 465 #使用465端口 因为在服务器上25端口不能用
socketFactory:
port: 465
class: javax.net.ssl.SSLSocketFactory
fallback: false
starttls:
enable: true
required: true
port: 465
咱们的思路主要是：使用spring的事件监听来定义邮件的发送，使用aop的异常增强来发送邮件。当异常产生了就发送邮件，告知咱们的程序员。
先定义spring的事件监听模块。
package com.spring.mail.event;
import lombok.Data;
import org.springframework.context.ApplicationEvent;
/**
* 定义事件
* @param <T>
*/
@Data
public class MyEvent<T> extends ApplicationEvent {
private T t;
public MyEvent(Object source,T t){
super(source);
this.t=t;
}
}
事件类已经写好，咱们就开始动手写事件的监听类，主要就是做邮件的发送，sendMail方法使用了Async注解，Async注解就是开启异步，让发送邮件异步来处理。
package com.spring.mail.event.listener;
import com.google.common.base.Throwables;
import com.spring.mail.bean.MailWarningBean;
import com.spring.mail.event.MyEvent;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.event.EventListener;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;
import javax.mail.internet.MimeMessage;
@Component
@Slf4j
public class MailListener {
@Autowired
private JavaMailSender javaMailSender;
/**
* 定义事件、开启异步
* @param myEvent
*/
@EventListener
@Async
public void sendMail(MyEvent<MailWarningBean> myEvent){
MimeMessage mimeMessage=null;
try{
MailWarningBean mailWarningBean=myEvent.getT();
mimeMessage=javaMailSender.createMimeMessage();
MimeMessageHelper msgHelper=new MimeMessageHelper(mimeMessage,true);
//发送人邮箱
msgHelper.setFrom("XXXXXXX");
//收件人邮箱(单个)
msgHelper.setTo("XXXXXXXX");
/**
* 发送多人
* //收件人
* InternetAddress[] internetAddresses=new InternetAddress[]{
* new InternetAddress("XXXXXXX.com","","utf-8"),
* new InternetAddress("XXXXXXX.com","","utf-8")
* };
* msgHelper.setTo(internetAddresses);
*/
//主题
msgHelper.setSubject("服务器系统传错误，请尽快处理！");
//拼接好发送的内容
StringBuffer sb=new StringBuffer();
sb.append("<p><h2>您的类方法路径"+mailWarningBean.getPath()+"出现错误！</h2></p>");
sb.append("<p>参数列表："+mailWarningBean.getParams()+"</p>");
sb.append("<p>错误信息：<p style='color:red;'>"+mailWarningBean.getErrorMsg()+"。</p>");
sb.append("请尽快处理。</p><p>出现错误服务器ip地址：<strong>XXX.XXX.XX</strong></p>");
msgHelper.setText(sb.toString(),true);
javaMailSender.send(mimeMessage); //进行发送
log.info("发送邮件成功");
}catch(Exception e){
log.error("发送告警邮件出现错误，错误原因："+ Throwables.getStackTraceAsString(e));
}
}
}
咱们再来做aop的处理，aop的增强方式有前置增强、后置增强、环绕增强、异常增强等方式，咱们采用异常增强，因为咱们主要的业务就是做告警，当程序出错了咱们就发送邮件告知运维人员和开发人员。来，我把aop的代码贴出来。
package com.spring.mail.aop;
import com.google.common.base.Throwables;
import com.spring.mail.bean.MailWarningBean;
import com.spring.mail.event.MyEvent;
import com.spring.mail.event.listener.MailListener;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class MailAspect {
@Autowired
private MailListener mailListener;
//定义切面
@Pointcut("execution(public * com.spring.mail.controller.*.*(..))")
public void MailAspect(){}
/**
* 使用aop的异常增强方式来发送邮件
* @param joinPoint
* @param e
*/
@AfterThrowing(pointcut = "MailAspect()",throwing = "e")
public void deAfterThrowing(JoinPoint joinPoint,Throwable e){
Object[] param=joinPoint.getArgs(); //获取参数列表
StringBuilder sb=new StringBuilder();
for(Object obj:param){
sb.append(obj+",");
}
MailWarningBean mailWarningBean=new MailWarningBean();
mailWarningBean.setErrorMsg(Throwables.getStackTraceAsString(e));
mailWarningBean.setParams(sb.delete(0,sb.length()).toString());
mailWarningBean.setPath(joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName()); //获取方法路径
MyEvent<MailWarningBean> myEvent=new MyEvent<>(this,mailWarningBean);
mailListener.sendMail(myEvent);
}
}
整个配置就写的差不多了，在aop类上使用@Pointcut来定义切面，当controller出现异常时发送邮件。接下来，咱们就测试测试吧。
先写一个controller
package com.spring.mail.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MainController {
@GetMapping("/hello")
public String hello(){
System.out.println(1/0);
return "test";
}
}
在接口内故意写一行代码产生异常，看会不会接收到邮件。
访问接口时报错了，日志信息打印出了邮件已发送，咱们现在看看邮箱有没有收到告警的邮件。
可以看到邮箱是收到了此邮件，说明咱们整个告警模块系统就写好了。完整的代码可以点下面的链接去git克隆代码，有不懂的地方欢迎大家留言提问和讨论。
git仓库：https://github.com/wuyanzu01/springMail
请关注微信公众号：请快点喜欢我
