Add runApplication() Kotlin top level function
Since Kotlin extensions do not apply to static
methods, this commit introduces a runApplication()
Kotlin top level function that acts as a Kotlin
shortcut for SpringApplication.run().
This shortcut avoids to require using non-idiomatic
code like SpringApplication.run(FooApplication::class.java)
and provides a runApplication<FooApplication>() alternative
(as well as an array of KClass based alternative when
multiple classes need to be passed as parameter).
It is possible to customize the application with the
following syntax:
runApplication<FooApplication>() {
setEnvironment(environment)
}
See gh-10511
pull/10774/merge
Sebastien Deleuze
7 years ago
committed by
Stephane Nicoll
parent
65f5bfeb67
commit
baffecdb14
@ -0,0 +1,53 @@
|
||||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot
|
||||
|
||||
import org.springframework.context.ConfigurableApplicationContext
|
||||
import kotlin.reflect.KClass
|
||||
|
||||
|
||||
/**
|
||||
* Top level function acting as a Kotlin shortcut allowing to write `runApplication<FooApplication>(arg1, arg2)`
|
||||
* instead of `SpringApplication.run(FooApplication::class.java, arg1, arg2)`.
|
||||
*
|
||||
* @author Sebastien Deleuze
|
||||
* @since 2.0.0
|
||||
*/
|
||||
inline fun <reified T : Any> runApplication(vararg args: String): ConfigurableApplicationContext =
|
||||
SpringApplication.run(T::class.java, *args)
|
||||
|
||||
/**
|
||||
* Top level function acting as a Kotlin shortcut allowing to write `runApplication<FooApplication>(arg1, arg2) { // SpringApplication customization ... }`
|
||||
* instead of instantiating `SpringApplication` class, customize it and then invoking `run(arg1, arg2)`.
|
||||
*
|
||||
* @author Sebastien Deleuze
|
||||
* @since 2.0.0
|
||||
*/
|
||||
inline fun <reified T : Any> runApplication(vararg args: String, init: SpringApplication.() -> Unit): ConfigurableApplicationContext =
|
||||
SpringApplication(T::class.java).apply(init).run(*args)
|
||||
|
||||
|
||||
/**
|
||||
* Top level function acting as a Kotlin shortcut allowing to write
|
||||
* `runApplication(arrayOf(FooApplication::class, FooConfiguration::class), arg1, arg2) { // Optional SpringApplication customization ... }`
|
||||
* instead of instantiating `SpringApplication` class, customize it and then invoking `run(arrayOf(arg1, arg2))`.`
|
||||
*
|
||||
* @author Sebastien Deleuze
|
||||
* @since 2.0.0
|
||||
*/
|
||||
fun runApplication(primarySources: Array<KClass<*>>, vararg args: String, init: SpringApplication.() -> Unit = {}): ConfigurableApplicationContext =
|
||||
SpringApplication(*primarySources.map { it.java }.toTypedArray()).apply(init).run(*args)
|
||||
@ -0,0 +1,118 @@
|
||||
/*
|
||||
* Copyright 2002-2017 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springframework.boot
|
||||
|
||||
import org.junit.Assert.*
|
||||
import org.junit.Test
|
||||
import org.springframework.beans.factory.getBean
|
||||
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
|
||||
import org.springframework.context.annotation.Bean
|
||||
import org.springframework.context.annotation.Configuration
|
||||
import org.springframework.core.env.StandardEnvironment
|
||||
|
||||
/**
|
||||
* Tests for `SpringApplicationExtensions`.
|
||||
*
|
||||
* @author Sebastien Deleuze
|
||||
*/
|
||||
class SpringApplicationExtensionsTests {
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication() top level function`() {
|
||||
val context = runApplication<ExampleWebConfig>()
|
||||
assertNotNull(context)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication() top level function with a custom environment`() {
|
||||
val environment = StandardEnvironment()
|
||||
val context = runApplication<ExampleWebConfig> {
|
||||
setEnvironment(environment)
|
||||
}
|
||||
assertNotNull(context)
|
||||
assertEquals(environment, context.environment)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication(arg1, arg2) top level function`() {
|
||||
val context = runApplication<ExampleWebConfig>("--debug", "spring", "boot")
|
||||
val args = context.getBean<ApplicationArguments>()
|
||||
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
|
||||
assertTrue(args.containsOption("debug"))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication(arg1, arg2) top level function with a custom environment`() {
|
||||
val environment = StandardEnvironment()
|
||||
val context = runApplication<ExampleWebConfig>("--debug", "spring", "boot") {
|
||||
setEnvironment(environment)
|
||||
}
|
||||
val args = context.getBean<ApplicationArguments>()
|
||||
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
|
||||
assertTrue(args.containsOption("debug"))
|
||||
assertEquals(environment, context.environment)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication(array of KClass) top level function`() {
|
||||
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class))
|
||||
assertNotNull(context)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication(array of KClass) top level function with a custom environment`() {
|
||||
val environment = StandardEnvironment()
|
||||
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class)) {
|
||||
setEnvironment(environment)
|
||||
}
|
||||
assertNotNull(context)
|
||||
assertEquals(environment, context.environment)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication(array of KClass, arg1, arg2) top level function`() {
|
||||
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class), "--debug", "spring", "boot")
|
||||
val args = context.getBean<ApplicationArguments>()
|
||||
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
|
||||
assertTrue(args.containsOption("debug"))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `Kotlin runApplication(array of KClass, arg1, arg2) top level function with a custom environment`() {
|
||||
val environment = StandardEnvironment()
|
||||
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class), "--debug", "spring", "boot") {
|
||||
setEnvironment(environment)
|
||||
}
|
||||
val args = context.getBean<ApplicationArguments>()
|
||||
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
|
||||
assertTrue(args.containsOption("debug"))
|
||||
assertEquals(environment, context.environment)
|
||||
}
|
||||
|
||||
|
||||
@Configuration
|
||||
internal open class ExampleConfig
|
||||
|
||||
@Configuration
|
||||
internal open class ExampleWebConfig {
|
||||
|
||||
@Bean
|
||||
open fun webServer(): TomcatServletWebServerFactory {
|
||||
return TomcatServletWebServerFactory(0)
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue