从零开始构建 Spring Boot 邮件发送应用

2023-09-11 17:12:00

前言

Spring Boot 是一个开源的 Java 框架，可以快速构建和运行应用程序。它集成了许多流行的 Java 库，使开发人员能够快速开发出健壮、可靠的应用程序。

在本教程中，我们将使用 Spring Boot 2.x 搭建一个简单的邮件发送应用程序。我们将从零开始，逐步构建这个应用程序，并解释每个步骤背后的原理。通过本教程，你将学习如何配置 Spring Boot 应用程序，如何使用 Spring Boot 集成邮件发送功能，以及如何测试应用程序。

准备工作

在开始构建应用程序之前，你需要确保已经安装了以下软件：

Java 8 或更高版本
Maven 3.x 或更高版本
Spring Boot 2.x 或更高版本

你可以在 Oracle 的官方网站上下载 Java，在 Apache Maven 的官方网站上下载 Maven，在 Spring Boot 的官方网站上下载 Spring Boot。

创建 Spring Boot 项目

首先，我们需要创建一个 Spring Boot 项目。你可以使用 Spring Boot CLI 工具来创建项目，也可以使用 Spring Initializr 来创建项目。

使用 Spring Boot CLI 工具创建项目

打开命令行窗口，并输入以下命令：

spring init --dependencies=web,mail mail-sender

这将创建一个名为 mail-sender 的 Spring Boot 项目。

使用 Spring Initializr 创建项目

打开 Spring Initializr 的官方网站，并按照以下步骤创建项目：

选择 Spring Boot 版本。
选择 Java 版本。
选择 Project 类型。
在 Dependencies 部分，勾选 Web 和 Mail 选项。
在 Project Metadata 部分，输入项目名称（例如：mail-sender）。
点击 Generate 按钮。

这将创建一个名为 mail-sender 的 Spring Boot 项目。

配置 Spring Boot 项目

创建好 Spring Boot 项目后，我们需要对项目进行一些配置。

添加依赖

在 pom.xml 文件中，添加以下依赖：

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

这个依赖提供了 Spring Boot 对邮件发送的支持。

配置邮件服务器

在 application.properties 文件中，添加以下配置：

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your_gmail_username
spring.mail.password=your_gmail_password

这里，我们将使用 Gmail 作为邮件服务器。你也可以使用其他邮件服务器，但需要相应地修改配置。

开发邮件发送服务

接下来，我们需要开发邮件发送服务。在 src/main/java/com/example/mailsender/MailSenderService.java 文件中，添加以下代码：

package com.example.mailsender;

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 MailSenderService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendEmail(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom("your_gmail_username@gmail.com");
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        mailSender.send(message);
    }
}

这个服务提供了发送邮件的功能。

开发邮件发送控制器

接下来，我们需要开发一个邮件发送控制器。在 src/main/java/com/example/mailsender/MailSenderController.java 文件中，添加以下代码：

package com.example.mailsender;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MailSenderController {

    @Autowired
    private MailSenderService mailSenderService;

    @PostMapping("/send-email")
    public void sendEmail(@RequestBody EmailRequest emailRequest) {
        mailSenderService.sendEmail(emailRequest.getTo(), emailRequest.getSubject(), emailRequest.getText());
    }
}

这个控制器提供了发送邮件的接口。

测试应用程序

现在，我们可以测试应用程序了。

在命令行窗口中，进入项目目录。
运行以下命令启动应用程序：

mvn spring-boot:run

打开浏览器，并访问 http://localhost:8080/send-email。
在请求体中，输入以下 JSON 数据：

{
    "to": "receiver@example.com",
    "subject": "Hello from Spring Boot",
    "text": "This is a test email sent from Spring Boot."
}

点击发送按钮。

如果一切正常，你应该会收到一封来自 your_gmail_username@gmail.com 的邮件。

总结

在本教程中，我们学习了如何使用 Spring Boot 2.x 搭建一个简单的邮件发送应用程序。我们从零开始，逐步构建了这个应用程序，并解释了每个步骤背后的原理。通过本教程，你学习了如何配置 Spring Boot 应用程序，如何使用 Spring Boot 集成邮件发送功能，以及如何测试应用程序。