feat(mail): 增强邮件模板参数解析和内容格式化功能

YunaiV
1 parent e6dcbde8
Showing 2 changed files with 35 additions and 43 deletions
yudao-module-system/src/main/java/cn/iocoder/yudao/module/system/service/mail/MailTemplateServiceImpl.java
yudao-module-system/src/test/java/cn/iocoder/yudao/module/system/service/mail/MailTemplateServiceImplTest.java
@@ -131,52 +131,47 @@ public class MailTemplateServiceImpl implements MailTemplateService {
     @Override
     public String formatMailTemplateContent(String content, Map<String, Object> params) {
-        // 先替换模板变量
+        // 1. 先替换模板变量
         String formattedContent = StrUtil.format(content, params);
-        // 反转义HTML特殊字符
+        // 关联 Pull Request：https://gitee.com/zhijiantianya/ruoyi-vue-pro/pulls/1461 讨论
+        // 2.1 反转义HTML特殊字符
         formattedContent = unescapeHtml(formattedContent);
-
-        // 处理代码块（确保<pre><code>标签格式正确）
+        // 2.2 处理代码块（确保<pre><code>标签格式正确）
         formattedContent = formatHtmlCodeBlocks(formattedContent);
-
-        // 将最外层的pre标签替换为div标签
+        // 2.3 将最外层的 pre 标签替换为 div 标签
         formattedContent = replaceOuterPreWithDiv(formattedContent);
-
         return formattedContent;
     }
     private String replaceOuterPreWithDiv(String content) {
-        if (content == null) {
-            return null;
+        if (StrUtil.isEmpty(content)) {
+            return content;
         }
-
-        // 使用正则表达式匹配所有的<pre>标签，包括嵌套的<code>标签
+        // 使用正则表达式匹配所有的 <pre> 标签，包括嵌套的 <code> 标签
         String regex = "(?s)<pre[^>]*>(.*?)</pre>";
         Pattern pattern = Pattern.compile(regex);
         Matcher matcher = pattern.matcher(content);
-
-        StringBuffer sb = new StringBuffer();
+        StringBuilder sb = new StringBuilder();
         while (matcher.find()) {
-            // 提取<pre>标签内的内容
+            // 提取 <pre> 标签内的内容
             String innerContent = matcher.group(1);
-            // 返回div标签包裹的内容
+            // 返回 div 标签包裹的内容
             matcher.appendReplacement(sb, "<div>" + innerContent + "</div>");
         }
         matcher.appendTail(sb);
-
         return sb.toString();
     }
     /**
-     * 反转义HTML特殊字符
+     * 反转义 HTML 特殊字符
      *
      * @param input 输入字符串
      * @return 反转义后的字符串
      */
     private String unescapeHtml(String input) {
-        if (input == null) {
-            return null;
+        if (StrUtil.isEmpty(input)) {
+            return input;
         }
         return input
                 .replace("&amp;", "&")
@@ -188,27 +183,24 @@ public class MailTemplateServiceImpl implements MailTemplateService {
     }
     /**
-     * 格式化HTML中的代码块
+     * 格式化 HTML 中的代码块
      *
      * @param content 邮件内容
      * @return 格式化后的邮件内容
      */
     private String formatHtmlCodeBlocks(String content) {
-        // 匹配<pre><code>标签的代码块
+        // 匹配 <pre><code> 标签的代码块
         Pattern codeBlockPattern = Pattern.compile("<pre\\s*.*?><code\\s*.*?>(.*?)</code></pre>", Pattern.DOTALL);
         Matcher matcher = codeBlockPattern.matcher(content);
-
-        StringBuffer sb = new StringBuffer();
+        StringBuilder sb = new StringBuilder();
         while (matcher.find()) {
             // 获取代码块内容
             String codeBlock = matcher.group(1);
-
             // 为代码块添加样式
             String replacement = "<pre style=\"background-color: #f5f5f5; padding: 10px; border-radius: 5px; overflow-x: auto;\"><code>" + codeBlock + "</code></pre>";
             matcher.appendReplacement(sb, replacement);
         }
         matcher.appendTail(sb);
-
         return sb.toString();
     }
@@ -216,6 +208,7 @@ public class MailTemplateServiceImpl implements MailTemplateService {
     public long getMailTemplateCountByAccountId(Long accountId) {
         return mailTemplateMapper.selectCountByAccountId(accountId);
     }
+
     /**
      * 解析标题和内容中的参数
      */
@@ -223,7 +216,6 @@ public class MailTemplateServiceImpl implements MailTemplateService {
     public List<String> parseTemplateTitleAndContentParams(String title, String content) {
         List<String> titleParams = ReUtil.findAllGroup1(PATTERN_PARAMS, title);
         List<String> contentParams = ReUtil.findAllGroup1(PATTERN_PARAMS, content);
-
         // 合并参数并去重
         List<String> allParams = new ArrayList<>(titleParams);
         for (String param : contentParams) {
@@ -221,7 +221,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         // 调用，并断言结果
         String result = mailTemplateService.formatMailTemplateContent(content, params);
-        // 断言pre标签被替换为div标签
+        // 断言 pre 标签被替换为 div 标签
         assertTrue(result.contains("<div><code>public class Test {"));
         assertTrue(result.contains("System.out.println(\"Hello 测试\""));
         assertTrue(result.contains("</code></div>"));
@@ -233,10 +233,10 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         Map<String, Object> params = new HashMap<>();
         params.put("content", "测试内容");
-        // 测试pre标签替换为div标签
+        // 测试 pre 标签替换为 div 标签
         String content = "<pre><code>{content}</code></pre>";
         String result = mailTemplateService.formatMailTemplateContent(content, params);
-        // 断言结果中包含div标签，而不包含pre标签
+        // 断言结果中包含 div 标签，而不包含 pre 标签
         assertTrue(result.contains("<div><code>测试内容</code></div>"));
     }
@@ -247,7 +247,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         params.put("username", "testuser");
         params.put("company", "测试公司");
-        // 测试完整的HTML邮件模板
+        // 测试完整的 HTML 邮件模板
         String content = "<!DOCTYPE html>\n <html lang=\"en\">\n <head>\n  <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n  <meta charset=\"UTF-8\">\n  <title>Title</title>\n </head>\n <body>\n <div>\n  <includetail>\n      <div>\n          <div class=\"open_email\" style=\"margin: 8px; \">\n              <div>\n                  <br>\n                  <span class=\"genEmailContent\">\n                      <div id=\"cTMail-Wrap\" style=\"word-break: break-all;box-sizing:border-box;text-align:left;min-width:320px; max-width:660px; border:1px solid #f6f6f6; background-color:#f7f8fa; margin:auto; padding:20px 0 30px; font-family:'helvetica neue',PingFangSC-Light,arial,'hiragino sans gb','microsoft yahei ui','microsoft yahei',simsun,sans-serif\">\n                          <div class=\"main-content\">\n                              <table style=\"width:100%;font-weight:300;margin-bottom:10px;border-collapse:collapse\">\n                                  <tbody>\n                                  <tr style=\"font-weight:300\">\n                                      <td style=\"width:3%;max-width:30px;\"></td>\n                                      <td style=\"max-width:600px;\">\n                                          <div id=\"cTMail-logo\" style=\"width:92px; height:36px;\">\n                                              <a href=\"\">\n                                                  <img border=\"0\" src=\"左上角图片logo\" style=\"width:120px; height:36px;display:block\">\n                                              </a>\n                                          </div>\n                                          <div style=\"color: #C2C5C9;width: 260px;float: right;font-size: 12px;\">此邮件由系统发出，请勿直接回复或转发他人</div>\n                                          <p style=\"height:2px;background-color: #00a4ff;border: 0;font-size:0;padding:0;width:100%;margin-top:20px;\"></p>\n                                          <div id=\"cTMail-inner\" style=\"background-color:#fff; padding:23px 0 20px;box-shadow: 0px 1px 1px 0px rgba(122, 55, 55, 0.2);text-align:left;\">\n                                              <table style=\"width:100%;font-weight:300;margin-bottom:10px;border-collapse:collapse;\">\n                                                  <tbody>\n                                                  <tr style=\"font-weight:300\">\n                                                      <td style=\"width:3.2%;max-width:30px;\"></td>\n                                                      <td style=\"max-width:480px;\">\n                                                          <h1 id=\"cTMail-title\" style=\"font-size: 20px; line-height: 36px; margin: 0px 0px 22px;\">\n                                                              尊敬的 {username}，\n                                                          </h1>\n                                                          <dl style=\"font-size: 14px; color: #595E65; line-height: 18px;\">\n                                                              <dd style=\"margin: 0px 0px 6px; padding: 0px; font-size: 14px; line-height: 22px;\">\n                                                                  <p id=\"cTMail-sender\" style=\"font-size: 14px; line-height: 26px; word-wrap: break-word; word-break: break-all; margin-top: 32px;\">\n                                                                     内容<br>\n 内容<br>\n 内容123<br><br>\n\n 如果您在使用过程中遇到任何问题或者有任何建议，都可以随时联系我们的客户团队，我们将竭诚为您服务。\n\n\n\n\n <br>\n                                                                      <br>\n                                                                      {company}<br>\n                                                                      地址：xxxxx<br>\n                                                                      邮箱：lambc77@163.com\n                                                                  </p>\n                                                              </dd>\n                                                          </dl>\n                                                          <hr style=\"border: 0.1px solid #e5e5e5;\"/>\n                                                           <dl style=\"font-size: 14px; color: #595E65; line-height: 18px;\">\n                                                               <div style=\"color: #93979B;\">\n                                                                   <strong>声明：本邮件含有保密信息，仅限于收件人所用。禁止任何人未经发件人许可，以任何形式（包括但不限于部分的泄露、复制或散发）不当的使用本邮件中的信息。如果您错收了本邮件，请您立即电话或邮件通知发件人并删除本邮件，谢谢！\n </strong><br>\n                                                               </div>\n                                                           </dl>\n                                                      </td>\n                                                      <td style=\"width:3.2%;max-width:30px;\"></td>\n                                                  </tr>\n                                                  </tbody>\n                                              </table>\n                                          </div>\n                                      </td>\n                                      <td style=\"width:3%;max-width:30px;\"></td>\n                                  </tr>\n                                  </tbody>\n                              </table>\n                          </div>\n                      </div>\n                  </span>\n              </div>\n          </div>\n      </div>\n  </includetail>\n </div>\n </body>\n <script>\n\n </script>\n </html>";
         // 调用，并断言成功处理
@@ -255,7 +255,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         // 断言结果中包含替换后的变量
         assertTrue(result.contains("尊敬的 testuser"));
         assertTrue(result.contains("测试公司"));
-        // 断言结果是有效的HTML
+        // 断言结果是有效的 HTML
         assertTrue(result.startsWith("<!DOCTYPE html>"));
     }
@@ -287,7 +287,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         params.put("param1", "value1");
         params.put("param2", "value2");
-        // 测试多个pre标签的情况
+        // 测试多个 pre 标签的情况
         String content = "<pre><code>First code block: {param1}</code></pre>\n" +
                 "<p>Some text between code blocks</p>\n" +
                 "<pre><code>Second code block: {param2}</code></pre>";
@@ -302,7 +302,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         // 准备参数
         Map<String, Object> params = new HashMap<>();
-        // 简化测试，只测试基本的HTML特殊字符
+        // 简化测试，只测试基本的 HTML 特殊字符
         String content = "&lt;div&gt;测试 &amp; 特殊字符&lt;/div&gt;";
         String result = mailTemplateService.formatMailTemplateContent(content, params);
         // 断言特殊字符被正确反转义
@@ -327,7 +327,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
     @Test
     public void testDifferenceWithHtmlContent() {
-        // 准备包含HTML格式的模板内容
+        // 准备包含 HTML 格式的模板内容
         String content = "<div style='font-family: Arial, sans-serif; color: #333;'>" +
                 "<h1>Welcome, {username}!</h1>" +
                 "<p>Your account has been created successfully.</p>" +
@@ -347,28 +347,28 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         params.put("role", "admin");
         params.put("activationLink", "https://example.com/activate?code=12345");
-        // 1. 使用parseTemplateContentParams：只提取参数名称，忽略了HTML格式
+        // 1. 使用 parseTemplateContentParams：只提取参数名称，忽略了 HTML 格式
         List<String> parsedParams = mailTemplateService.parseTemplateContentParams(content);
         System.out.println("parseTemplateContentParams结果：" + parsedParams);
-        // 断言：只提取了纯参数名称，没有HTML格式
+        // 断言：只提取了纯参数名称，没有 HTML 格式
         assertEquals(6, parsedParams.size());
         // 检查所有参数类型
-        assertTrue(parsedParams.stream().filter("username"::equals).count() == 3);
-        assertTrue(parsedParams.stream().filter("email"::equals).count() == 1);
-        assertTrue(parsedParams.stream().filter("role"::equals).count() == 1);
-        assertTrue(parsedParams.stream().filter("activationLink"::equals).count() == 1);
-        // 断言：没有包含任何HTML标签
+        assertEquals(3, parsedParams.stream().filter("username"::equals).count());
+        assertEquals(1, parsedParams.stream().filter("email"::equals).count());
+        assertEquals(1, parsedParams.stream().filter("role"::equals).count());
+        assertEquals(1, parsedParams.stream().filter("activationLink"::equals).count());
+        // 断言：没有包含任何 HTML 标签
         for (String param : parsedParams) {
             assertFalse(param.contains("<"));
             assertFalse(param.contains(">"));
         }
-        // 2. 使用formatMailTemplateContent：处理HTML格式，生成最终内容
+        // 2. 使用 formatMailTemplateContent：处理 HTML 格式，生成最终内容
         String formattedContent = mailTemplateService.formatMailTemplateContent(content, params);
         System.out.println("formatMailTemplateContent结果：" + formattedContent);
-        // 断言：HTML格式被保留并处理
+        // 断言：HTML 格式被保留并处理
         assertTrue(formattedContent.contains("<div style='font-family: Arial, sans-serif; color: #333;'>"));
         assertTrue(formattedContent.contains("<h1>Welcome, testuser!</h1>"));
         assertTrue(formattedContent.contains("<a href='https://example.com/activate?code=12345'>here</a>"));