Spring的學習與實戰(續)-有解無憂

背景
JavaMailSender
Spring集成郵件發送功能
- 1. 添加maven依賴
- 2. 添加Spring郵件配置
- 3. 創建郵件管理Bean并注入Spring應用背景關系
- 4. 修改業務邏輯，呼叫郵件發送功能
郵件發送功能測驗
Spring集成JavaMailSender實作郵件發送小結
RabbitMQ
- RabbitMQ的基本概念
- RabbitMQ的訊息路由走向
Spring集成RabbitMQ實作異步訊息處理
- 1. 添加maven依賴
- 2. Spring添加RabbitMQ配置
- 3. 創建RabbitMQ配置類
- 4. 創建接收訊息監聽程式
- 5. 修改業務邏輯，實作發送訊息功能
功能測驗
Spring集成RabbitMQ實作異步訊息處理小結

背景

《Spring的學習與實戰》

在上文章中我們已經實作了一個簡單的用戶郵箱登記的web應用，將資料保存到mysql資料庫中，并利用安全框架對web頁面進行保護及實作了管理員的注冊登錄，又通過Spring的配置屬性完成了自定義的各種配置，并了解了Spring與應用的集成的基本概念，實作集成REST API服務，
本文將繼續深入Spring的集成應用，實作郵件發送及集成訊息佇列的功能，

JavaMailSender

Spring框架提供了一種使用JavaMailSender介面發送電子郵件的簡單抽象方法，而Spring Boot為其提供了自動配置以及啟動程式模塊，

JavaMailSender介面具有特殊的JavaMail功能，例如MIME訊息支持，

public interface JavaMailSender extends MailSender {
    MimeMessage createMimeMessage();

    MimeMessage createMimeMessage(InputStream var1) throws MailException;

    void send(MimeMessage var1) throws MailException;

    void send(MimeMessage... var1) throws MailException;

    void send(MimeMessagePreparator var1) throws MailException;

    void send(MimeMessagePreparator... var1) throws MailException;
}

Spring集成郵件發送功能

Spirng實作郵件發送功能，需要以下步驟：
1. 添加maven依賴
2. 添加Spring郵件配置
3. 創建郵件管理Bean并注入Spring應用背景關系
4. 修改業務邏輯，呼叫郵件發送功能

1. 添加maven依賴

 <!-- pom.xml -->	
 	<dependencies>
        <!-- 郵件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
    </dependencies>

2. 添加Spring郵件配置

### application.yml
spring:
#mail配置
  mail:
    host: smtp.163.com
    username: [email protected]
    password: 自行設定郵箱密碼
    default-encoding: UTF-8

3. 創建郵件管理Bean并注入Spring應用背景關系

/**
 * 郵件發送Bean
 *
 * @author zhuhuix
 * @date 2020-07-13
 */
@Service
@Component
public class MailManager {
    private final org.slf4j.Logger logger = LoggerFactory.getLogger(Logger.class);
    // 發件人
    @Value("${spring.mail.username}")
    private String from;

    @Autowired
    private JavaMailSender javaMailSender;

    /**
     * 普通文本郵件發送
     *
     * @param to      收件人
     * @param subject 主題
     * @param text    內容
     */
    public void sendSimpleMail(String to, String subject, String text) {
        SimpleMailMessage msg = new SimpleMailMessage();
        msg.setFrom(this.from);
        msg.setTo(to);
        msg.setSubject(subject);
        msg.setText(text);
        try {
            this.javaMailSender.send(msg);
            logger.info(msg.toString());
        } catch (MailException ex) {
            logger.error(ex.getMessage());
        }

    }

    /**
     * HTML郵件發送
     *
     * @param to      收件人
     * @param subject 主題
     * @param text    內容
     */
    public void sendHTMLMail(String to, String subject, String text) {
        try {
            MimeMessage msg = javaMailSender.createMimeMessage();
            MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(msg, true);
            mimeMessageHelper.setFrom(this.from);
            mimeMessageHelper.setTo(to);
            mimeMessageHelper.setSubject(subject);
            mimeMessageHelper.setText(text, true);
            this.javaMailSender.send(msg);
            logger.info("to=" + to + "," + "subject=" + subject + "," + "text=" + text);
        } catch (MailException ex) {
            logger.error(ex.getMessage());
        } catch (MessagingException ex) {
            logger.error(ex.getMessage());
        }

    }

