Spring的學習與實戰(續)
阿新 • • 發佈：2020-07-14
@ 目錄
- 背景
- JavaMailSender
- Spring整合郵件傳送功能
- 郵件傳送功能測試
- Spring整合JavaMailSender實現郵件傳送小結
- RabbitMQ
- Spring整合RabbitMQ實現非同步訊息處理
- 功能測試
- Spring整合RabbitMQ實現非同步訊息處理小結
背景
- 在上文章中我們已經實現了一個簡單的使用者郵箱登記的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方法中。