Versand von E-Mails mit Spring Batch

Keine Kommentare

Wie schon im letzten Artikel (Sicherer Datenversand mit SFTP und Spring Batch) befasst sich auch dieser Artikel mit einer nicht mehr ganz taufrischen, nichts­des­to­trotz aber sehr wichtigen Technologie: E-Mail. In diesem Artikel wird gezeigt, wie sich der Versand von E-Mails mit Hilfe von Spring Batch einfach realisieren lässt. Spring Batch bringt hierfür schon einige fertige Komponenten mit, die man nur noch geeignet kombinieren muss.

Im folgenden Beispiel werden drei Beans deklariert, die beim E-Mail-Versand eine Rolle spielen:

  • mailSender,
  • sendMailTasklet sowie
  • sendMailService.

Die Bean mailSender muss nur deklariert werden, da wir hier eine Klasse aus dem Framework verwenden. Auf dieser Bean werden alle benötigten Parameter zur Verbindung mit dem Mail-Server konfiguriert.

Deklaration der Bean mailSender

<bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
    <property name="host" value="smtp.yourEmailDomain.de"/>
    <property name="port" value="25"/>
    <property name="username" value="yourUserName"/>
    <property name="password" value="yourPassword"/>
    <property name="javaMailProperties">
        <props>
            <prop key="mail.smtp.auth">true</prop>
        </props>
    </property>
</bean>

Das Tasklet wird von Spring Batch während der Ausführung aufgerufen (Methode execute). Es koordiniert das Zusammenspiel der anderen beiden Beans. Des Weiteren werden auf dem Tasklet noch einige weitere Parameter für den E-Mail-Versand konfiguriert.

Deklaration des Tasklets

<bean id="sendMailTasklet">
    <property name="mailSender" ref="mailSender"/>
    <property name="sendMailService" ref="sendMailService"/>
    <property name="senderAddress" value="sender@emailaddress.de"/>
    <property name="recipient" value="recipient@emailaddress.de"/>
    <property name="attachmentFilePath" value="/path/to/attachment/file/"/>
</bean>

Java-Code für das Tasklet

package de.batch.tasklets;
 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.mail.javamail.JavaMailSender;
 
import de.batch.mail.SendMailService;
 
public class SendMailTasklet implements Tasklet {
    private static final Log log = LogFactory.getLog(SendMailTasklet.class);
    private SendMailService sendMailService;
    private JavaMailSender mailSender;
    private String senderAddress;
    private String recipient;
    private String attachmentFilePath;
 
    public void setMailSender(JavaMailSender mailSender) {
       this.mailSender = mailSender;
    }
    public void setSenderAddress(String senderAddress) {
        this.senderAddress = senderAddress;
    }
 
    public void setRecipient(String recipient) {
        this.recipient = recipient;
    }
 
    public void setAttachmentFilePath(String attachmentFilePath) {
        this.attachmentFilePath = attachmentFilePath;
    }
 
    public void setSendMailService(SendMailService sendMailService) {
        this.sendMailService = sendMailService;
    }
 
    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
        log.debug("execute(StepContribution contribution, ChunkContext chunkContext) begin");
        sendMailService.setFields(mailSender, senderAddress, recipient, attachmentFilePath);
        sendMailService.sendMail();
        log.debug("execute(StepContribution contribution, ChunkContext chunkContext) end");
        return RepeatStatus.FINISHED;
    }
}

Der sendMailService schließlich kümmert sich um das Aufbereiten und Verschicken der E-Mail selbst.

Deklaration des Services

<bean id="sendMailService" class="de.batch.mail.SendMailService" />

Der Java-Code für den Service

package de.batch.mail;
 
import java.io.File;
import javax.ejb.Stateless;
import javax.mail.Message;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jboss.seam.annotations.Name;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.MailException;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.mail.javamail.MimeMessagePreparator;
 
public class SendMailService {
 
    private static final Log log = LogFactory.getLog(SendMailService.class);
    private JavaMailSender mailSender;
    private String senderAddress;
    private String recipient;
    private String attachmentFilePath;
 
    // set the fields
    public void setFields(JavaMailSender mailSender, String senderAddress, String recipient, String attachmentFilePath) {
 
        this.mailSender = mailSender;
        this.senderAddress = senderAddress;
        this.recipient = recipient;
        this.attachmentFilePath = attachmentFilePath;
    }
 
    public void sendMail() {
        log.debug("send Email started");
        // read directory
        File directory = new File(attachmentFilePath);
        // get file from directory
        final File file = directory.listFiles(FILE_FILTER)[0];
 
        MimeMessagePreparator preparator = new MimeMessagePreparator() {
            public void prepare(MimeMessage mimeMessage) throws Exception {
                mimeMessage.setRecipient(Message.RecipientType.TO, new InternetAddress(recipient));
                mimeMessage.setFrom(new InternetAddress(senderAddress));
                mimeMessage.setSubject("Neuer Report");
                // MimeMessagesHelper is needed for the attachment. The Boolean value in
                // constructor is for multipart/data = true
                MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
                helper.addAttachment(file.getName(), new FileSystemResource(file));
                helper.setText("Text in Email Body");
            }
        };
        try {
            this.mailSender.send(preparator);
            log.debug("send Email completed");
        } catch (MailException ex) {
            log.debug("send Email failed", ex);
        }
    }
 
    public static FileFilter FILE_FILTER = new FileFilter() {
        public boolean accept(File file) {
            return !file.isDirectory();
        }
    };
 }

Der Ablauf des Batch Jobs wird durch die Deklaration des Tags batch:job angegeben. In unserem Fall ist hier nur das Tasklet als einziger Step anzugeben:

<batch:job id="sendMailJob" restartable="false">
  <batch:step id="sendMailStep">
    <batch:tasklet ref="sendMailTasklet" />
  </batch:step>
</batch:job>

Dies ist auch schon alles, was man zum Versand von E-Mails mit Spring Batch benötigt. Der Batch Job kann nun wie gehabt über die Kommandozeile/Shell (also z. B. auch durch einen cronjob) gestartet werden.

Kommentieren

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.