如何解決“無法自動組裝 org.springframework.mail.javamail.JavaMailSender”
1. 簡介
在本教學中，我們將探討如何解決使用 Spring Boot 實作電子郵件功能時可能遇到的常見錯誤。
我們將重點介紹“Could not autowire org.springframework.mail.javamail.JavaMailSender”問題、其發生的原因以及如何修復它。
2. 理解錯誤
我們先來解釋一下這個錯誤的意思。 JavaMailSender是 Spring 提供的一個接口，用於抽象電子郵件發送JavaMailSender 。它擴展了MailSender接口，後者提供了發送簡單文字電子郵件的基本功能。具體來說， JavaMailSender支援更進階的電子郵件功能，例如 MIME 訊息、附件和 HTML 內容。
Spring 的依賴注入機制會自動將 Bean 連接到需要的地方。當遇到@Autowired註解或（最好是）構造函數注入時，它會在應用程式上下文中搜尋匹配的 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。在這兩種方法中，應用程式都必須滿足某些條件才能使JavaMailSender bean 在應用程式上下文中可用。
3.1. 自動設定問題
首先， spring-boot-starter-mail dependency提供了JavaMailSender介面的實作。如果專案不包含此依賴項，Spring 甚至不會嘗試配置該 bean。
另一方面，如果專案包含正確的依賴項，但所需的郵件屬性配置不完整或不正確，Spring Boot 將跳過建立預設的JavaMailSender bean ，從而導致自動組裝錯誤。
最後，如果應用程式明確關閉郵件支援的自動配置，Spring 將不會嘗試建立該 bean。
3.2. 未註冊的手動配置
或者，如果我們想要繞過自動配置，我們可以在標有@Configuration註解的類別中手動定義一個JavaMailSender bean 。當處理多個郵件寄件者、進階自訂或無法透過標準 Spring Boot 屬性配置的動態郵件伺服器設定時，此方法非常實用。
在這種情況下，錯誤的套件結構或組件掃描配置錯誤可能會導致自動組裝錯誤。此外，除非我們明確定義自訂JavaMailSender bean ，否則 Spring Boot 的自動設定會自動套用。
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 會嘗試設定JavaMailSender 。但是，我們也必須正確定義所需的屬性。具體來說， **s pring.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;
}
}如果我們的類別位於應用程式的基礎套件之外，除非我們提供額外的配置，否則 Spring 將無法偵測到它：
@SpringBootApplication(
scanBasePackages = { "com.baeldung.email.config", "com.baeldung.email.service" }
)
public class EmailSenderApplication implements CommandLineRunner { ... }透過在scanBasePackages中指定正確的套件，我們確保 Spring 偵測並註冊所有必需的元件。
5. 結論
在本文中，我們探討了使用 Spring Boot 實作電子郵件功能時常見的一個錯誤。我們示範如何使用自動配置和手動配置來避免該錯誤，並重點介紹了每種方法的關鍵注意事項。透過設定正確的依賴項和必需屬性，並適當地關注套件結構，我們可以輕鬆地將電子郵件功能整合到任何 Spring Boot 專案中。
與往常一樣，完整的原始程式碼可在 GitHub 上取得。