Skip to content

Spring Boot Starter

This starter is compatible with Spring Boot 3.x!

Add required dependencies

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<dependency>
    <groupId>gg.jte</groupId>
    <artifactId>jte-spring-boot-starter-3</artifactId>
    <version>3.1.10</version>
</dependency>
<dependency>
    <groupId>gg.jte</groupId>
    <artifactId>jte</artifactId>
    <version>3.1.10</version>
</dependency>

1
2
implementation "gg.jte:jte-spring-boot-starter-3:3.1.10"
implementation "gg.jte:jte:3.1.10"

Usage

The starter configures a org.springframework.web.servlet.ViewResolver and a jte Template engine. Now you can return a string, pointing to template file name and the resolver will take care to instantiate the view and render the template.

Info

By default, the templates are expected at src/main/jte.

1
2
3
4
5
@import com.example.demo.DemoModel

@param DemoModel model

Hello ${model.text}!

1
2
3
4
5
@GetMapping("/") 
public String view(Model model, HttpServletResponse response) {
    model.addAttribute("model", new DemoModel("Hello World"));
    return "demo";
}

You can use it with Spring WebMVC as well as with Spring WebFlux.

Configuration

By default, the template files are expected in src/main/jte, You can also set the templateSuffix of your jte templates

1
2
gg.jte.templateLocation=src/main/jte
gg.jte.templateSuffix=.jte

Development

If you set developmentMode = true the jte file watcher will watch for changes in templates and recompile them.

Warning

This only works with a JDK!

1
gg.jte.developmentMode=true

Production

To use precompiled Templates in production, for use with a JRE environment, you need to configure the Maven/Gradle Plugin to precompile your templates:

1
gg.jte.usePrecompiledTemplates=true