Provide Kotlin extensions for RuntimeHints

To be able to register hints using for example registerType<MyClass>()
instead of registerType(MyClass::class.java).

Closes gh-29831
This commit is contained in:
Sébastien Deleuze
2023-02-01 11:59:34 +01:00
parent 5fd73f0bae
commit ebca9f726f
12 changed files with 453 additions and 0 deletions

View File

@@ -0,0 +1,28 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import kotlin.reflect.KClass
/**
* Extension for [JdkProxyHint.Builder.proxiedInterfaces] providing a [KClass] based variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
fun JdkProxyHint.Builder.proxiedInterfaces(vararg proxiedInterfaces: KClass<*>) =
proxiedInterfaces(*proxiedInterfaces.map { it::class.java }.toTypedArray())

View File

@@ -0,0 +1,28 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import kotlin.reflect.KClass
/**
* Extension for [ProxyHints.registerJdkProxy] providing a [KClass] based variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
fun ProxyHints.registerJdkProxy(vararg proxiedInterfaces: KClass<*>) =
registerJdkProxy(*proxiedInterfaces.map { it::class.java }.toTypedArray())

View File

@@ -0,0 +1,47 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
/**
* Extension for [ReflectionHints.getTypeHint] providing a `getTypeHint<Foo>(...)`
* variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
inline fun <reified T> ReflectionHints.getTypeHint() =
getTypeHint(T::class.java)
/**
* Extension for [ReflectionHints.registerType] providing a `registerType<Foo> { ... }`
* variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
inline fun <reified T> ReflectionHints.registerType(noinline typeHint: (TypeHint.Builder) -> Unit) =
registerType(T::class.java, typeHint::invoke)
/**
* Extension for [ReflectionHints.registerType] providing a `registerType<Foo>(...)`
* variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
inline fun <reified T> ReflectionHints.registerType(vararg memberCategories: MemberCategory) =
registerType(T::class.java, *memberCategories)

View File

@@ -0,0 +1,27 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
/**
* Extension for [ResourceHints.registerType] providing a `registerType<Foo>()`
* variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
inline fun <reified T> ResourceHints.registerType() =
registerType(T::class.java)

View File

@@ -0,0 +1,29 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import java.io.Serializable
/**
* Extension for [SerializationHints.registerType] providing a `registerType<Foo>()`
* variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
inline fun <reified T : Serializable> SerializationHints.registerType(noinline serializationHint: (JavaSerializationHint.Builder) -> Unit = {}) =
registerType(T::class.java, serializationHint::invoke)

View File

@@ -0,0 +1,27 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
/**
* Extension for [TypeHint.Builder.onReachableType] providing a `onReachableType<Foo>())`
* variant.
*
* @author Sebastien Deleuze
* @since 6.0.5
*/
inline fun <reified T> TypeHint.Builder.onReachableType() =
onReachableType(T::class.java)

View File

@@ -0,0 +1,40 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.junit.jupiter.api.Test
/**
* Tests for [JdkProxyHint] Kotlin extensions.
*
* @author Sebastien Deleuze
*/
class JdkProxyHintExtensionsTests {
private val builder = mockk<JdkProxyHint.Builder>()
@Test
fun `proxiedInterfaces builder extension`() {
every { builder.proxiedInterfaces(*anyVararg<Class<*>>()) } returns builder
builder.proxiedInterfaces(String::class, Int::class)
verify { builder.proxiedInterfaces(*anyVararg<Class<*>>()) }
}
}

View File

@@ -0,0 +1,40 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.junit.jupiter.api.Test
/**
* Tests for [ProxyHints] Kotlin extensions.
*
* @author Sebastien Deleuze
*/
class ProxyHintsExtensionsTests {
private val proxyHints = mockk<ProxyHints>()
@Test
fun `registerJdkProxy extension`() {
every { proxyHints.registerJdkProxy(*anyVararg<Class<*>>()) } returns proxyHints
proxyHints.registerJdkProxy(String::class, Int::class)
verify { proxyHints.registerJdkProxy(*anyVararg<Class<*>>()) }
}
}

View File

@@ -0,0 +1,58 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.junit.jupiter.api.Test
import java.util.function.Consumer
/**
* Tests for [ReflectionHints] Kotlin extensions.
*
* @author Sebastien Deleuze
*/
class ReflectionHintsExtensionsTests {
private val reflectionHints = mockk<ReflectionHints>()
@Test
fun `getTypeHint extension`() {
val typeHint = mockk<TypeHint>()
every { reflectionHints.getTypeHint(any<Class<*>>()) } returns typeHint
reflectionHints.getTypeHint<String>()
verify { reflectionHints.getTypeHint(String::class.java) }
}
@Test
fun `registerType extension with Consumer`() {
every { reflectionHints.registerType(any<Class<String>>(), any<Consumer<TypeHint.Builder>>()) } returns reflectionHints
reflectionHints.registerType<String> { }
verify { reflectionHints.registerType(String::class.java, any<Consumer<TypeHint.Builder>>()) }
}
@Test
fun `registerType extension with MemberCategory`() {
val memberCategory1 = mockk<MemberCategory>()
val memberCategory2 = mockk<MemberCategory>()
every { reflectionHints.registerType(any<Class<String>>(), any(), any()) } returns reflectionHints
reflectionHints.registerType<String>(memberCategory1, memberCategory2)
verify { reflectionHints.registerType(String::class.java, memberCategory1, memberCategory2) }
}
}

View File

@@ -0,0 +1,41 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.junit.jupiter.api.Test
import java.util.function.Consumer
/**
* Tests for [ResourceHints] Kotlin extensions.
*
* @author Sebastien Deleuze
*/
class ResourceHintsExtensionsTests {
private val resourceHints = mockk<ResourceHints>()
@Test
fun `registerType extension with MemberCategory`() {
every { resourceHints.registerType(any<Class<String>>()) } returns resourceHints
resourceHints.registerType<String>()
verify { resourceHints.registerType(String::class.java) }
}
}

View File

@@ -0,0 +1,48 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.junit.jupiter.api.Test
import java.util.function.Consumer
/**
* Tests for [SerializationHints] Kotlin extensions.
*
* @author Sebastien Deleuze
*/
class SerializationHintsExtensionsTests {
private val serializationHints = mockk<SerializationHints>()
@Test
fun `registerType extension with Consumer`() {
every { serializationHints.registerType(any<Class<String>>(), any<Consumer<JavaSerializationHint.Builder>>()) } returns serializationHints
serializationHints.registerType<String> { }
verify { serializationHints.registerType(String::class.java, any<Consumer<JavaSerializationHint.Builder>>()) }
}
@Test
fun `registerType extension`() {
every { serializationHints.registerType(any<Class<String>>(), any<Consumer<JavaSerializationHint.Builder>>()) } returns serializationHints
serializationHints.registerType<String>()
verify { serializationHints.registerType(String::class.java, any<Consumer<JavaSerializationHint.Builder>>()) }
}
}

View File

@@ -0,0 +1,40 @@
/*
* Copyright 2002-2023 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
*
* https://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.aot.hint
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import org.junit.jupiter.api.Test
/**
* Tests for [TypeHint] Kotlin extensions.
*
* @author Sebastien Deleuze
*/
class TypeHintExtensionsTests {
private val builder = mockk<TypeHint.Builder>()
@Test
fun `onReachableType builder extension`() {
every { builder.onReachableType(any<Class<*>>()) } returns builder
builder.onReachableType<String>()
verify { builder.onReachableType(String::class.java) }
}
}