Spring Boot での同期電子メール通知システムの構築: ステップバイステップガイド

Spring Boot アプリケーションでの同期電子メール配信の基礎を探る

今日のペースの速いデジタル世界では、あらゆるアプリケーションにとってタイムリーなコミュニケーションが重要です。パスワードのリセット、ウェルカム メッセージ、注文確認のいずれであっても、電子メール通知はユーザー エクスペリエンスを向上させる上で重要な役割を果たします。開発者として、Spring Boot アプリケーションから電子メール通知を送信することが単なる要件ではなく必須であるという状況によく遭遇します。

このブログ シリーズでは、Spring Boot アプリケーションに電子メール通知を実装するプロセスについて説明します。同期アプローチを使用して電子メールを送信するという基本から始めます。このメソッドにより、リクエストの実行中に電子メールが即座に送信され、ユーザーに即座にフィードバックが提供されます。

同期アプローチは実装が簡単で、小規模なアプリケーションには効果的ですが、特にパフォーマンスに影響が出る可能性のある高トラフィック環境では、その制限を理解することが重要です。

このパートでは、プロジェクトのセットアップ、必要な依存関係の構成、基本的な電子メール通知を送信するコードの作成に焦点を当てます。この投稿を終えるまでに、メールを同期的に送信できる Spring Boot アプリケーションが完成し、このシリーズの今後の部分でより高度なトピックに向けた準備が整います。

プロジェクトのセットアップ

依存関係のセットアップ

pom.xml ファイル内の依存関係

Spring Boot スターター データ JPA

アーティファクト: spring-boot-starter-data-jpa
説明: この依存関係は、JPA (Java Persistence API) を使用したデータの永続性を簡素化します。エンティティ、リポジトリ、トランザクションなど、データベースとの対話に必要なすべてが提供されます。このプロジェクトでは、ユーザー データ (電子メール ログ、ユーザー情報など) を MySQL データベースに簡単に保存したり、MySQL データベースから取得したりできるようにします。

Spring Boot スターターメール

アーティファクト: spring-boot-starter-mail
説明: このスターターにより、Spring Boot アプリケーションから電子メールを送信できるようになります。これには、登録や注文確認などのユーザー アクティビティに関するリアルタイムの電子メール通知を構成および送信するために必要な JavaMailSender などのコンポーネントが含まれています。

*Spring Boot スターター Web
*
アーティファクト: spring-boot-starter-web
説明: この依存関係は、RESTful Web サービスを構築し、Web コンテンツを提供するのに役立ちます。 API を作成するための Spring MVC などの必須ライブラリが組み込まれます。このプロジェクトでは、HTTP リクエスト経由で電子メール通知をトリガーするエンドポイントの作成が可能です。

MySQL コネクタ

アーティファクト: mysql-connector-j
説明: これは、Spring Boot アプリケーションを MySQL データベースに接続するために必要な JDBC ドライバーです。これにより、アプリケーションはデータベースと対話し、電子メール ログやユーザー情報の保存など、データの読み取りと書き込みなどのアクションを実行できるようになります。

ロンボク島

アーティファクト: ロンボク
説明: Lombok は、ゲッター、セッター、コンストラクターなどの一般的なメソッドを自動生成することで定型コードを削減する便利なライブラリです。このプロジェクトではオプションとしてマークされており、これを使用すると、User や EmailLog などのデータ モデルのコードを簡素化できます。

Spring Boot スターター テスト

アーティファクト: spring-boot-starter-test
説明: この依存関係は、Spring Boot アプリケーションの包括的なテスト フレームワークを提供します。これには、単体テストおよび統合テスト用の JUnit、Mockito、Spring Test などのライブラリが含まれています。これは、電子メール通知システムが自動テストで期待どおりに動作していることを確認するのに役立ちます。

Spring Boot Maven プラグイン

