SpringBoot应用监控带邮件警报的实现示例

SpringBoot应用监控带邮件警报是一种常用的应用监控方案，可以在应用发生异常情况时，自动发送邮件提醒开发人员进行处理。下面我将给出一个完整的攻略，包含以下几个步骤：

1. 添加依赖

在SpringBoot项目的pom.xml文件中添加对Spring Boot Actuator和Spring Boot Mail的依赖，以实现监控和发送邮件功能。

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

1. 配置邮件服务器信息

在application.properties或application.yml文件中配置邮件服务器的相关信息，如SMTP服务器地址、端口号、账号、密码等。

# SMTP邮件发送配置
spring.mail.host=smtp.qq.com
spring.mail.port=587
spring.mail.username=发送邮件账号
spring.mail.password=发送邮件密码
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

1. 配置Actuator监控

在application.properties或application.yml文件中配置Actuator监控的相关信息，如它的端口号、路径、用户名、密码等。

# Actuator监控配置
management.server.port=8081
management.server.servlet.context-path=/monitor
management.security.enabled=true
management.security.roles=ACTUATOR_ADMIN
management.endpoint.health.show-details=always
management.endpoint.health.time-to-live=10s

1. 编写邮件发送工具类

创建一个MailUtils工具类，在其中实现邮件发送的相关操作。如下所示：

/**
 * 邮件工具类
 */
@Component
public class MailUtils {

    @Autowired
    private JavaMailSender mailSender;

    @Value("${spring.mail.username}")
    private String sender;

    /**
     * 发送简单文本邮件
     * @param recipient 收件人邮箱
     * @param subject 邮件主题
     * @param text 邮件正文
     */
    public void sendSimpleMail(String recipient, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom(sender);
        message.setTo(recipient);
        message.setSubject(subject);
        message.setText(text);
        mailSender.send(message);
    }

    /**
     * 发送HTML格式邮件
     * @param recipient 收件人邮箱
     * @param subject 邮件主题
     * @param content 邮件内容
     */
    public void sendHtmlMail(String recipient, String subject, String content) throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(sender);
        helper.setTo(recipient);
        helper.setSubject(subject);
        helper.setText(content, true);
        mailSender.send(message);
    }

}

1. 编写自定义健康检查器

创建一个HealthChecker类，继承AbstractHealthIndicator类，实现自定义的健康检查器。例如，检查数据库连接是否正常。

@Component
public class HealthChecker extends AbstractHealthIndicator {

    @Autowired
    private DataSource dataSource;

    @Override
    protected void doHealthCheck(Builder builder) throws Exception {
        try (Connection connection = dataSource.getConnection()) {
            if (connection.isValid(1000)) {
                builder.up();
            } else {
                builder.down();
            }
        } catch (SQLException e) {
            builder.down(e);
        }
    }

}

1. 编写监控异常处理类

创建一个MonitoringErrorController类，实现EmbeddedServletContainerCustomizer接口，用于监控应用中发生的异常情况，并自动发送邮件警报。

@Component
public class MonitoringErrorController implements EmbeddedServletContainerCustomizer {

    @Autowired
    private MailUtils mailUtils;

    @Override
    public void customize(ConfigurableEmbeddedServletContainer container) {
        ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
        ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");
        container.addErrorPages(error404Page, error500Page);

        container.addErrorPages(new ErrorPage(Throwable.class, "/error"));

        container.setPort(8080);

        container.addInitializers(ctx -> {
            ConfigurableApplicationContext appCtx = (ConfigurableApplicationContext) ctx;
            appCtx.addApplicationListener(event -> {
                if (event instanceof ContextRefreshedEvent) {
                    HealthEndpoint healthEndpoint = appCtx.getBean(HealthEndpoint.class);

                    ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor();
                    executor.scheduleAtFixedRate(() -> {
                        try {
                            Map<String, Object> health = healthEndpoint.health();
                            Object status = health.get("status");
                            if (status != null && !status.toString().equalsIgnoreCase("UP")) {
                                mailUtils.sendSimpleMail("[e-mail]", "警报：SpringBoot应用健康状态异常", JsonUtils.toJson(health));
                            }
                        } catch (Exception e) {
                            // 忽略异常
                        }
                    }, 1, 10, TimeUnit.SECONDS);
                }
            });
        });
    }
}

1. 编写邮件模板

创建一个邮件模板，用于组装邮件内容。根据实际需求可以选择HTML模板或纯文本模板。

HTML模板：

<!doctype html>
<html>
<head>
    <meta charset="UTF-8">
    <title>SpringBoot应用健康状态异常!</title>
</head>
<body>
    <h3>SpringBoot应用健康状态异常</h3>
    <p>健康状态信息：</p>
    <p>{{message}}</p>
</body>
</html>

1. 发送测试邮件

在Controller中编写一个测试方法，用于测试邮件是否可以正常发送。

@RestController
public class TestController {

    @Autowired
    private MailUtils mailUtils;

    @GetMapping("/sendMail")
    public void sendMail() {
        mailUtils.sendSimpleMail("[e-mail]", "Test Mail", "This is a test mail.");
    }

}

以上便是一个完整的SpringBoot应用监控带邮件警报的实现示例，通过以上步骤可以将应用监控和邮件发送两个功能结合起来，实现应用的自动监控和异常提醒。