GitHub-Spring
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Leverage new Kotlin script templating support 

As of 1.3.40, Kotlin now provides a kotlin-scripting-jsr223-embeddable
dependency which:
 - Fixes classloading related issues
 - Provides out of the box JSR 223 support
 - Is compatible with Spring Boot Fat Jar mechanism

This commit updates Spring Framework tests and documentation accordingly.

Closes gh-23165
pull/23169/head
Sebastien Deleuze 7 years ago
parent
cfb4148982
commit
e86b937f8c
7 changed files with 36 additions and 38 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      spring-webflux/spring-webflux.gradle
  2. 4
      spring-webflux/src/test/java/org/springframework/web/reactive/result/view/script/KotlinScriptTemplateTests.java
  3. 1
      spring-webflux/src/test/resources/META-INF/services/javax.script.ScriptEngineFactory
  4. 3
      spring-webmvc/spring-webmvc.gradle
  5. 4
      spring-webmvc/src/test/java/org/springframework/web/servlet/view/script/KotlinScriptTemplateTests.java
  6. 1
      spring-webmvc/src/test/resources/META-INF/services/javax.script.ScriptEngineFactory
  7. 56
      src/docs/asciidoc/languages/kotlin.adoc

5
spring-webflux/spring-webflux.gradle
Unescape View File