    /**
     * 發送帶有附件的郵件
     * @param to 收件人
     * @param subject 主題
     * @param text 內容
     * @param filePath 附件
     */
    public void sendAttachmentMail(String to, String subject, String text, String filePath) {
        try {
            MimeMessage mimeMessage = javaMailSender.createMimeMessage();
            MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
            mimeMessageHelper.setFrom(from);
            mimeMessageHelper.setTo(to);
            mimeMessageHelper.setSubject(subject);
            mimeMessageHelper.setText(text, true);
            FileSystemResource fileSystemResource = new FileSystemResource(new File(filePath));
            String fileName = fileSystemResource.getFilename();
            mimeMessageHelper.addAttachment(fileName, fileSystemResource);
            javaMailSender.send(mimeMessage);
            logger.info("to=" + to + "," + "subject=" + subject + "," + "text=" + text);
        } catch (MailException ex) {
            logger.error(ex.getMessage());
        } catch (MessagingException ex) {
            logger.error(ex.getMessage());
        }
    }

}

4. 修改業務邏輯，呼叫郵件發送功能

業務流程圖
業務邏輯

/**
 * 基于SpringMVC框架開發web應用--用戶服務類
 *
 * @author zhuhuix
 * @date 2020-07-03
 * @date 2020-07-04 增加通過jdbcTemplate處理資料
 * @date 2020-07-07 將jdbcTemplate處理資料程式改為Spring Data JPA的處理方式
 * @date 2020-07-10 增加洗掉deleteUser和查找findUser
 * @date 2020-07-13 首次保存用戶后通過郵件管理器發送通知郵件
 */
@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;
    @Autowired
    private MailManager mailManager;

    // 回傳所有的用戶
    public List<User> listUsers() {
        return (List<User>) userRepository.findAll();
    }

    // 保存用戶
    public User saveUser(User user) {
        boolean firstRegister = false;
        if ((user.getId() == null || user.getId().equals(0L))) {
            firstRegister = true;
        }
        // 首次保存用戶成功后發送通知郵件
        if (userRepository.save(user) != null && firstRegister == true) {
            sendMail(user);
        }
        return user;
    }

    // 發送郵件
    private void sendMail(User user) {
        // 發送文本郵件
        String text = "您的郵箱資訊已登記!";
        mailManager.sendSimpleMail(user.getEmail(), "用戶通知(文本郵件)", text);

        // 發送HTML郵件
        String content = "<html>\n" +
                "<body>\n" +
                "<h3> <font color=\"red\"> " + text + "</font> </h3>\n" +
                "</body>\n" +
                "</html>";
        mailManager.sendHTMLMail(user.getEmail(), "用戶通知(HTML郵件)", content);

        // 發送帶有附件的郵件
        String attachFilePath = "c:\\csdn-logo.png";
        mailManager.sendAttachmentMail(user.getEmail(), "用戶通知(帶有附件的郵件)", content, attachFilePath);
    }

    // 洗掉用戶
    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }

    // 查找用戶
    public User findUser(Long id) {
        return userRepository.findById(id).get();
    }

    // 根據名稱查找用戶
    public List<User> searchUser(String name) {
        return userRepository.findByName(name);
    }

}

郵件發送功能測驗

登記用戶
登錄郵箱查看

Spring集成JavaMailSender實作郵件發送小結

以上我們通過JavaMailSender介面實作了文本、超文本及帶有附件的郵件的發送功能，
在書寫這些程式時，采用了硬編碼，可能會碰到如下問題：

用Java代碼創建基于HTML的電子郵件內容很繁瑣且容易出錯，
UI和業務邏輯之間沒有明確區分，
更改電子郵件內容及重新排列UI時，需要撰寫Java代碼，重新編譯，重新部署，
解決這些問題的方法是使用模板庫（例如我們已經用到的thymelea或者freemaker）,當需要發送的郵件的內容變得相當復雜時，就變得非常必要，讀者可自行嘗試，

RabbitMQ

RabbitMQ可以說是AMQP(Advanced Message Queue，高級訊息佇列協議)最杰出的實作，

