Erstellen synchroner E-Mail-Benachrichtigungssysteme in Spring Boot: Eine Schritt-für-Schritt-Anleitung

Erkundung der Grundlagen der synchronen E-Mail-Zustellung in Spring Boot-Anwendungen

In der heutigen schnelllebigen digitalen Welt ist eine zeitnahe Kommunikation für jede Anwendung von entscheidender Bedeutung. Ob es sich um eine Passwortzurücksetzung, eine Willkommensnachricht oder eine Bestellbestätigung handelt, E-Mail-Benachrichtigungen spielen eine entscheidende Rolle bei der Verbesserung des Benutzererlebnisses. Als Entwickler befinden wir uns oft in Situationen, in denen das Senden einer E-Mail-Benachrichtigung aus unserer Spring Boot-Anwendung nicht nur eine Anforderung, sondern eine Notwendigkeit ist.

In dieser Blogreihe führe ich Sie durch den Prozess der Implementierung von E-Mail-Benachrichtigungen in einer Spring Boot-Anwendung. Wir beginnen mit den Grundlagen – der Verwendung eines synchronen Ansatzes zum Senden von E-Mails. Diese Methode stellt sicher, dass die E-Mail sofort während der Ausführung der Anfrage gesendet wird und dem Benutzer sofortiges Feedback gibt.

Während ein synchroner Ansatz einfach zu implementieren ist und für kleinere Anwendungen effektiv sein kann, ist es wichtig, seine Grenzen zu verstehen, insbesondere in Umgebungen mit hohem Datenverkehr, in denen die Leistung beeinträchtigt werden kann.

In diesem Teil konzentrieren wir uns auf die Einrichtung des Projekts, die Konfiguration der erforderlichen Abhängigkeiten und das Schreiben des Codes zum Senden einer einfachen E-Mail-Benachrichtigung. Am Ende dieses Beitrags verfügen Sie über eine funktionierende Spring Boot-Anwendung, die in der Lage ist, E-Mails synchron zu versenden und so die Bühne für fortgeschrittenere Themen in den kommenden Teilen dieser Serie zu bereiten.

Projekt-Setup

Abhängigkeiten einrichten

Abhängigkeit in Ihrer pom.xml-Datei

Spring Boot Starter Data JPA

Artefakt: spring-boot-starter-data-jpa
Beschreibung: Diese Abhängigkeit vereinfacht die Datenpersistenz mithilfe von JPA (Java Persistence API). Es bietet alles, was für die Interaktion mit Datenbanken erforderlich ist, einschließlich Entitäten, Repositorys und Transaktionen. In diesem Projekt können Sie Benutzerdaten (z. B. E-Mail-Protokolle, Benutzerinformationen) einfach in einer MySQL-Datenbank speichern und abrufen.

Spring Boot Starter Mail

Artefakt: spring-boot-starter-mail
Beschreibung: Dieser Starter ermöglicht das Senden von E-Mails aus Ihrer Spring Boot-Anwendung. Es enthält die notwendigen Komponenten wie JavaMailSender, um Echtzeit-E-Mail-Benachrichtigungen für Benutzeraktivitäten wie Registrierung und Bestellbestätigungen zu konfigurieren und zu versenden.

*Spring Boot Starter Web
*
Artefakt: spring-boot-starter-web
Beschreibung: Diese Abhängigkeit hilft Ihnen beim Aufbau von RESTful-Webdiensten und der Bereitstellung von Webinhalten. Es bringt die wesentlichen Bibliotheken wie Spring MVC zum Erstellen von APIs mit. In diesem Projekt ermöglicht es die Erstellung von Endpunkten, um E-Mail-Benachrichtigungen über HTTP-Anfragen auszulösen.

MySQL-Connector

Artefakt: mysql-connector-j
Beschreibung: Dies ist der JDBC-Treiber, der zum Verbinden Ihrer Spring Boot-Anwendung mit einer MySQL-Datenbank erforderlich ist. Dadurch kann die Anwendung mit der Datenbank interagieren und Aktionen wie das Lesen und Schreiben von Daten ausführen, beispielsweise das Speichern von E-Mail-Protokollen oder Benutzerinformationen.

Lombok