@ -55,10 +55,9 @@ dependencies { @@ -55,10 +55,9 @@ dependencies {
testCompile("org.eclipse.jetty:jetty-servlet")
testCompile("org.eclipse.jetty:jetty-reactive-httpclient:1.0.3")
testCompile("com.squareup.okhttp3:mockwebserver:3.14.2")
testCompile("org.jetbrains.kotlin:kotlin-script-runtime:${kotlinVersion}")
testCompile(project(":spring-core-coroutines"))
testRuntime("org.jetbrains.kotlin:kotlin-script-util:${kotlinVersion}")
testRuntime("org.jetbrains.kotlin:kotlin-compiler-embeddable:${kotlinVersion}")
testCompile("org.jetbrains.kotlin:kotlin-script-runtime:${kotlinVersion}")
testRuntime("org.jetbrains.kotlin:kotlin-scripting-jsr223-embeddable:${kotlinVersion}")
testRuntime("org.jruby:jruby:9.2.7.0")
testRuntime("org.python:jython-standalone:2.7.1")
testRuntime("org.synchronoss.cloud:nio-multipart-parser:1.1.0")

4
spring-webflux/src/test/java/org/springframework/web/reactive/result/view/script/KotlinScriptTemplateTests.java
Unescape View File

@ -20,7 +20,6 @@ import java.util.HashMap; @@ -20,7 +20,6 @@ import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import org.junit.Ignore;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@ -41,7 +40,6 @@ import static org.assertj.core.api.Assertions.assertThat; @@ -41,7 +40,6 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
public class KotlinScriptTemplateTests {
@Ignore
@Test
public void renderTemplateWithFrenchLocale() throws Exception {
Map<String, Object> model = new HashMap<>();
@ -51,7 +49,6 @@ public class KotlinScriptTemplateTests { @@ -51,7 +49,6 @@ public class KotlinScriptTemplateTests {
assertThat(response.getBodyAsString().block()).isEqualTo("<html><body>\n<p>Bonjour Foo</p>\n</body></html>");
}
@Ignore
@Test
public void renderTemplateWithEnglishLocale() throws Exception {
Map<String, Object> model = new HashMap<>();
@ -61,7 +58,6 @@ public class KotlinScriptTemplateTests { @@ -61,7 +58,6 @@ public class KotlinScriptTemplateTests {
assertThat(response.getBodyAsString().block()).isEqualTo("<html><body>\n<p>Hello Foo</p>\n</body></html>");
}
@Ignore
@Test
public void renderTemplateWithoutRenderFunction() throws Exception {
Map<String, Object> model = new HashMap<>();

1
spring-webflux/src/test/resources/META-INF/services/javax.script.ScriptEngineFactory
Unescape View File

@ -1 +0,0 @@ @@ -1 +0,0 @@
org.jetbrains.kotlin.script.jsr223.KotlinJsr223JvmLocalScriptEngineFactory

3
spring-webmvc/spring-webmvc.gradle
Unescape View File

@ -73,8 +73,7 @@ dependencies { @@ -73,8 +73,7 @@ dependencies {
testCompile("io.reactivex:rxjava-reactive-streams:${rxjavaAdapterVersion}")
testCompile("io.reactivex.rxjava2:rxjava:${rxjava2Version}")
testCompile("org.jetbrains.kotlin:kotlin-script-runtime:${kotlinVersion}")
testRuntime("org.jetbrains.kotlin:kotlin-script-util:${kotlinVersion}")
testRuntime("org.jetbrains.kotlin:kotlin-compiler-embeddable:${kotlinVersion}")
testRuntime("org.jetbrains.kotlin:kotlin-scripting-jsr223-embeddable:${kotlinVersion}")
testRuntime("org.jruby:jruby:9.2.7.0")
testRuntime("org.python:jython-standalone:2.7.1")
testRuntime("org.webjars:underscorejs:1.8.3")

4
spring-webmvc/src/test/java/org/springframework/web/servlet/view/script/KotlinScriptTemplateTests.java
Unescape View File

@ -22,7 +22,6 @@ import java.util.Map; @@ -22,7 +22,6 @@ import java.util.Map;
import javax.servlet.ServletContext;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@ -56,7 +55,6 @@ public class KotlinScriptTemplateTests { @@ -56,7 +55,6 @@ public class KotlinScriptTemplateTests {
this.servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.webAppContext);
}
@Ignore
@Test
public void renderTemplateWithFrenchLocale() throws Exception {
Map<String, Object> model = new HashMap<>();
@ -66,7 +64,6 @@ public class KotlinScriptTemplateTests { @@ -66,7 +64,6 @@ public class KotlinScriptTemplateTests {
assertThat(response.getContentAsString()).isEqualTo("<html><body>\n<p>Bonjour Foo</p>\n</body></html>");
}
@Ignore
@Test
public void renderTemplateWithEnglishLocale() throws Exception {
Map<String, Object> model = new HashMap<>();
@ -76,7 +73,6 @@ public class KotlinScriptTemplateTests { @@ -76,7 +73,6 @@ public class KotlinScriptTemplateTests {
assertThat(response.getContentAsString()).isEqualTo("<html><body>\n<p>Hello Foo</p>\n</body></html>");
}
@Ignore
@Test
public void renderTemplateWithoutRenderFunction() throws Exception {
Map<String, Object> model = new HashMap<>();

1
spring-webmvc/src/test/resources/META-INF/services/javax.script.ScriptEngineFactory
Unescape View File

@ -1 +0,0 @@ @@ -1 +0,0 @@
org.jetbrains.kotlin.script.jsr223.KotlinJsr223JvmLocalScriptEngineFactory

56
src/docs/asciidoc/languages/kotlin.adoc
Unescape View File

@ -337,39 +337,49 @@ mockMvc.get("/person/{name}", "Lee") { @@ -337,39 +337,49 @@ mockMvc.get("/person/{name}", "Lee") {
=== Kotlin Script Templates
As of version 4.3, Spring Framework provides a
Spring Framework provides a
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/view/script/ScriptTemplateView.html[`ScriptTemplateView`]
to render templates by using script engines. It supports
https://www.jcp.org/en/jsr/detail?id=223[JSR-223].
Spring Framework 5 goes even further by extending this feature to WebFlux and supporting
https://jira.spring.io/browse/SPR-15064[i18n and nested templates].
which supports https://www.jcp.org/en/jsr/detail?id=223[JSR-223] to render templates by using script engines.
Kotlin provides similar support and allows the rendering of Kotlin-based templates. See
https://github.com/spring-projects/spring-framework/commit/badde3a479a53e1dd0777dd1bd5b55cb1021cf9e[this commit] for details.
By leveraging `kotlin-script-runtime` and `scripting-jsr223-embeddable` dependencies, it
is possible to use such feature to render Kotlin-based templates with
https://github.com/Kotlin/kotlinx.html[kotlinx.html] DSL or Kotlin multiline interpolated `String`.
This enables some interesting use cases - such as writing type-safe templates by using
https://github.com/Kotlin/kotlinx.html[kotlinx.html] DSL or by a using Kotlin multiline `String` with interpolation.
`build.gradle.kts`
[source,kotlin,indent=0]
----
dependencies {
compile("org.jetbrains.kotlin:kotlin-script-runtime:${kotlinVersion}")
runtime("org.jetbrains.kotlin:kotlin-scripting-jsr223-embeddable:${kotlinVersion}")
}
----
This can let you write Kotlin templates with full autocompletion and
refactoring support in a supported IDE, as the following example shows:
Configuration is usually done with `ScriptTemplateConfigurer` and `ScriptTemplateViewResolver`
beans.
`KotlinScriptConfiguration.kt`
[source,kotlin,indent=0]
----
import io.spring.demo.*
@Configuration
class KotlinScriptConfiguration {
@Bean
fun kotlinScriptConfigurer() = ScriptTemplateConfigurer().apply {
engineName = "kotlin"
setScripts("scripts/render.kts")
renderFunction = "render"
isSharedEngine = false
}
"""
${include("header")}
<h1>${i18n("title")}</h1>
<ul>
${users.joinToLine{ "<li>${i18n("user")} ${it.firstname} ${it.lastname}</li>" }}
</ul>
${include("footer")}
"""
@Bean
fun kotlinScriptViewResolver() = ScriptTemplateViewResolver().apply {
setPrefix("templates/")
setSuffix(".kts")
}
}
----
WARNING: Kotlin Script Templates support is experimental and not compatible yet with Spring Boot fatjar mechanism, see related
https://youtrack.jetbrains.com/issue/KT-21443[KT-21443] and https://youtrack.jetbrains.com/issue/KT-27956[KT-27956]
issues.
See the https://github.com/sdeleuze/kotlin-script-templating[kotlin-script-templating] example
project for more details.

Write Preview
Loading…
Cancel
Save