RabbitMQ的基本概念

在這里插入圖片描述

概念	描述
發送者	訊息的生產者，也可以是一個向交換器發布訊息的客戶端應用程式
接收者	訊息的消費者，也可以認為是向訊息佇列接收訊息的服務端程式
Exchange（交換器）	用來接收發送者發送的訊息并將這些訊息路由給服務器中的佇列
Binding （系結）	用于訊息佇列和交換器之間的關聯
佇列	用來保存訊息直到發送給消費者，它是訊息的容器，也是訊息的終點，
Binding key	在系結（Binding）Exchange與Queue的同時，一般會指定一個Binding key；Routing key結合Exchange可實作路由規則，
Routing key	通過指定Routing key，結合Exchange和Routing key，可以決定訊息流向哪里，

RabbitMQ還有象Channel 信道、Virtual Host 虛擬主機、Broker 訊息佇列服務器物體等概念，請讀者自行研究，

RabbitMQ的訊息路由走向

RabbitMQ的訊息路由走向由Exchange的型別決定；分發訊息時根據Exchange型別的不同分發策略有區別，見下表：

型別	描述
Direct	如果訊息的routing key與佇列的binding key相同，那么訊息將會路由到該佇列上，
Topic	如果訊息的routing key與佇列binding key（可能會包含通配符）匹配，那么訊息將會路由到一個或多個這樣的佇列上，
Fanout	不管routing key和binding key是什么，訊息都將會路由到所有系結佇列上，
Headers	與Topic Exchange類似，只不過要基于訊息的頭資訊進行路由，而不是routing key，

在這里插入圖片描述

本文只對Direct模型進行展開處理，其他型別請讀者自行研究，關于如何系結佇列到Exchange的更詳細的描述，可以參考Alvaro Videla和Jason J.W. Williams撰寫的RabbitMQ in Action （RabbitMQ實戰），

Spring集成RabbitMQ實作異步訊息處理

在這里插入圖片描述

1. 添加maven依賴

 <!-- pom.xml rabbitmq -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>

2. Spring添加RabbitMQ配置

### application.yml
spring:
#RabbitMQ配置
  rabbitmq:
    host: 192.168.0.1
    port: 5672
    username: rabbitmq
    password: rabbitmq
    virtual-host: /
    connection-timeout: 10000
    listener:
      simple:
        acknowledge-mode: auto # 自動應答
        auto-startup: true
        default-requeue-rejected: false # 不重回佇列
        concurrency: 5
        max-concurrency: 20
        prefetch: 1 # 每次只處理一個資訊
        retry:
          enabled: false
    template:
      exchange: web.demo
      routing-key: user.key

在這里插入圖片描述

3. 創建RabbitMQ配置類

/**
 * rabbitmq 配置類
 *
 * @author zhuhuix
 * @date 2020-07-14
 */
@Configuration(value = "https://www.cnblogs.com/zhuhuix/p/rabbitMQConfig")
public class RabbitMQConfig {

    // 獲取exchange和routing-key定義
    @Value("${spring.rabbitmq.template.exchange}")
    private  String exchange;
    @Value("${spring.rabbitmq.template.routing-key}")
    private String routingKey;

    public String getExchange() {
        return exchange;
    }

    public String getRoutingKey() {
        return routingKey;
    }

    // 自定義訊息轉換器
    @Bean
    public MessageConverter messageConverter() {

        return new SimpleMessageConverter() {
            @Override
            protected Message createMessage(Object object, MessageProperties messageProperties) throws MessageConversionException {
                Message message = super.createMessage(object, messageProperties);
                return message;
            }
        };
    }
}

4. 創建接收訊息監聽程式

監聽訊息佇列，收到完整訊息后，呼叫郵件發送程式

/**
 * rabbitmq 接收器
 *
 * @author zhuhuix
 * @date 2020-07-14
 */
@Component
public class RabbitMQReceiver {
    private final org.slf4j.Logger logger = LoggerFactory.getLogger(Logger.class);
	// 郵件集成請參考上篇文章《Spring全家桶的深入學習(八）:Spring集成JavaMailSender實作郵件發送》
    @Autowired
    private MailManager mailManager;
    
