Detaillierte Erläuterung des integrierten Mail-Dienstes in SpringBoot (mit Code)

Dieser Artikel enthält eine detaillierte Erklärung des in SpringBoot integrierten E-Mail-Dienstes (mit Code). Ich hoffe, dass er für Freunde hilfreich ist.

1. Vorwort

Der Kern der Spring-E-Mail-Abstraktion ist die MailSender-Schnittstelle. Die Implementierung von MailSender kann E-Mails an den Mailserver senden, und der Mailserver implementiert die Sendefunktion E-Mails.

Spring wird mit einer MailSender-Implementierung geliefert, JavaMailSenderImpl, die die JavaMail-API zum Senden von E-Mails verwendet. Bevor eine Spring- oder SpringBoot-Anwendung E-Mails senden kann, müssen wir JavaMailSenderImpl als Bean im Spring-Anwendungskontext zusammenstellen.

2. Konfiguration

1. pom.xml

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-mail</artifactId>  
     </dependency>

2. application.yml

spring:
  mail:
    host: smtp.163.com
    port: 25
    username: 159****2662@163.com
    password: ***********

Das Host-Attribut ist standardmäßig der Host von die JavaMail-Sitzung; Der Port überwacht standardmäßig den Standard-SMTP-Port 25; wenn der Mailserver eine Authentifizierung erfordert, müssen auch Benutzername und Passwort festgelegt werden.

Hier verwende ich den 163-Mailserver. Ich muss das Client-Autorisierungskennwort im 163-Postfach aktivieren, sonst wird ein 550-Authentifizierungsfehler gemeldet.

3. EmailConfig.java

Hier stellen wir JavaMailSenderImpl als Bean of the Spring-Anwendungskontext zusammen. Gleichzeitig ist zu beachten, dass hier die Annotation @ConfigurationProperties verwendet wird. Diese Annotation erfordert, dass die Eigenschaft über eine Setter-Methode verfügt, und die Annotation @EnableConfigurationProperties wird in der Startup-Klasse verwendet, um sie wirksam zu machen.

@Configuration
@ConfigurationProperties(prefix = "spring.mail")
public class EmailConfig {
    private String host;
    private Integer port;
    private String username;
    private String password;
    @Bean
    public MailSender javaMailSender() {
        JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
        javaMailSender.setHost(host);
        javaMailSender.setPort(port);
        javaMailSender.setUsername(username);
        javaMailSender.setPassword(password);
        return javaMailSender;
    }
    public void setHost(String host) {
        this.host = host;
    }
    public void setPort(Integer port) {
        this.port = port;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public void setPassword(String password) {
        this.password = password;
    }
}

3. Senden

Mit javaMailSender ist das Versenden von E-Mails eine einfache Sache. Wir müssen nur die javaMailSender-Bean in unsere eigene Implementierungsklasse einfügen und dann die JavaMail-API zum Senden von E-Mails verwenden.

1. Das Senden von Text-E-Mails

public void sendSimpleEmail() {
    // 构造Email消息
    SimpleMailMessage message = new SimpleMailMessage();
    message.setFrom("159****2662@163.com");
    message.setTo("****@qianxx.com");
    message.setSubject("邮件主题");
    message.setText("邮件内容");
    javaMailSender.send(message);
}

Einfache Text-E-Mail besteht aus der Erstellung einer SimpleMailMessage-Instanz. Dieses Objekt kann problemlos E-Mail-Nachrichten senden.

2. E-Mail-Anhänge senden

Die E-Mail-Funktion von Spring ist nicht auf Nur-Text-E-Mails beschränkt. Wir können auch Anhänge hinzufügen. Wenn Sie eine E-Mail mit einem Anhang senden möchten, besteht der wichtigste Trick darin, ihn zu erstellen Mehrteilige Nachricht – E-Mail besteht aus mehreren Teilen, ein Teil ist der E-Mail-Text und die anderen Teile sind Anhänge. Mehrteilig senden Für den E-Mail-Typ müssen Sie eine MIME-Nachricht (Multipurpose Internet Mail Extensions) erstellen.

public void mimeEmail() throws MessagingException {
    // MimeMessage 本身的 API 有些笨重，我们可以使用 MimeMessageHelper
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    // 第二个参数是 true ，表明这个消息是 multipart类型的/
    MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
    mimeMessageHelper.setFrom("159****2662@163.com");
    mimeMessageHelper.setTo("****@qianxx.com");
    mimeMessageHelper.setSubject("附件邮件主题");
    mimeMessageHelper.setText("附件邮件内容");
    //添加附件,第一个参数表示添加到 Email 中附件的名称，第二个参数是图片资源
    mimeMessageHelper.addAttachment("boot.png", new ClassPathResource("public/images/boot.png"));
    javaMailSender.send(mimeMessage);
}

3. Senden Sie Rich-Text-E-Mails

Zusätzlich zum Hinzufügen von Anhängen kann die E-Mail-Funktion von Spring sogar HTML verwenden, um den Inhalt des Nachrichtentexts zu verschönern. Senden von Rich-Text-E-Mails im Vergleich zum Senden einfacher Text-E-Mails E-Mail ist nicht viel anders. Der Schlüssel besteht darin, den Nachrichtentext der setText()-Methode auf HTML und den zweiten Parameter auf true zu setzen, was angibt, dass es sich um HTML handelt von Rich Text.

public void htmlEmail() throws MessagingException {
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
    mimeMessageHelper.setFrom("159****2662@163.com");
    mimeMessageHelper.setTo("****@qianxx.com");
    mimeMessageHelper.setSubject("富文本邮件主题");
    String html = "<html><body><h4 id="Hello-SpringBoot">Hello,SpringBoot</h4><img  src=&#39;cid:boot&#39; / alt="Detaillierte Erläuterung des integrierten Mail-Dienstes in SpringBoot (mit Code)" ></body></html>";
    mimeMessageHelper.setText(html, true);
    // 设置内嵌元素 cid，第一个参数表示内联图片的标识符，第二个参数标识资源引用
    mimeMessageHelper.addInline("boot", new ClassPathResource("public/images/boot.png"));
    javaMailSender.send(mimeMessage);
}

4. Fazit

String-Splicing von HTML-Tags ist eine sehr knifflige Sache. Weil es schwierig ist, HTML-Tags im Kopf zu analysieren und sich vorzustellen, wie sie beim Rendern aussehen werden. Das Mischen von HTML- und Java-Code verkompliziert das Problem zusätzlich.

Die von Spring bereitgestellte Lösung besteht darin, Vorlagen zum Generieren von E-Mails zu verwenden. Es stehen verschiedene Vorlagenlösungen zur Auswahl, darunter Apache Velocity und Thymeleaf. (Da ich mit diesen beiden Vorlagensyntaxen nicht sehr gut bin, werde ich sie nicht im Detail vorstellen.)

Demo-Quellcode: https://github.com/JMCuixy/Boot

Das obige ist der detaillierte Inhalt vonDetaillierte Erläuterung des integrierten Mail-Dienstes in SpringBoot (mit Code). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!