Artefakt: Lombok
Beschreibung: Lombok ist eine praktische Bibliothek, die Boilerplate-Code reduziert, indem sie gängige Methoden wie Getter, Setter und Konstruktoren automatisch generiert. Es ist in diesem Projekt als optional markiert und seine Verwendung kann den Code für Datenmodelle wie User oder EmailLog vereinfachen.

Spring Boot Starter Test

Artefakt: Spring-Boot-Starter-Test
Beschreibung: Diese Abhängigkeit bietet ein umfassendes Test-Framework für Spring Boot-Anwendungen. Es umfasst Bibliotheken wie JUnit, Mockito und Spring Test für Unit- und Integrationstests. Mithilfe automatisierter Tests wird sichergestellt, dass Ihr E-Mail-Benachrichtigungssystem wie erwartet funktioniert.

Spring Boot Maven Plugin

Artefakt: spring-boot-maven-plugin
Beschreibung: Mit diesem Plugin können Sie Ihre Spring Boot-Anwendung über einen Maven-Befehl erstellen und ausführen. Es vereinfacht das Packen Ihres Projekts in eine ausführbare JAR-Datei und erleichtert so die Bereitstellung. Es schließt die Lombok-Abhängigkeit bei Bedarf vom Build-Prozess aus.

Anwendungseigenschaften konfigurieren

Um Ihre Spring Boot-Anwendung mit einem E-Mail-Server zu verbinden, können Sie die Datei application.properties oder application.yml mit den erforderlichen SMTP-Einstellungen konfigurieren. Unten finden Sie ein Beispiel für jedes Konfigurationsformat.

Für application.properties

spring.application.name=Synchronous-Email-Notifier
server.port=8080

spring.datasource.url=jdbc:mysql://localhost:3306/synchronous_email_notifier
spring.datasource.username=root
spring.datasource.password=ayush@123

spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=shri@gmail.com
spring.mail.password=
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

对于 application.yml

spring:
  mail:
    host: smtp.example.com
    port: 587
    username: your-email@example.com
    password: your-email-password
    properties:
      mail:
        smtp:
          auth: true
          starttls:
            enable: true

主机：这是 SMTP 服务器地址。将 smtp.example.com 替换为您的实际 SMTP 提供商的地址（例如，对于 Gmail，smtp.gmail.com 或对于 Yahoo，smtp.mail.yahoo.com）。

端口：端口 587 通常用于通过 TLS（传输层安全性）发送电子邮件。如果您的电子邮件提供商支持 SSL，您可以使用端口 465。

用户名：您发送电子邮件的电子邮件地址。请务必将其替换为实际的电子邮件帐户。

密码：您的电子邮件帐户的密码。出于安全原因，如果您使用 Gmail 等服务，建议使用应用程序密码而不是实际帐户密码。另外，请考虑使用环境变量来存储密码等敏感信息。

SMTP 身份验证：这可以对您的 SMTP 服务器进行身份验证，当您的电子邮件提供商需要有效的用户名和密码时，这是必需的。

STARTTLS：这可确保与电子邮件服务器的连接使用 TLS 加密。这对于安全通信至关重要。

项目设置

User.java 用于将用户邮件和其他信息存储到数据库中，我们将电子邮件发送给数据库中存在的所有用户。

@Entity
@AllArgsConstructor
@NoArgsConstructor
@Data
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private int id;
    private String name;
    private String email;
    private String phoneNumber;
}

UserService.java

public interface UserService {
    public void saveUser(User user);
}

UserServiceImpl.java

public class UserServiceImpl implements UserService {

    @Autowired
    private UserRepository userRepository;

    @Override
    public void saveUser(User user) {
        userRepository.save(user);
    }
}

EmailController.java

@RestController
@RequestMapping("/api/email")
public class EmailController {

    @Autowired
    EmailService emailService;

    @Autowired
    UserService userService;

    @PostMapping("/saveUser")
    public String saveUser(@RequestBody User user) {
        userService.saveUser(user);
        return "User saved successfully";
    }
}

EmailService 接口定义了在 Java 应用程序中发送电子邮件的契约。它包含一个方法sendEmail，该方法接受三个参数：收件人的电子邮件地址（to）、电子邮件主题（subject）和电子邮件内容（body）。实现此接口可以轻松集成电子邮件通知。

package com.ayshriv.Synchronous_Email_Notifier.service;

public interface EmailService {
    void sendEmail(String to, String subject,String body);
}

这个EmailServiceImpl类实现了EmailService接口并提供了使用Spring的JavaMailSender发送电子邮件的功能。它使用 SimpleMailMessage 设置收件人 (to)、主题 (subject) 和正文 (text)。 javaMailSender 是使用 Spring 的 @Autowired 注释自动注入的。如果在电子邮件发送过程中出现任何异常，它们会被捕获并记录到控制台。

package com.ayshriv.Synchronous_Email_Notifier.service.impl;

import com.ayshriv.Synchronous_Email_Notifier.service.EmailService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Service;

@Service
public class EmailServiceImpl implements EmailService {
    @Autowired
    private JavaMailSender javaMailSender;

    public void sendEmail(String to, String subject,String body)
    {
        try {
            SimpleMailMessage simpleMailMessage=new SimpleMailMessage();
            simpleMailMessage.setTo(to);
            simpleMailMessage.setSubject(subject);
            simpleMailMessage.setText(body);
            javaMailSender.send(simpleMailMessage);
        }
        catch (Exception exception)
        {
            System.out.println(exception.getMessage());
        }
    }
}

这个EmailScheduler类是一个Spring服务，它使用计划任务定期向数据库中的所有用户发送电子邮件。该类的工作原理如下：

它使用 @Scheduled 和 cron 表达式（“0 0/1 * 1/1 * ?”）每分钟运行 fetchUsersAndSendEmail 方法。
该方法从 UserRepository 中检索所有用户的列表，并使用 EmailService 向每个用户发送一封电子邮件。
每封发送的电子邮件都有主题“电子邮件演示文本”和正文“演示”。

package com.ayshriv.Synchronous_Email_Notifier.schduler;

import com.ayshriv.Synchronous_Email_Notifier.entity.User;
import com.ayshriv.Synchronous_Email_Notifier.repository.UserRepository;
import com.ayshriv.Synchronous_Email_Notifier.service.EmailService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class EmailScheduler {
    @Autowired
    private UserRepository userRepository;

    @Autowired
    private EmailService emailService;

    @Scheduled(cron = "0 0/1 * 1/1 * ?")
    public void fetchUsersAndSendEmail()
    {
        List<User> users = userRepository.findAll();
        for (User user:users)
        {
            emailService.sendEmail(user.getEmail(),"Demo text for email","Demo");
        }
    }
}

同步电子邮件通知程序项目中的 EmailScheduler 类可自动按特定时间间隔向用户发送营销电子邮件。使用Spring的@Scheduled注释，它每分钟运行一个任务，从UserRepository中检索所有用户并通过EmailService发送电子邮件。此设置非常适合企业自动发送营销电子邮件、新闻通讯或重要通知，无需人工干预。可以使用 cron 表达式调整计划，从而可以灵活地每天、每周或以任何自定义频率发送电子邮件，使其成为基于时间的电子邮件活动的强大工具。

保存用户

结论

同步电子邮件通知程序项目中的 EmailScheduler 类演示了一种实用且有效的方法来自动执行向用户发送电子邮件的过程。通过利用 Spring Boot 的 @Scheduled 注释和 cron 表达式的灵活性，此类安排电子邮件发送任务每分钟运行一次。 UserRepository 获取所有用户记录，而 EmailService 确保每个用户收到一封包含预定义内容的电子邮件。

这种方法对于营销目的非常有用，企业需要定期发送电子邮件，例如时事通讯、促销优惠或以特定时间间隔发送通知。该设置可确保电子邮件一致地发送给所有用户，无需手动操作。这种自动化减少了沟通过程中涉及的时间和精力，同时使营销人员能够专注于制定有效的营销活动。

自定义这些电子邮件的频率的能力，例如每天、每周或每月发送，使其成为营销活动的多功能工具。此外，您可以动态修改内容，以针对不同用户或场合定制消息传递。总体而言，该解决方案简化了预定营销电子邮件的流程，使其具有可扩展性并能够适应各种业务需求。

您可以在 GitHub 上访问同步电子邮件通知程序项目的完整源代码。 https://github.com/ishrivasayush/email-scheduling-application.git

该项目演示了如何使用 Spring Boot 通过调度程序自动发送营销电子邮件。请随意探索并贡献！

Das obige ist der detaillierte Inhalt vonErstellen synchroner E-Mail-Benachrichtigungssysteme in Spring Boot: Eine Schritt-für-Schritt-Anleitung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!