    @Autowired
    private RabbitTemplate rabbitTemplate;

    // 監聽訊息佇列
    @RabbitHandler
    @RabbitListener(bindings = @QueueBinding(
            exchange = @Exchange("#{rabbitMQConfig.getExchange()}"),
            key = "#{rabbitMQConfig.getRoutingKey()}",
            value = https://www.cnblogs.com/zhuhuix/p/@Queue("user.queue")))
    public void receiveMessage(Message message) {
        try {
            User user = (User) rabbitTemplate.getMessageConverter().fromMessage(message);
            logger.info("接收到訊息:[{}]", user.toString());
            // 收到完整訊息后，呼叫郵件發送程式，發送通知郵件
            if (user != null) {
                sendMail(user);
            }
        } catch (Exception ex) {
            logger.error(ex.getMessage());
        }
    }

    // 發送郵件
    // 請參考上篇文章《Spring全家桶的深入學習(八）:Spring集成JavaMailSender實作郵件發送》
    private void sendMail(User user) {
        // 發送文本郵件
        String text = "您的郵箱資訊已登記!";
        mailManager.sendSimpleMail(user.getEmail(), "用戶通知(文本郵件)", text);

        // 發送HTML郵件
        String content = "<html>\n" +
                "<body>\n" +
                "<h3> <font color=\"red\"> " + text + "</font> </h3>\n" +
                "</body>\n" +
                "</html>";
        mailManager.sendHTMLMail(user.getEmail(), "用戶通知(HTML郵件)", content);

        // 發送帶有附件的郵件
        String attachFilePath = "c:\\csdn-logo.png";
        mailManager.sendAttachmentMail(user.getEmail(), "用戶通知(帶有附件的郵件)", content, attachFilePath);
    }
}

在這里插入圖片描述

5. 修改業務邏輯，實作發送訊息功能

/**
 * 基于SpringMVC框架開發web應用--用戶服務類
 *
 * @author zhuhuix
 * @date 2020-07-03
 * @date 2020-07-04 增加通過jdbcTemplate處理資料
 * @date 2020-07-07 將jdbcTemplate處理資料程式改為Spring Data JPA的處理方式
 * @date 2020-07-10 增加洗掉deleteUser和查找findUser
 * @date 2020-07-13 首次保存用戶后通過郵件管理器發送通知郵件
 * @date 2020-07-14 將同步發送通知郵件的功能變更為通過訊息佇列異步發送
 */
@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    @Autowired
    private RabbitTemplate rabbitTemplate;

    // 回傳所有的用戶
    public List<User> listUsers() {
        return (List<User>) userRepository.findAll();
    }

    // 保存用戶
    public User saveUser(User user) {
        boolean firstRegister = false;
        if ((user.getId() == null || user.getId().equals(0L))) {
            firstRegister = true;
        }
        // 首次保存用戶成功后發送訊息佇列實作異步發送通知郵件
        if (userRepository.save(user) != null && firstRegister == true) {
            rabbitTemplate.convertAndSend(user);
        }
        return user;
    }


    // 洗掉用戶
    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }

    // 查找用戶
    public User findUser(Long id) {
        return userRepository.findById(id).get();
    }

    // 根據名稱查找用戶
    public List<User> searchUser(String name) {
        return userRepository.findByName(name);
    }

}

功能測驗

在這里插入圖片描述

Spring集成RabbitMQ實作異步訊息處理小結

異步訊息在要通信的應用程式之間提供了一個中間層，這樣能夠實作更松散的耦合和更強的可擴展性，利用訊息佇列的這種特性我們可以很方便地實作系統應用間的解耦：
- 用戶登記成功后，向客戶端回傳登記成功的同時，只是向訊息佇列發送訊息，并不等待郵件的發送事件的結果；
- 而訊息佇列接收者收到訊息后，對訊息進行決議，并根據決議中的郵件地址，發送通知郵件，
Spring支持集成RabbitMQ實作異步訊息，通過使用訊息監聽器注解@RabbitListener，訊息也可以推送至消費者的bean方法中，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/143468.html

標籤：Java

上一篇：LeetCode–二維陣列中的查找

下一篇：springboot2整合mybatis-plus3踩到的坑