Spring整合发送邮件功能

Posted 2022-07-04 AlaGeek

1、写在前面

需求是要在一个Spring项目上实现发送邮件的功能，上网搜了下，结果绝大多数都是SpringBoot的博客，少有的几个SpringMVC的博客还跑不通，开发完需求后回家又实现了遍，记录下。

本文案例选用QQ邮箱来发送邮件，需要提前在QQ邮箱开启POP3/SMTP服务，不会的请移步这篇百度经验文章（QQ邮箱如何开启POP3/SMTP服务）

案例的开发环境如下：

• IDEA 2020.3.4
• Maven 3.6.3
• Tomcat 8.5.57

2、整合步骤

2.1 新建项目

首先新建个SpringMVC项目，不会的移步我的这篇博客（手动搭建SpringMVC项目）

2.2 添加依赖

添加发送邮件相关依赖：

<!-- mail -->
<dependency>
    <groupId>com.sun.mail</groupId>
    <artifactId>javax.mail</artifactId>
    <version>1.6.2</version>
</dependency>

<!-- JavaMailSenderImpl在这个依赖里 -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context-support</artifactId>
    <version>5.3.1</version>
</dependency>

2.3 添加配置文件

在resources下新建spring-mail.xml文件，内容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!--suppress ALL -->
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="com.alageek.study.util"/>

    <bean id="javaMailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
        <property name="host" value="smtp.qq.com"/>
        <property name="port" value="587"/>
        <property name="username" value="**********@qq.com"/>
        <property name="password" value="*****************"/>
        <property name="protocol" value="smtp"/>
        <property name="defaultEncoding" value="UTF-8"/>
        <property name="javaMailProperties">
            <props>
                <prop key="mail.smtp.auth">true</prop>
            </props>
        </property>
    </bean>

</beans>

配置文件里打星号的username和password自行替换为自己的邮箱和授权码
新建完后，在web.xml中找到这行代码：

<param-value>classpath:spring-mvc.xml</param-value>

将其修改为：

<param-value>classpath:spring-mvc.xml,classpath:spring-mail.xml</param-value>

这样邮件的配置就能生效了

2.4 添加工具类

配置文件中配了扫描包com.alageek.study.util，在这个util包下新建一个EmailUtil工具类，代码如下：

package com.alageek.study.util;

import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;

/**
 * 邮件工具类
 */
@Component
public class EmailUtil 

    @Resource
    private JavaMailSender javaMailSender;

    /**
     * 发送邮件
     * @param mailTo 收件人
     * @param title 标题
     * @param content 内容
     */
    public void sendMail(String mailTo, String title, String content) 
        // 邮件消息对象
        SimpleMailMessage msg = new SimpleMailMessage();
        // 收件人
        msg.setTo(mailTo);
        // 发件人
        msg.setFrom("**********@qq.com");
        // 邮件标题
        msg.setSubject(title);
        // 邮件内容
        msg.setText(content);
        javaMailSender.send(msg);
        System.out.println("发送邮件成功");
    

此处代码中的发件人邮箱自行替换为配置文件中的username对应的邮箱

2.5 测试工具类

新建一个EmailController，将邮件工具类注入，调用sendMail方法，代码如下：

package com.alageek.study.controller;

import com.alageek.study.util.EmailUtil;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
public class EmailController 

    @Resource
    private EmailUtil emailUtil;

    @RequestMapping("/sendMail")
    public String sendMail() 
        try 
            emailUtil.sendMail("**********@qq.com", "***先生，您的CSDN站会员已过期", "***先生，您的CSDN站会员已过期，请续费");
            return "success";
         catch (Exception e) 
            e.printStackTrace();
            return "fail";
        
    

此处代码中的收件人邮箱自行替换，Tomcat中启动服务后，调用接口即可收到邮件。

3、写在后面

写案例的时候踩了个坑，因为写实际需求的时候，我引入的依赖是：

<dependency>
    <groupId>javax.mail</groupId>
    <artifactId>mailapi</artifactId>
    <version>1.4.3</version>
</dependency>

然后运行的时候抛了异常（javax.mail.NoSuchProviderException: smtp），网上博客都说是jar包问题，于是怀疑是我的项目spring版本太高了，而mailapi的版本太低了，在Maven仓库中查询，可以看到有两个mailapi，如下图：

在引用了图中第一个依赖后，依赖如下：

<dependency>
    <groupId>com.sun.mail</groupId>
    <artifactId>mailapi</artifactId>
    <version>2.0.1</version>
</dependency>

结果报了个编译错误：“java: 无法访问javax.mail.internet.MimeMessage”，猜测是两个版本的mailapi可能不兼容，在看了javaMail的主页后，将依赖改为1.6.2版本，测试就通过了。

---

吐槽：查个问题，百度出来大多是一模一样的博客，抄来抄去的实在是太糟心了！！！