spring-view-component

Spring ViewComponent vous permet de créer des composants UI côté serveur, typesafe, réutilisables et encapsulés.

##### Table des matières

• Qu’est-ce qu’un ViewComponent ?
• Rendre un ViewComponent
• Imbrication des ViewComponents :
• Configuration pour le développement local
• Configuration pour la production
• Installation
• Implémentation technique

Qu’est-ce qu’un ViewComponent ?

Les ViewComponents consolident la logique nécessaire à un template dans une seule classe, ce qui donne un objet cohérent et facile à comprendre. (Source : ViewComponent pour Rails)

Un Spring ViewComponent est un Bean Spring qui définit le contexte pour notre Template :

@ViewComponent
public class SimpleViewComponent {
  public record SimpleView(String helloWorld) implements ViewContext {
  }
  public SimpleView render() {
    return new SimpleView("Hello World");
  }
}

Nous définissons le contexte en créant un enregistrement qui implémente l'interface ViewContext

Ensuite, nous ajoutons l'annotation @ViewComponent à une classe et définissons une méthode qui retourne l'enregistrement SimpleView.

// SimpleViewComponent.kt
@ViewComponent
class SimpleViewComponent {
    fun render() = SimpleView("Hello World")
    data class SimpleView(val helloWorld: String) : ViewContext
}

Un ViewComponent nécessite toujours un modèle HTML correspondant. Nous définissons le modèle dans le SimpleViewComponent.[html/jte/kte] Dans le même package que notre classe ViewComponent.

Nous pouvons utiliser Thymeleaf

```html // SimpleViewComponent.html

ou JTE

ou KTE

Rendre un ViewComponent
Nous pouvons ensuite appeler la méthode render dans notre contrôleur pour rendre le template.

    
Java

@Controller public class SimpleController {

private final SimpleViewComponent simpleViewComponent;

public TestController(SimpleViewComponent simpleViewComponent) { this.simpleViewComponent = simpleViewComponent; }

@GetMapping("/") ViewContext simple() { return simpleViewComponent.render(); } }

    
Kotlin

@GetMapping("/") fun simpleComponent() = simpleViewComponent.render() }

Exemples
Si vous voulez commencer tout de suite, vous pouvez trouver des exemples pour toutes les combinaisons de langues possibles ici :
Exemples
Imbrication de ViewComponents :
Nous pouvons imbriquer des composants en passant un ViewContext comme propriété de notre enregistrement,
si nous l'avons également comme paramètre de notre méthode de rendu, nous pouvons facilement créer des mises en page :

    
Java

@ViewComponent public class LayoutViewComponent {

private record LayoutView(ViewContext nestedViewComponent) implements ViewContext {

}

public ViewContext render(ViewContext nestedViewComponent) { return new LayoutView(nestedViewComponent); } }

    
Kotlin

fun render(nestedViewComponent: ViewContext) = LayoutView(nestedViewComponent)

}

Thymeleaf
Dans Thymeleaf, nous rendons le ViewComponent passé avec l'attribut view:component="${viewContext}".

JTE / KTE
Dans JTE/KTE, nous pouvons simplement appeler directement l'enregistrement LayoutView dans une expression :

Configuration de développement local
Vous pouvez activer le rechargement à chaud des modèles en développement, vous devez avoir Spring Boot DevTools comme dépendance.

Installation
Thymeleaf :
LATEST_VERSION sur Maven Central

    
Gradle

}

    
Maven

JTE
DERNIÈRE_VERSION sur Maven Central


    
Gradle

implementation("de.tschuehly:spring-view-component-jte:0.9.1")

jte{ generate() sourceDirectory.set(kotlin.io.path.Path("src/main/java")) }

    
Maven

KTE
DERNIÈRE_VERSION sur Maven Central


    
Gradle

plugins { id("gg.jte.gradle") version ("3.1.12") }

dependencies { implementation("de.tschuehly:spring-view-component-kte:0.9.1") }

jte { generate() sourceDirectory.set(kotlin.io.path.Path("src/main/kotlin")) } ```

Implémentation Technique

Spring ViewComponent encapsule le conteneur Spring MVC en utilisant un Aspect AspectJ et résout automatiquement le template tout en plaçant le ViewContext dans le ModelAndViewContainer

--- Tranlated By Open Ai Tx | Last indexed: 2026-03-26 ---