Apache ShardingSphere ElasticJob 错误处理策略详解

Apache ShardingSphere ElasticJob 错误处理策略详解

shardingsphere-elasticjob Distributed scheduled job 项目地址: https://gitcode.com/gh_mirrors/sha/shardingsphere-elasticjob

什么是错误处理策略

在分布式任务调度系统中，任务执行过程中难免会遇到各种异常情况。Apache ShardingSphere ElasticJob 提供了灵活的错误处理机制，允许开发者根据业务需求选择不同的错误处理方式。错误处理策略决定了当作业执行过程中发生异常时，系统应该采取什么样的应对措施。

内置基础错误处理策略

ElasticJob 提供了三种基础的内置错误处理策略，开箱即用：

1. 记录日志策略 (LOG)

类型标识：LOG
默认启用：是
行为特点：

• 将异常信息记录到日志系统中
• 不会中断当前作业的执行
• 适合对非关键性错误的处理

适用场景：当作业中的异常不会影响整体业务流程，但需要记录以备后续分析时使用。

2. 抛出异常策略 (THROW)

类型标识：THROW
默认启用：是
行为特点：

• 将异常抛出给上层调用者
• 立即中断当前作业的执行
• 适合对关键性错误的处理

适用场景：当作业中的异常可能导致后续处理出现严重问题时使用，需要立即停止执行。

3. 忽略异常策略 (IGNORE)

类型标识：IGNORE
默认启用：是
行为特点：

• 完全忽略发生的异常
• 不记录日志，不中断执行
• 适合对完全可忽略的异常处理

适用场景：当明确知道某些异常可以安全忽略，且不需要任何记录时使用。

扩展通知类错误处理策略

除了基础策略外，ElasticJob 还提供了多种通知类的错误处理策略，需要额外引入依赖。

1. 邮件通知策略 (EMAIL)

类型标识：EMAIL
默认启用：否
行为特点：

• 通过电子邮件发送错误通知
• 不中断作业执行
• 需要配置邮件服务器信息

Maven 依赖：

<dependency>
    <groupId>org.apache.shardingsphere.elasticjob</groupId>
    <artifactId>elasticjob-error-handler-email</artifactId>
    <version>${latest.release.version}</version>
</dependency>

配置参数详解：

| 参数 | 说明 | 必要性 | 默认值 | |------|------|--------|--------| | email.host | SMTP服务器地址 | 必填 | 无 | | email.port | SMTP服务器端口 | 必填 | 无 | | email.username | 认证用户名 | 必填 | 无 | | email.password | 认证密码 | 必填 | 无 | | email.useSsl | 启用SSL加密 | 可选 | true | | email.subject | 邮件主题 | 可选 | "ElasticJob error message" | | email.from | 发件人地址 | 必填 | 无 | | email.to | 收件人地址 | 必填 | 无 | | email.cc | 抄送地址 | 可选 | null | | email.bcc | 密送地址 | 可选 | null | | email.debug | 调试模式 | 可选 | false |

最佳实践：建议在生产环境中配置SSL加密，并设置合理的邮件主题以便快速识别错误来源。

2. 企业微信通知策略 (WECHAT)

类型标识：WECHAT
默认启用：否
行为特点：

• 通过企业微信机器人发送通知
• 不中断作业执行
• 需要配置Webhook地址

Maven 依赖：

<dependency>
    <groupId>org.apache.shardingsphere.elasticjob</groupId>
    <artifactId>elasticjob-error-handler-wechat</artifactId>
    <version>${latest.release.version}</version>
</dependency>

配置参数详解：

| 参数 | 说明 | 必要性 | 默认值 | |------|------|--------|--------| | wechat.webhook | 机器人Webhook地址 | 必填 | 无 | | wechat.connectTimeoutMilliseconds | 连接超时时间 | 可选 | 3000ms | | wechat.readTimeoutMilliseconds | 读取超时时间 | 可选 | 5000ms |

注意事项：企业微信机器人需要在企业微信管理后台预先创建并获取Webhook地址。

3. 钉钉通知策略 (DINGTALK)

类型标识：DINGTALK
默认启用：否
行为特点：

• 通过钉钉机器人发送通知
• 支持安全设置（关键字/签名）
• 不中断作业执行

Maven 依赖：

<dependency>
    <groupId>org.apache.shardingsphere.elasticjob</groupId>
    <artifactId>elasticjob-error-handler-dingtalk</artifactId>
    <version>${latest.release.version}</version>
</dependency>

配置参数详解：

| 参数 | 说明 | 必要性 | 默认值 | |------|------|--------|--------| | dingtalk.webhook | 机器人Webhook地址 | 必填 | 无 | | dingtalk.keyword | 自定义关键词 | 可选 | null | | dingtalk.secret | 签名密钥 | 可选 | null | | dingtalk.connectTimeoutMilliseconds | 连接超时时间 | 可选 | 3000ms | | dingtalk.readTimeoutMilliseconds | 读取超时时间 | 可选 | 5000ms |

安全建议：如果钉钉机器人设置了安全策略（如关键词或签名），必须在此处配置对应参数，否则消息发送会失败。

策略选择建议

1. 关键业务作业：建议使用THROW策略+通知策略组合，既中断错误执行又通知负责人
2. 普通业务作业：可使用LOG策略+通知策略，记录错误并通知，但不中断执行
3. 可自愈作业：对可自动恢复的临时错误，可使用IGNORE策略
4. 通知渠道选择：根据团队协作习惯选择邮件、企业微信或钉钉，也可以组合使用

配置示例

以下是一个组合配置的YAML示例：

elasticjob:
  jobs:
    myJob:
      errorHandlerType: "THROW,EMAIL,WECHAT"
      props:
        email.host: "smtp.example.com"
        email.port: "465"
        email.username: "alert@example.com"
        email.password: "password"
        email.from: "alert@example.com"
        email.to: "dev-team@example.com"
        wechat.webhook: "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx"

这种配置会在发生错误时抛出异常中断执行，同时通过邮件和企业微信发送通知。

通过合理配置错误处理策略，可以大大提高分布式任务调度系统的可靠性和可维护性。

shardingsphere-elasticjob Distributed scheduled job 项目地址: https://gitcode.com/gh_mirrors/sha/shardingsphere-elasticjob