アーティファクト: spring-boot-maven-plugin
説明: このプラグインを使用すると、Maven コマンドから Spring Boot アプリケーションを構築して実行できます。これにより、プロジェクトを実行可能な JAR ファイルにパッケージ化することが簡素化され、デプロイメントが容易になります。必要に応じて、ビルド プロセスから Lombok 依存関係を除外します。

アプリケーションのプロパティの構成

Spring Boot アプリケーションを電子メール サーバーに接続するには、必要な SMTP 設定を使用して application.properties または application.yml ファイルを構成できます。以下は各設定形式の例です。

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 애플리케이션에서 이메일을 보내기 위한 계약을 정의합니다. 여기에는 수신자의 이메일 주소(to), 이메일 제목(subject), 이메일 내용(body) 등 세 가지 매개변수를 취하는 sendEmail 메소드가 포함되어 있습니다. 이 인터페이스를 구현하면 이메일 알림을 쉽게 통합할 수 있습니다.

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 서비스입니다. 수업은 다음과 같이 진행됩니다:

Cron 표현식("0 0/1 * 1/1 * ?")과 함께 @Scheduled를 사용하여 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");
        }
    }
}

Synchronous Email Notifier 프로젝트의 EmailScheduler 클래스는 특정 간격으로 사용자에게 마케팅 이메일을 자동으로 보냅니다. Spring의 @Scheduled 주석을 사용하여 매분 작업을 실행하여 UserRepository에서 모든 사용자를 검색하고 EmailService를 통해 이메일을 보냅니다. 이 설정은 기업이 수동 개입 없이 마케팅 이메일, 뉴스레터 또는 중요한 알림 전달을 자동화하는 데 이상적입니다. cron 표현식을 사용하여 일정을 조정할 수 있으므로 매일, 매주 또는 사용자 정의 빈도로 이메일을 유연하게 보낼 수 있으므로 시간 기반 이메일 캠페인을 위한 강력한 도구가 됩니다.

사용자 저장

결론

Synchronous Email Notifier 프로젝트의 EmailScheduler 클래스는 사용자에게 이메일을 보내는 프로세스를 자동화하는 실용적이고 효율적인 방법을 보여줍니다. Spring Boot의 @Scheduled 주석과 cron 표현식의 유연성을 활용하여 이 클래스는 매분 실행되도록 이메일 전송 작업을 예약합니다. UserRepository는 모든 사용자 기록을 가져오는 반면 EmailService는 각 사용자가 사전 정의된 콘텐츠가 포함된 이메일을 받도록 보장합니다.

이 접근 방식은 기업이 특정 시간 간격으로 뉴스레터, 판촉 행사 또는 알림과 같은 정기적인 이메일을 보내야 하는 마케팅 목적에 매우 유용합니다. 설정을 통해 수동 작업 없이 이메일이 모든 사용자에게 일관되게 전송됩니다. 이러한 자동화를 통해 커뮤니케이션 프로세스에 소요되는 시간과 노력을 줄이는 동시에 마케팅 담당자는 효과적인 캠페인을 만드는 데 집중할 수 있습니다.

매일, 매주, 매월 보내는 등 이메일 전송 빈도를 맞춤설정할 수 있는 기능이 있어 마케팅 캠페인을 위한 다용도 도구가 됩니다. 또한 콘텐츠를 동적으로 수정하여 다양한 사용자나 상황에 맞게 메시지를 맞춤화할 수 있습니다. 전반적으로 이 솔루션은 예약된 마케팅 이메일 프로세스를 단순화하고 능률화하여 다양한 비즈니스 요구에 맞게 확장 및 적응할 수 있게 해줍니다.

GitHub에서 동기식 이메일 알리미 프로젝트의 전체 소스 코드에 액세스할 수 있습니다. https://github.com/ishrivasayush/email-scheduling-application.git

이 프로젝트에서는 Spring Boot를 사용하여 스케줄러로 마케팅 이메일을 자동화하는 방법을 보여줍니다. 자유롭게 탐색하고 기여해 보세요!

以上がSpring Boot での同期電子メール通知システムの構築: ステップバイステップガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。