一键搞定：SpringBoot实现Excel生成并通过邮件发送

2023-02-24 21:41:25

Excel 生成与邮件发送的无缝结合：用 SpringBoot 轻松搞定

在实际软件开发中，我们常常需要生成 Excel 报表或统计数据，并将其通过邮件发送给特定人员。使用 SpringBoot，我们可以轻松实现这一系列操作。本篇博客将详细介绍如何使用 SpringBoot 生成 Excel 并发送邮件，希望能对广大开发者有所帮助。

第一步：搭建开发环境

安装 SpringBoot： 在命令行中执行 "mvn spring-boot:run" 命令即可启动 SpringBoot 应用。
引入 Apache POI： Apache POI 是用于操作 Microsoft Office 格式文件的 Java 库。在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.17</version>
</dependency>

第二步：生成 Excel

创建 Excel 工作簿： 使用 WorkbookFactory.create() 方法创建新的工作簿。
创建工作表： 使用 Workbook.createSheet() 方法创建工作表。
填充数据： 使用 CellRangeAddress 和 setCellValue() 方法填充数据到单元格。
设置样式： 使用 CellStyle 和 Font 对象设置单元格的样式。

第三步：发送邮件

引入 JavaMail： JavaMail 是用于发送电子邮件的 Java 库。在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>javax.mail</groupId>
    <artifactId>mail</artifactId>
    <version>1.5.0-b01</version>
</dependency>

配置邮件服务器： 设置邮件服务器的地址、端口、用户名和密码等信息。
创建邮件对象： 使用 MimeMessage 对象创建邮件。
设置邮件内容： 设置邮件的主题、内容和附件等信息。
发送邮件： 使用 Transport.send() 方法发送邮件。

完整代码示例

以下是使用 SpringBoot 生成 Excel 并发送邮件的完整代码示例：

import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.mail.*;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.io.ByteArrayOutputStream;
import java.util.Properties;

@SpringBootApplication
@RestController
public class ExcelAndEmailApplication {

    public static void main(String[] args) {
        SpringApplication.run(ExcelAndEmailApplication.class, args);
    }

    @GetMapping("/generateExcel")
    public String generateExcel() {
        // 创建工作簿
        Workbook workbook = new XSSFWorkbook();

        // 创建工作表
        Sheet sheet = workbook.createSheet("数据");

        // 填充数据
        Row row = sheet.createRow(0);
        Cell cell = row.createCell(0);
        cell.setCellValue("姓名");

        cell = row.createCell(1);
        cell.setCellValue("年龄");

        // 设置样式
        CellStyle style = workbook.createCellStyle();
        Font font = workbook.createFont();
        font.setBold(true);
        style.setFont(font);

        // 将数据写入 Excel
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        workbook.write(out);

        // 发送邮件
        try {
            // 设置邮件服务器
            Properties props = new Properties();
            props.put("mail.smtp.host", "smtp.example.com");
            props.put("mail.smtp.port", "25");
            props.put("mail.smtp.auth", "true");

            // 创建邮件对象
            MimeMessage message = new MimeMessage(Session.getDefaultInstance(props, null));
            message.setFrom(new InternetAddress("from@example.com"));
            message.addRecipient(Message.RecipientType.TO, new InternetAddress("to@example.com"));
            message.setSubject("Excel 数据");
            message.setContent("请查收附件中的 Excel 数据。", "text/plain");

            // 添加附件
            message.addAttachmentPart(new MimeBodyPart(out, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"));

            // 发送邮件
            Transport.send(message);

            return "邮件已发送。";
        } catch (MessagingException e) {
            e.printStackTrace();
            return "邮件发送失败。";
        }
    }
}

常见问题解答

如何设置邮件服务器的配置信息？

您可以通过 application.properties 文件或 Java 代码设置邮件服务器的配置信息。
如何添加多个附件到邮件中？

您可以使用 MimeMultipart 对象来添加多个附件到邮件中。
如何使用 HTML 格式发送邮件？

您可以使用 setContent() 方法并指定 "text/html" 作为内容类型来使用 HTML 格式发送邮件。
如何发送带密码保护的邮件？

您可以使用 Session.getDefaultInstance(props, new Authenticator() {...}) 方法来设置邮件密码。
如何使用 SpringBoot 异步发送邮件？

您可以使用 @Async 注解或 Spring 的 AsyncRestTemplate 来异步发送邮件。