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 = "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 = @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方法中。

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實現異步消息處理小結

高效率使用windows

Spring Cloud Alibaba生態探索：Dubbo、Nacos及Sentinel的完美結合

Spring Cloud Alibaba微服務生態的基礎實踐

自己作圖分析分佈式技術架構演化的常用套路

用一個實例項目重新認識分佈式系統

重溫Java Web的技術細節

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結