Spring Boot 实现发送 Excel 邮件功能

在现代的企业应用中，电子邮件和 Excel 文件已经成为了信息交换和数据传输的重要工具。通过 Spring Boot 开发应用，能够方便地实现从服务器端将生成的 Excel 文件通过电子邮件发送给用户。本文将详细讲解如何使用 Spring Boot 实现这一功能，并通过实例展示其应用场景。

引言
技术栈与环境搭建
创建 Excel 文件
- 3.1 使用 Apache POI 生成 Excel 文件
- 3.2 数据填充与格式化
配置邮件发送功能
- 4.1 配置 SMTP 服务器
- 4.2 使用 JavaMail 发送邮件
集成发送 Excel 邮件功能
- 5.1 创建服务类
- 5.2 发送邮件的方法
案例分析与应用场景
- 6.1 生成报表并发送
- 6.2 用户数据导出与邮件通知
总结

引言

在企业信息化过程中，很多业务场景都需要通过电子邮件发送 Excel 文件。比如说，定期生成财务报表、客户数据或库存数据，然后将其通过邮件发送给指定的收件人。这类功能的实现通常需要生成 Excel 文件并将其作为附件附加在邮件中发送。Spring Boot 作为一个轻量级的 Java 框架，非常适合构建这样的应用程序。

本文将介绍如何通过 Spring Boot 实现以下功能：

使用 Apache POI 库生成 Excel 文件
配置邮件服务器并发送邮件
将生成的 Excel 文件作为附件附加到邮件中
提供实际场景中的应用案例

技术栈与环境搭建

在开始实现之前，我们首先需要准备好所需的技术栈和环境。

1.1 技术栈

Spring Boot：用于构建后端服务。
JavaMail API：用于发送邮件。
Apache POI：用于生成 Excel 文件。
Maven：用于构建项目和管理依赖。

1.2 开发环境

JDK 11+
IDE：如 IntelliJ IDEA 或 Eclipse。
Maven：用于构建项目和管理依赖。
SMTP 邮件服务：如 Gmail、腾讯企业邮箱等。

1.3 项目结构

本项目采用标准的 Spring Boot 项目结构，主要包含以下模块：

src/main/java：存放 Java 代码。
src/main/resources：存放配置文件和模板。
pom.xml：Maven 项目的配置文件。

创建 Excel 文件

生成 Excel 文件是实现本功能的核心部分。我们将使用 Apache POI 库来处理 Excel 文件的读写操作。Apache POI 提供了处理 Microsoft Office 格式的 API，支持 Excel、Word、PowerPoint 等文件的创建、编辑和解析。

3.1 使用 Apache POI 生成 Excel 文件

首先，确保你的 pom.xml 文件中包含了 Apache POI 的依赖：

xmlCopy Code
<dependencies>
    <!-- Apache POI 依赖 -->
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.2.3</version>
    </dependency>
</dependencies>

接下来，我们编写一个简单的类来生成 Excel 文件：

javaCopy Code
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.ss.usermodel.*;

import java.io.FileOutputStream;
import java.io.IOException;

public class ExcelUtil {

    public static void createExcel(String filePath) throws IOException {
        // 创建一个工作簿
        XSSFWorkbook workbook = new XSSFWorkbook();

        // 创建一个工作表
        Sheet sheet = workbook.createSheet("Sheet1");

        // 创建行和单元格
        Row row = sheet.createRow(0);
        Cell cell = row.createCell(0);
        cell.setCellValue("Hello, Excel!");

        // 将 Excel 文件保存到指定路径
        try (FileOutputStream fileOut = new FileOutputStream(filePath)) {
            workbook.write(fileOut);
        }
    }
}

上述代码中，我们创建了一个简单的 Excel 文件，并写入了 "Hello, Excel!" 这段文字。你可以扩展这个功能，将数据填充到表格中，或者设置不同的格式。

3.2 数据填充与格式化

假设我们需要生成一个简单的客户信息表，包含 ID、姓名、邮箱、注册日期 等字段，并且需要对表格进行一定的格式化（如加粗标题、调整列宽等）。

javaCopy Code
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.ss.usermodel.*;

import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;

public class ExcelUtil {

    public static void createCustomerExcel(String filePath, List<Customer> customers) throws IOException {
        XSSFWorkbook workbook = new XSSFWorkbook();
        Sheet sheet = workbook.createSheet("Customers");

        // 创建标题行
        Row headerRow = sheet.createRow(0);
        String[] headers = {"ID", "姓名", "邮箱", "注册日期"};
        for (int i = 0; i < headers.length; i++) {
            Cell cell = headerRow.createCell(i);
            cell.setCellValue(headers[i]);
            // 设置加粗字体
            CellStyle style = workbook.createCellStyle();
            Font font = workbook.createFont();
            font.setBold(true);
            style.setFont(font);
            cell.setCellStyle(style);
        }

        // 填充数据
        int rowNum = 1;
        for (Customer customer : customers) {
            Row row = sheet.createRow(rowNum++);
            row.createCell(0).setCellValue(customer.getId());
            row.createCell(1).setCellValue(customer.getName());
            row.createCell(2).setCellValue(customer.getEmail());
            row.createCell(3).setCellValue(customer.getRegistrationDate().toString());
        }

        // 调整列宽
        for (int i = 0; i < headers.length; i++) {
            sheet.autoSizeColumn(i);
        }

        // 保存文件
        try (FileOutputStream fileOut = new FileOutputStream(filePath)) {
            workbook.write(fileOut);
        }
    }
}

这里的 Customer 类是我们要填充的数据对象，示例如下：

javaCopy Code
public class Customer {
    private int id;
    private String name;
    private String email;
    private Date registrationDate;

    // Getters and Setters
}

通过以上代码，我们生成了一个包含客户数据的 Excel 文件，并对表头进行了加粗处理，同时自动调整了列宽。

配置邮件发送功能

在 Spring Boot 中，配置邮件发送功能通常使用 JavaMailSender。要能够通过邮件发送文件，我们需要配置一个邮件发送服务。

4.1 配置 SMTP 服务器

首先，在 application.properties 或 application.yml 文件中配置 SMTP 邮件服务器。以 Gmail 为例：

propertiesCopy Code
spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your-email@gmail.com
spring.mail.password=your-password
spring.mail.protocol=smtp
spring.mail.smtp.auth=true
spring.mail.smtp.starttls.enable=true
spring.mail.default-encoding=UTF-8

4.2 使用 JavaMail 发送邮件

Spring Boot 提供了一个 JavaMailSender 类来简化邮件的发送过程。我们将创建一个邮件发送服务，封装发送 Excel 文件的功能：

javaCopy Code
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.mail.MailException;
import org.springframework.stereotype.Service;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.io.File;

@Service
public class EmailService {

    private final JavaMailSender mailSender;

    public EmailService(JavaMailSender mailSender) {
        this.mailSender = mailSender;
    }

    public void sendEmailWithAttachment(String to, String subject, String text, File attachment) throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);

        helper.setFrom("your-email@gmail.com");
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(text);
        helper.addAttachment(attachment.getName(), attachment);

        try {
            mailSender.send(message);
        } catch (MailException e) {
            throw new MessagingException("邮件发送失败", e);
        }
    }
}

集成发送 Excel 邮件功能

现在我们将之前的生成 Excel 文件和发送邮件功能整合到一起，完成一个完整的发送 Excel 邮件的功能模块。

5.1 创建服务类

我们创建一个新的服务类，将 Excel 文件的生成和邮件发送整合在一起：

javaCopy Code
import org.springframework.stereotype.Service;
import java.io.File;
import java.io.IOException