定时任务报警通知解决方案详解

作者： 唐涛、黄晓萌

什么是定时任务

定时任务是每个业务常见的需求，比如每分钟扫描超时支付的订单，每小时清理一次数据库历史数据，每天统计前一天的数据并生成报表等等。

随着微服务和云计算的兴起，定时任务技术也是发展迅速，不仅能做单机的定时任务，而且在分布式系统下应用也很广泛，成为了业务做兜底、数据处理的第一选择。

定时任务为什么需要通知

定时任务现在在业务数据处理中的比重越来越重，如果业务数据处理失败了，需要及时通知到业务方，确保了服务的可靠性和稳定性。同时，好的定时任务通知系统，还能分析任务失败的原因（比如堆栈信息）并通知给业务方，帮助用户快速定位问题。

根据通知的类型，大概可以有以下几类：

成功通知：任务执行成功，把结果通知给用户。比如统计前一天的数据并把 GaaP 结果通过短信等渠道发送给对应负责人。
超时通知：任务执行超时，通知用户。
失败通知：任务执行失败，通知用户。
机器异常通知：运行的机器下线或者繁忙，通知用户。

自研定时任务报警通知

如果是自研的定时任务系统，或者使用了开源定时任务框架（比如 Quartz），想要增加报警通知能力，我们可以采取什么方案呢？从实时性角度来看，短信和电话通知实时性最高，但是这两种方案需要比较大的成本，比如短信通知需要短信平台。如果没有短信平台，我们也可以采用邮件和 webhook 通知。

邮件

每个邮件服务器都由 SMTP 服务器和 POP3 服务器构成，其中 SMTP 服务器负责发邮件的请求，而 POP3 负责收邮件的请求。通过 SMTP 与 POP3 即可实现邮件的收发。

邮件发送原理图

配置邮件服务器

以网易 163 邮件为例，在发送方邮箱设置里，开启 POP3/SMTP 服务

以 Java 代码为例，发送邮件的 demo

import org.junit.Test;
import javax.mail.Message;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Properties;

public class SendMailDemo {
    public static void main(String[] args) throws Exception {
        Properties prop = new Properties();
        prop.setProperty("mail.host","smtp.163.com");//设置发送方邮箱服务器
        prop.setProperty("mail.transport.protocol","smtp");//邮件发送协议
        prop.setProperty("mail.smtp.auth","true");//需要验证用户名密码
        Session session = Session.getDefaultInstance(prop);
        Transport ts = session.getTransport();
        String mailUser = "xxx@163.com"; //邮箱的账号
        String mailPasswd = "123456789"; //邮箱的密码
        ts.connect("smtp.163.com", mailUser, mailPasswd);
        MimeMessage message = new MimeMessage(session);
        message.setFrom(new InternetAddress(mailUser));
        //收件人的邮箱地址
        message.setRecipient(Message.RecipientType.TO,new InternetAddress("xxxx@163.com"));
        //邮件的标题
        message.setSubject("自定义通知");
        message.setContent("<h1 style='color:black'>邮件通知发送成功!</h1>","text/html;charset=UTF-8");
        ts.sendMessage(message,message.getAllRecipients());
        ts.close();
    }
}

运行一次，可以收到邮件

WebHook

钉钉、企业微信、飞书，支持通过 webhook 方式发送通知到群里。下面以钉钉 webhook 为例

首先在钉钉群里，创建一个机器人

群设置->智能群助手

添加机器人->自定义 webhook 接入

直接通过 http 调用 webhook 链接即可，以 Java 代码为例，demo 如下：

public class WebhookDemo {
    public static void main(String[] args) throws Exception {
        CloseableHttpClient httpClient = HttpClientBuilder.create().build();
        HttpPost httpPost = new HttpPost("https://oapi.dingtalk.com/robot/send?access_token=fcf4c30596a8b26d76a6d4dcd658b708066e23e877b285c784db2360660c97e0");
        httpPost.setHeader("Content-Type", "application/json;charset=utf8");
        JSONObject result = new JSONObject();
        JSONObject text = new JSONObject();
        text.put("content", "测试钉钉发送定时任务通知");
        result.put("text", text);
        result.put("msgtype", "text");
        String jsonString = JSON.toJSONString(result);
        StringEntity entity = new StringEntity(jsonString, "UTF-8");
        httpPost.setEntity(entity);
        CloseableHttpResponse response = null;
        response = httpClient.execute(httpPost);
        HttpEntity responseEntity = response.getEntity();
        System.out.println("响应结果:" + EntityUtils.toString(responseEntity));
    }
}

运行一次，可以在钉钉群里看到通知消息

开源任务调度系统的通知解决方案

ElasticJob通知解决方案

ElasticJob 是一款基于 Quartz 开发，依赖 Zookeeper 作为注册中心、轻量级、无中心化的分布式任务调度框架，目前已经通过 Apache 开源，使用 ElasticJob 可以快速实现分布式任务调度。ElasticJob 只需配置定时任务的错误处理策略即可实现通知功能。目前 ElasticJob 支持邮件、钉钉、微信三种通知渠道。

接入步骤

以钉钉通知为例

引入 pom

<!-- elastic job -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
  <version>2.2.0.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <version>2.2.0.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.apache.shardingsphere.elasticjob</groupId>
  <artifactId>elasticjob-lite-spring-boot-starter</artifactId>
  <version>3.0.0-RC1</version>
</dependency>
<dependency>
  <groupId>org.apache.shardingsphere.elasticjob</groupId>
  <artifactId>elasticjob-error-handler-dingtalk</artifactId>
  <version>3.0.0-RC1</version>
</dependency>

新增 Job

@Component
public class ErrorNoticeDingtalkJob implements SimpleJob {
    @Override
    public void execute(final ShardingContext shardingContext) {
        throw new RuntimeException(String.format("An exception has occurred in Job, The parameter is %s", shardingContext.getShardingParameter()));
    }
}

对定时任务进行配置

jobs:
    errorNoticeDingtalkJob:
      elasticJobClass: com.springboottemplate.elasticjob.job.ErrorNoticeDingtalkJob
      overwrite: true
      shardingTotalCount: 3
      shardingItemParameters: 0=Beijing,1=Shanghai,2=Guangzhou
      jobErrorHandlerType: DINGTALK
      jobBootstrapBeanName: errorNoticeDingtalkBean
      props:
        dingtalk:
          webhook: you_webhook
          keyword: you_keyword
          secret: you_secret
          connectTimeout: 3000
          readTimeout: 5000

通知功能缺点

ElasticJob 没有提供控制台来配置定时任务的通知，需要在配置文件里针对每个任务单独配置，配置成本比较高。而且想要修改定时任务的通知配置，还需要修改配置重启服务才能生效，可维护性低。

XXL-JOB 通知解决方案

XXL-JOB，这是出自大众的开源项目，官网上介绍这是一个轻量级分布式任务调度框架，其核心设计目标是开发迅速、学习简单、轻量级、易扩展，与 SpringBoot 有非常好的集成，而且监控界面就集成在调度中心，界面又简洁，对于企业维护起来成本不高，默认支持失败的邮件告警。这就使很多企业选择 XXL-JOB 做调度平台。