如何添加对多种 Thymeleaf 模板模式的支持

Question

我有一个 Spring Boot 应用程序，使用 Thymeleaf 3 作为应用程序页面的模板引擎。我们使用spring-boot-starter-thymeleaf提供的默认配置，HTML Thymeleaf 模板位于src/main/resources/templates文件夹下。

现在我们想使用 Thymeleaf 来生成一些 javascript 文件，使用新的 javascript 模板模式。这些 javascript 模板可以位于同一个 HTML 模板文件夹或另一个文件夹中（例如：src/main/resources/jstemplates）。

我不知道是否有一种方法可以添加此配置而不更改spring-boot-starter-thymeleaf提供的默认配置中的任何内容，或者我必须为所有内容创建完整配置。

我尝试了使用以下配置的第一个选项，该选项适用于 javascript 模板，但 html 模板不再适用。

配置：

@Configuration
public class WebMvcConfiguration extends WebMvcConfigurerAdapter
    implements ApplicationContextAware {

  private static final String UTF8 = "UTF-8";

  @Autowired
  private SpringTemplateEngine templateEngine;

  @Autowired
  private ThymeleafProperties properties;

  private ApplicationContext applicationContext;

  @Override
  public void setApplicationContext(ApplicationContext applicationContext) {
    this.applicationContext = applicationContext;
  }

  @Bean
  public ThymeleafViewResolver javascriptThymeleafViewResolver() {
    ThymeleafViewResolver resolver = new ThymeleafViewResolver();
    resolver.setTemplateEngine(this.templateEngine);
    resolver.setCharacterEncoding(UTF8);
    resolver.setContentType("application/javascript");
    resolver.setViewNames(new String[] {".js"});
    resolver.setCache(this.properties.isCache());
    return resolver;
  }

  @Bean
  public SpringResourceTemplateResolver javascriptTemplateResolver() {
    SpringResourceTemplateResolver resolver = new SpringResourceTemplateResolver();
    resolver.setApplicationContext(applicationContext);
    resolver.setPrefix("classpath:/jstemplates/");
    resolver.setSuffix(".js");
    resolver.setTemplateMode(TemplateMode.JAVASCRIPT);
    resolver.setCharacterEncoding(UTF8);
    return resolver;
  }
}

测试 javascript 控制器：

@Controller
public class JavascriptController {

  @RequestMapping(method = RequestMethod.GET, value = "/test.js")
  public String testjs() {
    return "test";
  }
}

根页面的控制器：

@Controller
public class MainController {

  @RequestMapping(method = RequestMethod.GET, value = "/")
  public String index(Model model) {
    return "index";
  }
}

src/main/resources/jstemplates文件夹中有一个test.js文件。如果我尝试 URL http://localhost:8080/test.js，它会按预期工作。但是，例如，如果我尝试主网址（http://localhost:8080/），它会失败并出现以下错误：

导致：java.io.FileNotFoundException：类路径资源[jstemplates/index.js]无法打开，因为它不存在

它应该寻找templates/index.html，所以看起来javascriptTemplateResolver会覆盖或优先于默认值，而不会退回到它。

有没有办法添加与默认 Thymeleaf 配置集成的另一个模板模式支持，或者我需要从头开始配置所有内容？

Answer 1

经过一番调试，我终于找到了解决方案。看来SpringResourceTemplateResolver默认情况下不会检查模板是否确实存在。在我的示例配置中，第一个模板解析器是为 javascript 模板配置的解析器，它创建一个视图，而无需先查看模板是否存在。

要解决此问题，模板checkExistence属性必须设置为true。前任：

  @Bean
  public SpringResourceTemplateResolver javascriptTemplateResolver() {
    SpringResourceTemplateResolver resolver = new SpringResourceTemplateResolver();
    resolver.setApplicationContext(applicationContext);
    resolver.setPrefix("classpath:/jstemplates/");
    resolver.setSuffix(".js");
    resolver.setTemplateMode(TemplateMode.JAVASCRIPT);
    resolver.setCharacterEncoding(UTF8);
    resolver.setCheckExistence(true);
    return resolver;
  }

我看到这个配置的唯一问题是，如果我们创建一个与 html 视图同名的 js 视图，它总是会得到 javascript 视图。

编辑

为了解决最后一个问题，我对配置进行了一些更改：

• 删除解析器配置中的.js后缀
• 当控制器提供 JavaScript 视图名称时，该名称已经包含.js后缀。

最终配置如下：

@Configuration
public class WebMvcConfiguration extends WebMvcConfigurerAdapter
    implements ApplicationContextAware {

  private static final String UTF8 = "UTF-8";

  @Autowired
  private ThymeleafProperties properties;

  @Autowired
  private TemplateEngine templateEngine;

  private ApplicationContext applicationContext;

  @Override
  public void setApplicationContext(ApplicationContext applicationContext) {
    this.applicationContext = applicationContext;
  }

  @Bean
  public ThymeleafViewResolver javascriptThymeleafViewResolver() {
    ThymeleafViewResolver resolver = new ThymeleafViewResolver();
    resolver.setTemplateEngine(this.templateEngine);
    resolver.setCharacterEncoding(UTF8);
    resolver.setContentType("application/javascript");
    resolver.setViewNames(new String[] {"*.js"});
    resolver.setCache(this.properties.isCache());
    return resolver;
  }

  @Bean
  public SpringResourceTemplateResolver javascriptTemplateResolver() {
    SpringResourceTemplateResolver resolver = new SpringResourceTemplateResolver();
    resolver.setApplicationContext(this.applicationContext);
    resolver.setPrefix("classpath:/templates/js/");
    resolver.setTemplateMode(TemplateMode.JAVASCRIPT);
    resolver.setCharacterEncoding(UTF8);
    resolver.setCheckExistence(true);
    resolver.setCacheable(this.properties.isCache());
    return resolver;
  }
}

和示例控制器：

@Controller
public class JavascriptController {

  @RequestMapping(method = RequestMethod.GET, value = "/js/test.js")
  public String testjs() {
    return "test.js";
  }
}

HTML 视图控制器保持不变。