1. 簡介
在本教程中，我們將探討在通過 Spring Boot 實現電子郵件功能時可能遇到的常見錯誤。
我們將重點理解“Could not autowire org.springframework.mail.javamail.JavaMailSender”問題的原因，以及如何解決它。
2. 瞭解錯誤信息
讓我們先解釋一下這個錯誤意味着什麼。<em>JavaMailSender</em> 是 Spring 提供的一個接口，用於抽象電子郵件發送過程。它擴展了 <em>MailSender</em>，另一個提供用於發送簡單文本電子郵件的基本功能的接口。具體來説，<em>JavaMailSender</em> 支持更高級的電子郵件功能，例如 MIME 消息、附件和 HTML 內容。
Spring 的依賴注入機制會自動將 bean 注入到需要的地方。當它遇到 <em>@Autowired</em> 註解，或者更理想的情況是構造函數注入時，它會在應用程序上下文中搜索匹配的 bean。
@Service
public class EmailService {
private final JavaMailSender javaMailSender;
public EmailService(final JavaMailSender javaMailSender) {
this.javaMailSender = javaMailSender;
}
}
當我們在 Spring 無法找到時注入 JavaMailSender Bean，並嘗試運行應用程序，它會拋出錯誤：
Field javaMailSender in com.baeldung.email.EmailService required a bean of type 'org.springframework.mail.javamail.JavaMailSender' that could not be found.或者：
Parameter 0 of constructor in com.baeldung.email.EmailService required a bean of type 'org.springframework.mail.javamail.JavaMailSender' that could not be found.接下來，我們將探討 Spring Boot 為什麼可能無法創建或注入 JavaMailSender Bean 的原因。
3. 潛在原因
Spring Boot 通過自動配置簡化了郵件集成，但也支持手動 Bean 定義以滿足定製需求。在兩種方法中，應用程序必須滿足某些條件才能使 <em >JavaMailSender</em> Bean 在應用程序上下文中可用。
3.1. 自動配置問題
首先，spring-boot-starter-mail 依賴項 提供對 JavaMailSender 接口的實現。如果項目未包含此依賴項，Spring 將不會嘗試配置該 Bean。
另一方面，如果項目包含正確的依賴項，但 所需的 郵件配置 不完整或不正確，Spring Boot 將不會創建默認的 JavaMailSender Bean，從而導致自動注入錯誤。
最後，如果應用程序顯式地關閉了對郵件支持的自動配置，Spring 將不會創建該 Bean。
3.2. 手動配置
如果希望繞過自動配置，我們可以手動定義一個 JavaMailSender Bean，並在帶有 @Configuration 註解的類中進行標記。 這種方法在處理多個郵件發送者、高級自定義或無法通過標準 Spring Boot 屬性配置的動態郵件服務器設置時非常實用。
在這種情況下，錯誤的包結構或組件掃描配置錯誤可能導致自動注入錯誤。 此外，Spring Boot 的自動配置會在我們明確定義自定義 JavaMailSender Bean 時自動應用。
4. 可能的解決方案
在分析解決方案之前，讓我們設置項目並添加 spring-boot-starter-mail 依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
<version>3.2.2</version>
</dependency>接下來，讓我們定義一個簡單的 EmailService 類。我們將使用這個類在自動配置和手動配置示例中。
@Service
public class EmailService {
private static final String NOREPLY_ADDRESS = "[email protected]";
private final JavaMailSender javaMailSender;
public EmailService(final JavaMailSender javaMailSender) {
this.javaMailSender = javaMailSender;
}
public void sendSimpleEmail(String to, String subject, String text) {
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom(NOREPLY_ADDRESS);
message.setTo(to);
message.setSubject(subject);
message.setText(text);
javaMailSender.send(message);
}
}最後，在實施電子郵件發送時，我們擁有多種選擇。這些選項中，我們可以配置 Gmail SMTP 服務器，或者本地運行 MailHog 進行功能測試。
4.1. 啓用自動配置
Spring Boot 在存在 starter 依賴時，會嘗試配置 JavaMailSender。但是，我們也必須正確定義所需的屬性。特別是，spring.mail.host 是 spring.mail 屬性組中唯一必須定義的強制屬性。讓我們將我們的屬性設置為指向本地 MailHog 實例：
spring.mail.host=localhost
spring.mail.port=1025
spring.mail.username=
spring.mail.password=使用 MailHog 屬性設置後，我們可以使用基本應用程序發送一封簡單的電子郵件。
@SpringBootApplication(scanBasePackages = { "com.baeldung.email.service" })
public class EmailSenderApplication implements CommandLineRunner {
private final EmailService emailService;
public EmailSenderApplication(EmailService emailService) {
this.emailService = emailService;
}
public static void main(String[] args) {
SpringApplication.run(EmailSenderApplication.class, args);
}
@Override
public void run(String... args) {
emailService.sendSimpleEmail(
"[email protected]",
"Test Subject",
"Testing the Spring Boot Email!"
);
}
}
最後，要使此功能正常工作，我們需要驗證應用程序是否明確禁止啓用自動配置。
例如，以下配置將阻止 Spring Boot 創建 JavaMailSender Bean：
@SpringBootApplication(exclude = MailSenderAutoConfiguration.class)
public class EmailSenderApplication implements CommandLineRunner { ... }若未進行此類排除，Spring Boot 可以自動配置並註冊 JavaMailSender Bean。
4.2. 手動配置 Bean 定義
如果手動定義 JavaMailSender Bean，則必須確保 Bean 正確地添加到 Spring 上下文中。
Spring Boot 默認情況下會掃描從包含主應用程序類所在包及其所有子包的包開始的組件，幷包含所有這些包。任何帶有 @Service、@Component、@Configuration 或其他 Spring 樣板註解的類都將被掃描。
讓我們手動創建一個 JavaMailSender Bean，使其指向 MailHog：
@Configuration
public class EmailConfiguration {
@Bean
public JavaMailSender javaMailSender() {
JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
mailSender.setHost("localhost");
mailSender.setPort(1025);
return mailSender;
}
}<p>如果我們的類位於應用程序的基礎包之外，Spring 無法檢測到它，除非我們提供額外的配置：</p>
@SpringBootApplication(
scanBasePackages = { "com.baeldung.email.config", "com.baeldung.email.service" }
)
public class EmailSenderApplication implements CommandLineRunner { ... }通過指定正確的 scanBasePackages 包，我們確保 Spring 能夠檢測並註冊所有必需的組件。
5. 結論
在本文中，我們探討了在 Spring Boot 中實現電子郵件功能時常見的錯誤。我們演示瞭如何通過使用自動配置和手動配置來避免該錯誤，並強調了每種方法的關鍵考慮因素。 只要正確配置了依賴項和所需屬性，並注意了包的結構，我們就可以輕鬆地將電子郵件功能集成到任何 Spring Boot 項目中。
