Spring Boot 与 kotlin 使用Thymeleaf模板引擎渲染web视图的方法

2023-09-17 20:42:05 153

本篇给大家介绍SpringBoot与kotlin使用Thymeleaf模板引擎渲染web视图。

静态资源访问

在我们开发Web应用的时候，需要引用大量的js、css、图片等静态资源，使用SpringBoot与kotlin如何去支持这些静态资源？，很简单。

默认配置

SpringBoot默认提供静态资源目录位置需置于classpath下，目录名需符合如下规则：

/static
/public
/resources
/META-INF/resources

举例：我们可以在src/main/resources/目录下创建static，在该位置放置一个图片文件。启动程序后，尝试访问http://localhost:8080/ruby.jpg。如能显示图片，配置成功。

渲染Web页面

之前通过@RestController处理请求，返回的内容为json对象。如果需要渲染html页面，要如何实现呢？

模板引擎

在SpringBoot推荐的模板引擎下，我们可以很快的上手开发动态网站。

SpringBoot提供了默认配置的模板引擎主要有以下几种：

Thymeleaf
FreeMarker
Groovy
Mustache

SpringBoot建议使用这些模板引擎，避免使用JSP，若一定要使用JSP将无法实现SpringBoot的多种特性，具体可见后文：支持JSP的配置

当你使用上述模板引擎中的任何一个，它们默认的模板配置路径为：src/main/resources/templates。当然也可以修改这个路径，具体如何修改，可在后续各模板引擎的配置属性中查询并修改。

Thymeleaf

Thymeleaf是一个XML/XHTML/HTML5模板引擎，可用于Web与非Web环境中的应用开发。它是一个开源的Java库，基于ApacheLicense2.0许可，由DanielFernández创建，该作者还是Java加密库Jasypt的作者。

Thymeleaf提供了一个用于整合SpringMVC的可选模块，在应用开发中，你可以使用Thymeleaf来完全代替JSP或其他模板引擎，如FreeMarker等。Thymeleaf的主要目标在于提供一种可被浏览器正确显示的、格式良好的模板创建方式，因此也可以用作静态建模。你可以使用它创建经过验证的XML与HTML模板。相对于编写逻辑或代码，开发者只需将标签属性添加到模板中即可。接下来，这些标签属性就会在DOM（文档对象模型）上执行预先制定好的逻辑。

示例模板：





quanke.name


HelloWorld

可以看到Thymeleaf主要以属性的方式加入到html标签中，浏览器在解析html时，当检查到没有的属性时候会忽略，所以Thymeleaf的模板可以通过浏览器直接打开展现，这样非常有利于前后端的分离。

在SpringBoot中使用Thymeleaf，只需要引入下面依赖，并在默认的模板路径src/main/resources/templates下编写模板文件即可完成。

compile"org.springframework.boot:spring-boot-starter-thymeleaf:$spring_boot_version"

在完成配置之后，举一个简单的例子，在快速入门工程的基础上，举一个简单的示例来通过Thymeleaf渲染一个页面。

importorg.springframework.stereotype.Controller
importorg.springframework.ui.ModelMap
importorg.springframework.web.bind.annotation.RequestMapping
/**
*Createdbyhttp://quanke.nameon2018/1/10.
*/
@Controller
classHelloController{
@RequestMapping("/")
funindex(map:ModelMap):String{
///加入一个属性，用来在模板中读取
map.addAttribute("host","http://quanke.name")
//return模板文件的名称，对应src/main/resources/templates/index.html
return"index"
}
}

默认在src/main/resources/templates目录下增加index.html文件





quanke.name


HelloWorld

增加使用kotlin语言实现的SpringBoot启动方法：

importorg.springframework.boot.SpringApplication
importorg.springframework.boot.autoconfigure.SpringBootApplication

/**
*Createdbyhttp://quanke.nameon2018/1/9.
*/
@SpringBootApplication
classApplication
funmain(args:Array){
SpringApplication.run(Application::class.java,*args)
}

如上页面，直接打开html页面展现HelloWorld，但是启动程序后，访问http://localhost:8080/，则是展示Controller中host的值：http://quanke.name，做到了不破坏HTML自身内容的数据逻辑分离。

更多Thymeleaf的页面语法，还请访问Thymeleaf的官方文档查询使用。

Thymeleaf的默认参数配置

如有需要修改默认配置的时候，只需复制下面要修改的属性到application.yml中，并修改成需要的值，如修改模板文件的扩展名，修改默认的模板路径等。

#Enabletemplatecaching.
spring.thymeleaf.cache=true
#Checkthatthetemplateslocationexists.
spring.thymeleaf.check-template-location=true
#Content-Typevalue.
spring.thymeleaf.content-type=text/html
#EnableMVCThymeleafviewresolution.
spring.thymeleaf.enabled=true
#Templateencoding.
spring.thymeleaf.encoding=UTF-8
#Comma-separatedlistofviewnamesthatshouldbeexcludedfromresolution.
spring.thymeleaf.excluded-view-names=
#Templatemodetobeappliedtotemplates.SeealsoStandardTemplateModeHandlers.
spring.thymeleaf.mode=HTML5
#PrefixthatgetsprependedtoviewnameswhenbuildingaURL.
spring.thymeleaf.prefix=classpath:/templates/
#SuffixthatgetsappendedtoviewnameswhenbuildingaURL.
spring.thymeleaf.suffix=.htmlspring.thymeleaf.template-resolver-order=#Orderofthetemplateresolverinthechain.spring.thymeleaf.view-names=#Comma-separatedlistofviewnamesthatcanberesolved.

测试环境或者开发环境避免出现不可预期问题一般设置：spring.thymeleaf.cache=true

支持JSP的配置

SpringBoot并不建议使用，但如果一定要使用，可以参考此工程作为脚手架：JSP支持

总的来说Kotlin对于SpringBoot的支持非常好，只需要把Java语言的springboot使用，翻译成kotlin就可以。

总结

以上所述是小编给大家介绍的SpringBoot与kotlin使用Thymeleaf模板引擎渲染web视图的方法，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持！

Spring Boot 与 kotlin 使用Thymeleaf模板引擎渲染web视图的方法

热门推荐

随机推荐