非Spring环境Thymeleaf邮件库优先加载项目resources模板方案咨询

核心实现逻辑 #

利用Thymeleaf原生支持多模板解析器按优先级执行的特性，配置两套ClassLoaderTemplateResolver：优先使用业务项目的类加载器读取其resources下的模板，匹配失败后再降级使用工具库自身的类加载器读取内置模板。

具体实现步骤 #

• 配置多优先级模板解析器，初始化TemplateEngine时按顺序注册两套解析器

import org.thymeleaf.TemplateEngine;
import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver;

public class MailTemplateEngineBuilder {
    public static TemplateEngine build() {
        TemplateEngine templateEngine = new TemplateEngine();

        // 优先级1：读取引入工具库的业务项目的模板，使用线程上下文类加载器（业务侧的类加载器）
        ClassLoaderTemplateResolver businessTemplateResolver = new ClassLoaderTemplateResolver(
            Thread.currentThread().getContextClassLoader()
        );
        businessTemplateResolver.setPrefix("/templates/");
        businessTemplateResolver.setSuffix(".html");
        businessTemplateResolver.setCharacterEncoding("UTF-8");
        businessTemplateResolver.setOrder(1);
        // 必须开启存在性检查，找不到模板时才会向下匹配更低优先级的解析器
        businessTemplateResolver.setCheckExistence(true);

        // 优先级2：读取工具库内置模板，使用工具库自身的类加载器
        ClassLoaderTemplateResolver builtInTemplateResolver = new ClassLoaderTemplateResolver(
            MailTemplateEngineBuilder.class.getClassLoader()
        );
        builtInTemplateResolver.setPrefix("/templates/");
        builtInTemplateResolver.setSuffix(".html");
        builtInTemplateResolver.setCharacterEncoding("UTF-8");
        builtInTemplateResolver.setOrder(2);
        // 内置模板默认存在，无需额外检查提升性能
        builtInTemplateResolver.setCheckExistence(false);

        templateEngine.addTemplateResolver(businessTemplateResolver);
        templateEngine.addTemplateResolver(builtInTemplateResolver);
        return templateEngine;
    }
}

• 模板调用逻辑无需修改，工具库内部正常调用templateEngine.process("模板文件名", 上下文对象)即可，Thymeleaf会自动按优先级匹配模板
• 可选扩展：如果需要支持业务项目自定义模板路径、后缀等配置，可对外暴露配置项供业务侧修改

public class MailToolConfig {
    // 业务项目可在初始化工具时自行覆盖该配置
    public static String CUSTOM_TEMPLATE_PREFIX = "/templates/";
    public static String CUSTOM_TEMPLATE_SUFFIX = ".html";
}

验证逻辑 #

• 业务项目引入工具库依赖后，在自身src/main/resources/templates目录下新建和工具库内置模板同名的HTML文件
• 触发邮件发送，收到的邮件内容为业务项目自定义模板内容即适配成功
• 若业务项目删除对应自定义模板，自动降级使用工具库内置模板，无需额外修改配置

内容的提问来源于stack exchange，提问作者Adrian Dadun